Users & Roles
API ReferenceUsersInvite
Invite Users
Sends invitation emails to one or more users. Each invitee receives a one-time link they use to set a password and complete signup.
POST /user/user/invite_multiple
The body is an array — you can invite multiple users at once.
Body Parameters (per array item)
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | Yes | The recipient's email address. |
name | string | Yes | The recipient's display name. |
role_id | string | Yes | The role to grant. See List invitable roles for the values your key can assign. |
Request Example
curl -X POST 'https://api.v2.paychtec.com/user/user/invite_multiple' \ -H "Content-Type: application/json" \ -H "api-key: snd_YOUR_API_KEY" \ -d '[ { "email": "alice@acme.com", "name": "Alice Doe", "role_id": "merchant_admin" }, { "email": "bob@acme.com", "name": "Bob Roe", "role_id": "merchant_viewer" }]'Response
{
"results": [
{ "email": "alice@acme.com", "status": "invited", "user_id": "user_abc123" },
{ "email": "bob@acme.com", "status": "invited", "user_id": "user_xyz789" }
]
}Errors
| Status | When |
|---|---|
400 | One or more role_id values are not invitable by the calling API key. |
409 | A user with that email already exists in this scope. Use Update user role instead. |