External DocumentationTo learn more, visit the Zendesk documentation.
Parameters
| Parameter | Description |
|---|---|
| Role | The role to assign to the user. NOTE: Assigning the role of an agent is only allowed for admins. |
| Send Confirmation Email | Only check this if you wish to email the user upon creation. |
| User Email | User’s email. |
| User Name | The name of the user to create. |
Example Output
{
"user": {
"id": "xxxxxxxxxx",
"url": "https://xxxxxxxxxx.zendesk.com/api/v2/users/xxxxxxxxxx.json",
"name": "xxxxxxxxxx",
"email": "xxxxxxxxxx@gmail.com",
"created_at": "2025-01-12T12:29:33Z",
"updated_at": "2025-01-12T12:29:33Z",
"time_zone": "Asia/Jerusalem",
"iana_time_zone": "Asia/Jerusalem",
"phone": null,
"shared_phone_number": null,
"photo": null,
"locale_id": 1,
"locale": "en-US",
"organization_id": null,
"role": "agent",
"verified": false,
"last_active": "2025-01-12",
"external_id": null,
"tags": [],
"alias": null,
"active": true,
"shared": false,
"shared_agent": false,
"last_login_at": null,
"two_factor_auth_enabled": null,
"signature": null,
"details": null,
"notes": null,
"role_type": null,
"custom_role_id": null,
"moderator": false,
"ticket_restriction": null,
"only_private_comments": false,
"restricted_agent": false,
"suspended": false,
"default_group_id": "xxxxxxxxxx",
"report_csv": false,
"user_fields": {}
}
}