Zendesk Sell · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Zendesk Sell deals api

11 actions 11 updates update extends openapi/zendesk-sell-deals-api-openapi.yml

Derived by API Evangelist Built from the contracts Zendesk Sell publishes. Zendesk Sell did not publish this file.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-agentic-access-refx-apievangelist-enrichedx-lifecycle-statusx-end-of-lifex-end-of-life-sourcex-artifactsx-rate-limitx-required-headers

Targets 7

$.info

$.paths['/v2/deals'].get

$.paths['/v2/deals'].post

$.paths['/v2/deals/{id}'].get

$.paths['/v2/deals/{id}'].put

$.paths['/v2/deals/{id}'].delete

$.paths['/v2/deals/upsert'].post

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Zendesk Sell deals api
  version: 1.0.0
extends: openapi/zendesk-sell-deals-api-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: >-
  Enhancements derived from the Zendesk Sell developer documentation (requests, errors,
  authentication, rate-limits, retirement announcement) captured in this repo. The original
  OpenAPI is never mutated.
actions:
- target: $.info
  update:
    x-apievangelist-enriched: '2026-08-13'
    x-lifecycle-status: retiring
    x-end-of-life: '2027-08-31'
    x-end-of-life-source: https://support.zendesk.com/hc/en-us/articles/9591462550042-Announcing-the-retiring-of-Zendesk-Sell
    x-artifacts:
      conventions: conventions/zendesk-sell-conventions.yml
      errors: errors/zendesk-sell-problem-types.yml
      rate-limits: rate-limits/zendesk-sell-rate-limits.yml
      authentication: authentication/zendesk-sell-authentication.yml
      scopes: scopes/zendesk-sell-scopes.yml
      data-model: data-model/zendesk-sell-data-model.yml
      events: events/zendesk-sell-events.yml
- target: $.info
  update:
    x-rate-limit:
      scope: per-token
      limit: 36000
      window: 1h
      status_on_exhaustion: 429
      headers: []
      source: https://developer.zendesk.com/api-reference/sales-crm/rate-limits/
- target: $.info
  update:
    x-required-headers:
    - name: User-Agent
      required: true
      note: Requests without a User-Agent are rejected with 400 invalid_user_agent.
      source: https://developer.zendesk.com/api-reference/sales-crm/requests/
- target: $.info
  update:
    x-error-envelope:
      problem_json: false
      shape: '{"errors":[{"error":{"code","message","details","resource","field"}}],"meta":{"http_status","logref"}}'
      request_id_field: meta.logref
      request_id_header: X-Request-Id
      source: https://developer.zendesk.com/api-reference/sales-crm/errors/
- target: $.info
  update:
    x-idempotency:
      supported: false
      note: >-
        No Idempotency-Key contract is published. The upsert operations match on
        caller-supplied business attributes; they are not replay-safe on a key.
- target: $.paths['/v2/deals'].get
  update:
    x-agentic-access-ref: agentic-access/zendesk-sell-agentic-access.yml#listDeals
- target: $.paths['/v2/deals'].post
  update:
    x-agentic-access-ref: agentic-access/zendesk-sell-agentic-access.yml#createDeal
- target: $.paths['/v2/deals/{id}'].get
  update:
    x-agentic-access-ref: agentic-access/zendesk-sell-agentic-access.yml#getDeal
- target: $.paths['/v2/deals/{id}'].put
  update:
    x-agentic-access-ref: agentic-access/zendesk-sell-agentic-access.yml#updateDeal
- target: $.paths['/v2/deals/{id}'].delete
  update:
    x-agentic-access-ref: agentic-access/zendesk-sell-agentic-access.yml#deleteDeal
- target: $.paths['/v2/deals/upsert'].post
  update:
    x-agentic-access-ref: agentic-access/zendesk-sell-agentic-access.yml#upsertDeal

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/zendesk-sell-deals-api-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.