Invite user
POST
/api/v1/integrations/users/inviteUsersCreates and sends an integration user invitation.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
first_name | string | Yes | User first name. |
last_name | string | Yes | User last name. |
email | string | Yes | User email address. |
phone | string | No | Optional phone number. |
role | string | Yes | Role to assign. |
custom_message | string | No | Optional invite message. |
Responses
| HTTP | Description |
|---|---|
| 200 | Invitation result in `data` (`username`, `invitation_id`, `status`, optional `error`). |
| 401 | Unauthorized - invalid or missing Bearer token. |
| 404 | Account not found. |
Response payload
Success response (200)
Example
Last updated on