by Zendesk
Create or update an organization
Creates an organization, or updates the one that matches its ID or external ID, and returns it.
Description
Pass `id` or `external_id` to update an existing organization: the name is never used for matching, and without either one an existing name returns a duplicate error. Agents can call it, with restrictions on some actions.
create-or-update-organization.md
Create or update an organization
Creates an organization, or updates the one that matches its ID or external ID, and returns it.
Pass id or external_id to update an existing organization: the name is
never used for matching, and without either one an existing name returns a
duplicate error. Agents can call it, with restrictions on some actions.
Set up
Use the first option your agent supports.
API (official)
- Base URL: https://{subdomain}.zendesk.com
- Endpoint:
POST /api/v2/organizations/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/organizations/create_or_update | API key in $ZENDESK_OAUTH_TOKEN | Docs |