by Zendesk
Create or update a user
Creates a user, an end user unless you set a role, or updates the one that matches the email or external ID, and returns the full user.
Description
The response is 201 when the user is created and 200 when an existing user is updated. Add `"skip_verify_email": true` to create a user without sending a verification email. Needs an admin, or an agent whose custom role can manage end users or team members.
create-or-update-user.md
Create or update a user
Creates a user, an end user unless you set a role, or updates the one that matches the email or external ID, and returns the full user.
The response is 201 when the user is created and 200 when an existing user is
updated. Add "skip_verify_email": true to create a user without sending a
verification email. Needs an admin, or an agent whose custom role can manage
end users or team members.
Set up
Use the first option your agent supports.
API (official)
- Base URL: https://{subdomain}.zendesk.com
- Endpoint:
POST /api/v2/users/create_or_update - Auth: send the header
Authorization: Bearer $ZENDESK_OAUTH_TOKEN - Get a key: https://developer.zendesk.com/documentation/authentication/oauth-migration/#getting-your-first-token
- Docs: https://developer.zendesk.com/api-reference/ticketing/introduction/
Before doing anything else, make one read-only call to confirm access.
Rules
- Ask the user before anything that sends messages, costs money, or changes data.
- Never print API keys.
Built from these files in the repository
The layout and the rules come from lib/catalog/render-markdown.ts, the set-up wording from lib/catalog/render-access.ts.
Ways in
| Route | Source | Call | Required | Docs |
|---|---|---|---|---|
| Official | POST /api/v2/users/create_or_update | API key in $ZENDESK_OAUTH_TOKEN | Docs |