{"slug":"zendesk-api","name":"Zendesk API","host":"*.zendesk.com","site":"https://zendesk.com","category":"marketing","docsUrl":null,"sources":[{"kind":"changelog","url":"https://developer.zendesk.com/api-reference/changelog/changelog/"},{"kind":"openapi","url":"https://developer.zendesk.com/zendesk/oas.yaml"}],"url":"https://www.okapi.bot/providers/zendesk-api/","json":"https://www.okapi.bot/api/v1/providers/zendesk-api.json","breakingChanges":[{"slug":"api-token-authentication-stops-working-on-calls-authenticated-with-an-api-token","api":"zendesk-api","title":"API token authentication stops working on calls authenticated with an API token","kind":"behaviour_change","outcome":"fails","model":null,"announcedAt":"2026-06-01","effectiveAt":"2027-04-30","scope":"calls authenticated with an API token","calls":["/api/v2/*"],"method":null,"path":"/api/v2/*","source":{"url":"https://developer.zendesk.com/api-reference/changelog/changelog/","kind":"archive"},"quote":"On April 30, 2027, all remaining API tokens will be permanently deactivated.","migration":"Authenticate with OAuth access tokens instead of email/token basic authentication.","migrationChange":null,"needsDecision":"Moving to OAuth needs an OAuth client registered in the Zendesk account and a token flow in the integration.","text":{"summary":"On April 30, 2027, API token authentication will stop working for calls authenticated with an API token. This change affects requests to /api/v2/* endpoints. After this date, all remaining API tokens will be permanently deactivated and affected calls will fail.","migration":"Authenticate with OAuth access tokens instead of email/token basic authentication. Moving to OAuth takes more than changing credentials, as it requires an OAuth client registered in the Zendesk account and a token flow implemented in the integration.","by":"writer"},"publishedAt":"2026-10-23T10:32:58.297Z","updatedAt":"2026-10-23T15:23:36.218Z","status":"upcoming","tone":"risk","url":"https://www.okapi.bot/providers/zendesk-api/breaking-changes/api-token-authentication-stops-working-on-calls-authenticated-with-an-api-token/"},{"slug":"the-legacy-custom-objects-api-stops-working","api":"zendesk-api","title":"The Legacy Custom Objects API stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2025-07-07","effectiveAt":"2026-07-01","scope":null,"calls":["/api/sunshine/objects/*"],"method":null,"path":"/api/sunshine/objects/*","source":{"url":"https://developer.zendesk.com/api-reference/changelog/changelog/","kind":"archive"},"quote":"Starting January 15, 2026, you will no longer be able to create new legacy custom objects or relationships. Zendesk will fully remove legacy custom objects in July 2026.","migration":"Migrate to the custom objects API (/api/v2/custom_objects/*).","migrationChange":null,"needsDecision":"Moving to the new custom objects means migrating the account's object types and records.","text":null,"publishedAt":"2026-10-23T10:32:58.297Z","updatedAt":"2026-10-23T10:32:58.297Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/zendesk-api/breaking-changes/the-legacy-custom-objects-api-stops-working/"},{"slug":"the-legacy-custom-objects-relationships-api-stops-working","api":"zendesk-api","title":"The Legacy Custom Objects relationships API stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2025-07-07","effectiveAt":"2026-07-01","scope":null,"calls":["/api/sunshine/relationships/*"],"method":null,"path":"/api/sunshine/relationships/*","source":{"url":"https://developer.zendesk.com/api-reference/changelog/changelog/","kind":"archive"},"quote":"Starting January 15, 2026, you will no longer be able to create new legacy custom objects or relationships. Zendesk will fully remove legacy custom objects in July 2026.","migration":"Migrate to custom objects with lookup relationship fields (/api/v2/custom_objects/*).","migrationChange":null,"needsDecision":"Moving to the new custom objects means migrating the account's relationship types and records.","text":null,"publishedAt":"2026-10-23T10:32:58.297Z","updatedAt":"2026-10-23T10:32:58.297Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/zendesk-api/breaking-changes/the-legacy-custom-objects-relationships-api-stops-working/"},{"slug":"basic-authentication-with-an-email-and-password-stops-working-on-calls","api":"zendesk-api","title":"Basic authentication with an email and password stops working on calls authenticated with an email and password","kind":"behaviour_change","outcome":"fails","model":null,"announcedAt":"2024-07-01","effectiveAt":"2026-01-12","scope":"calls authenticated with an email and password","calls":["/api/v2/*"],"method":null,"path":"/api/v2/*","source":{"url":"https://developer.zendesk.com/api-reference/changelog/changelog/","kind":"archive"},"quote":"Starting July 31, 2024, basic authentication using an email and password is deprecated for /api/v2/ endpoints for new accounts and for accounts that are not using this method. If you’re actively using this method today, you will be able to continue using it until January 12, 2026.","migration":"Authenticate with an OAuth access token.","migrationChange":null,"needsDecision":"Moving to OAuth needs an OAuth client registered in the Zendesk account.","text":null,"publishedAt":"2026-10-23T10:32:58.297Z","updatedAt":"2026-10-23T10:32:58.297Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/zendesk-api/breaking-changes/basic-authentication-with-an-email-and-password-stops-working-on-calls/"},{"slug":"put-api-v2-users-me-merge-stops-working","api":"zendesk-api","title":"PUT /api/v2/users/me/merge stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":null,"effectiveAt":"2023-05-19","scope":null,"calls":["PUT /api/v2/users/me/merge"],"method":"PUT","path":"/api/v2/users/me/merge","source":{"url":"https://developer.zendesk.com/api-reference/changelog/changelog/","kind":"archive"},"quote":"The Merge Self with Another User endpoint is being removed and replaced with the Merge End Users endpoint.","migration":"Merge with Merge End Users (PUT /api/v2/users/{user_id}/merge).","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:32:58.297Z","updatedAt":"2026-10-23T10:32:58.297Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/zendesk-api/breaking-changes/put-api-v2-users-me-merge-stops-working/"},{"slug":"the-nps-api-stops-working","api":"zendesk-api","title":"The NPS API stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2023-01-17","effectiveAt":"2023-04-30","scope":null,"calls":["/api/v2/nps/*"],"method":null,"path":"/api/v2/nps/*","source":{"url":"https://developer.zendesk.com/api-reference/changelog/changelog/","kind":"archive"},"quote":"Removed the Net Promoter Score℠ (NPS®) API.","migration":"No replacement; collect satisfaction with CSAT surveys instead.","migrationChange":null,"needsDecision":"Zendesk removed NPS surveys without an API in their place.","text":null,"publishedAt":"2026-10-23T10:32:58.297Z","updatedAt":"2026-10-23T10:32:58.297Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/zendesk-api/breaking-changes/the-nps-api-stops-working/"},{"slug":"get-api-v2-apps-locations-is-deprecated","api":"zendesk-api","title":"GET /api/v2/apps/locations/{} is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-01-30","effectiveAt":null,"scope":null,"calls":["GET /api/v2/apps/locations/{}"],"method":"GET","path":"/api/v2/apps/locations/{}","source":{"url":"https://developer.zendesk.com/api-reference/changelog/changelog/","kind":"archive"},"quote":"Starting April 30, 2026, the /api/v2/apps/locations/{app_location_id} endpoint is deprecated for all accounts.","migration":"Read locations with List Locations (GET /api/v2/apps/locations).","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:32:58.297Z","updatedAt":"2026-10-23T10:32:58.297Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/zendesk-api/breaking-changes/get-api-v2-apps-locations-is-deprecated/"},{"slug":"post-api-v2-oauth-tokens-is-deprecated","api":"zendesk-api","title":"POST /api/v2/oauth/tokens is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-08-26","effectiveAt":null,"scope":null,"calls":["POST /api/v2/oauth/tokens"],"method":"POST","path":"/api/v2/oauth/tokens","source":{"url":"https://developer.zendesk.com/api-reference/changelog/changelog/","kind":"archive"},"quote":"The Create Token ( /api/v2/oauth/tokens ) endpoint is deprecated.","migration":"Request tokens with Create Token for Grant Type (POST /oauth/tokens).","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:32:58.297Z","updatedAt":"2026-10-23T10:32:58.297Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/zendesk-api/breaking-changes/post-api-v2-oauth-tokens-is-deprecated/"}]}