Invite user to group

Invite user to group.

Path Parameters

groupId string required

The id of the group.

application/json

Request Body

userId integer

The ID of the user being invited to group.

email string

The email of the user being invited to group.

Responses

Request has been handled successfully.

application/json

Schema

Example (from schema)

Schema

success boolean

data object

{
  "success": true,
  "data": {}
}

Forbidden error. Can either be due to access token not being passed, having been expired or the caller trying to access a resource without enough permissions.

application/json

Schema

Example (from schema)

Schema

success boolean

error object

{
  "success": false,
  "error": {
    "code": "ForbiddenError",
    "message": "Token expired"
  }
}

Not Found. The resource being accessed does not exist.

application/json

Schema

Example (from schema)

Schema

success boolean

error object

{
  "success": false,
  "error": {
    "code": "NotFoundError",
    "message": "The resource you're looking for does not exist"
  }
}

Validation Error. The request includes one or more invalid params. Please check the request params and try again.

application/json

Schema

Example (from schema)

Schema

success boolean

error object

{
  "success": false,
  "error": {
    "code": "ValidationError",
    "message": "`id` is required"
  }
}

Server Error. Something went wrong, try again later.

application/json

Schema

Example (from schema)

Schema

success boolean

error object

{
  "success": false,
  "error": {
    "code": "ServerError",
    "message": "Something went wrong"
  }
}

PUT /v1/groups/:groupId/inviteUser

Authorization

name: o_t_htype: apiKeyin: header

Request

Base URL

https://auth.quran.com

ApiKeyAuth

groupId — path required

Body

{
  "userId": 153,
  "email": "amer@quran.com"
}

curl / cURL
curl -L -X PUT 'https://auth.quran.com/v1/groups/:groupId/inviteUser' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "userId": 153,
  "email": "amer@quran.com"
}'

python / requests
curl -L -X PUT 'https://auth.quran.com/v1/groups/:groupId/inviteUser' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "userId": 153,
  "email": "amer@quran.com"
}'

go / native
curl -L -X PUT 'https://auth.quran.com/v1/groups/:groupId/inviteUser' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "userId": 153,
  "email": "amer@quran.com"
}'

nodejs / axios
curl -L -X PUT 'https://auth.quran.com/v1/groups/:groupId/inviteUser' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "userId": 153,
  "email": "amer@quran.com"
}'

ruby / Net::HTTP
curl -L -X PUT 'https://auth.quran.com/v1/groups/:groupId/inviteUser' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "userId": 153,
  "email": "amer@quran.com"
}'

csharp / RestSharp
curl -L -X PUT 'https://auth.quran.com/v1/groups/:groupId/inviteUser' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "userId": 153,
  "email": "amer@quran.com"
}'

php / cURL
curl -L -X PUT 'https://auth.quran.com/v1/groups/:groupId/inviteUser' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "userId": 153,
  "email": "amer@quran.com"
}'

java / OkHttp
curl -L -X PUT 'https://auth.quran.com/v1/groups/:groupId/inviteUser' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "userId": 153,
  "email": "amer@quran.com"
}'

powershell / RestMethod
curl -L -X PUT 'https://auth.quran.com/v1/groups/:groupId/inviteUser' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "userId": 153,
  "email": "amer@quran.com"
}'