post
https://hub.xyte.io/core/v1/organization/users
Invite a new user to your organization.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Authorization
This endpoint requires Authorization.
Request Body
| Key | Type | Description | Required |
|---|---|---|---|
| string | Email address for the new user. Must be unique across all organizations under this partner. | Yes | |
| name | string | Display name for the new user. | Yes |
| group_ids | array | List of group UUIDs to assign the user to. At least one group is required. | Yes |
{
"email": "[email protected]",
"name": "Jane Doe",
"group_ids": ["269ec8e1-f599-4918-a36b-424aaeef6b83"]
}Response
Returns the created user:
| Key | Type | Description |
|---|---|---|
| id | string | Unique identifier of the new user (UUID). |
| name | string | Display name of the user. |
| string | Email address of the user. | |
| group_names | array | Names of the groups the user was assigned to. |
| deactivated_at | datetime | Always null for a newly created user. |
| created_at | datetime | Timestamp when the user was created. |
| welcome_email_status | string | Outcome of the invitation email: sent, sso or failed (see below). |
| message | string | Human-readable notice about the invitation email. Present only when welcome_email_status is sso or failed. |
welcome_email_status values:
| Value | Meaning |
|---|---|
sent | The user was sent a welcome email with instructions to sign in. |
sso | Your organization enforces single sign-on, so the user was sent an email to sign in with their company account instead. |
failed | The user was created, but the invitation email could not be sent. Retry with Resend Welcome Email. |
{
"id": "9e34b87d-79ca-4dc3-ac42-8ce9ebe8be82",
"name": "Jane Doe",
"email": "[email protected]",
"group_names": ["administrators"],
"deactivated_at": null,
"created_at": "2024-01-15T10:00:00Z",
"welcome_email_status": "failed",
"message": "The user was created, but we couldn't send the invitation email. Please try Resend Signup Email later."
}
NoteA failed invitation email does not fail the request: the user is created either way. Check
welcome_email_statusrather than the HTTP status to know whether the invitation reached the user.
Errors
| Status | Message | Description |
|---|---|---|
| 422 | Email can't be blank | The email field is missing. |
| 422 | Email is not an email | The email value is not a valid email address. |
| 422 | You have to assign the user at least to one group | The group_ids field is missing or empty. |
| 422 | The user {email} is already associated with another account | The email is already registered in another organization under this partner. |
| 422 | Members of an SSO-synced group are managed by your identity provider: {group names} | One or more group_ids are synced from your SSO provider; the whole request is rejected. The message lists the synced groups. |