Invite User
Send one or more platform user invitations.
POST
/api/v1/users/inviteDescription
Invites users to your Unduit company account. Send a single invite via email/role/country, an invites array, or parallel email_ids with corporate_role and country arrays.
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <access_token> | Yes |
| Content-Type | application/json | Yes |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| invites | array | No | Array of invite objects (preferred for multiple). |
| string | No | Single invite email (alternative to invites[]). | |
| role | number | No | Corporate role for single invite: 1, 2, or 3. |
| country | string | No | Country code for single invite. |
| message | string | No | Custom invitation email message. |
| app_type | number | No | Application type (default 2). |
| cc_email | string | No | CC on invitation email. |
| bcc_email | string | No | BCC on invitation email. |
Each object in invites[]
Required when using the invites array format.
Fields
| Parameter | Type | Required | Description |
|---|---|---|---|
| string | Yes | Invitee email. | |
| role | number | Yes | 1=Department head, 2=Manager, 3=Requester. |
| country | string | Yes | Country code. |
| manager_id | number | No | Manager user ID (default 0). |
Example Request Body
{
"invites": [
{
"email": "new.user@example.com",
"role": 3,
"country": "US",
"manager_id": 0
}
],
"message": "Welcome to our Unduit workspace",
"app_type": 2
}Response
Related Endpoints
Did this page help you?
Request
curl -X POST https://uat.unduit.com/api-exposed/api/v1/users/invite \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"invites": [
{
"email": "new.user@example.com",
"role": 3,
"country": "US",
"manager_id": 0
}
],
"message": "Welcome to our Unduit workspace",
"app_type": 2
}'Success Response
{
"success": true,
"message": "Invitation successfully sent",
"added_emails": ["new.user@example.com"],
"updated_emails": [],
"skipped_registered_emails": [],
"invites": [
{
"invite_id": 15,
"email": "new.user@example.com",
"role": 3,
"country": "US"
}
]
}Error Responses
422 Validation Error
{
"success": false,
"message": "Validation failed",
"errors": {
"invites[0].email": "A valid email address is required."
}
}