Skip to main content
POST
/
users
/
invitation
Invite users by their emails
curl --request POST \
  --url https://incoming.qomon.app/users/invitation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "invitations": [
      {
        "email": "<string>",
        "role_id": 1
      }
    ]
  }
}
'
{
  "data": {
    "msg": "<string>",
    "invitations": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "group_id": 1,
        "id": 1,
        "last_sent": "2023-11-07T05:31:56Z",
        "mobile_phone": "<string>",
        "role": {
          "id": 1,
          "name": "<string>",
          "order": 1
        },
        "role_id": 1,
        "user_id": 1
      }
    ]
  },
  "status": "<string>"
}
Invitations are sent asynchronously, so the response will only indicate that the invitation request has been received, not that the emails have been sent. To check the status of invitations, use GET /users/invitation to retrieve the list of invitations and their details.

Authorizations

Authorization
string
header
required

OAuth2 access token. Pass the token in the Authorization header as Bearer <token>. The token is looked up in Redis to resolve the caller identity.

Body

application/json
data
object
required

Response

Created

data
object
required
status
string
required

Operation result.

Example:

"success"

Last modified on June 16, 2026