Invite users by their emails.

Send an invitation to the specified mail addresses. Each space has different roles and their corresponding role_id. If the mail address is already registered, the user will be added to the space. If the mail address is not registered, the user will be invited to join the space.

💡 Not specifying a role_id will set the role “user” by default.

POST /users/invitation

Invite users by their emails.

cURL

curl --request POST \
  --url https://incoming.qomon.app/users/invitation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "invitations": [
      {
        "email": "[e-mail]",
        "role_id": 8
      }
    ]
  }
}
'

201

{
  "status": "success",
  "data": {
    "msg": "invitations created successfully",
    "invitations": {
      "id": 101,
      "group_id": 101,
      "email": "[e-mail]",
      "mobile_phone": "0123456789",
      "role_id": 5,
      "role": {
        "id": 5,
        "name": "<string>",
        "order": 123
      },
      "created_at": "1955-07-06T00:00:00Z",
      "last_sent": "1955-07-06T00:00:00Z",
      "user_id": 2345
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

data · object · required

Show child attributes

Response

201

application/json

Created

status · string

Example:

"success"

data · object

Show child attributes