Zendesk

Zendesk Custom Ticket Statuses API

The Custom Ticket Statuses API from Zendesk — 4 operation(s) for custom ticket statuses.

Documentation GitHub OpenAPI

Operations 6

PUT /api/v2/custom_status/default Zendesk Put Api V2 Custom_status Default #

GET /api/v2/custom_statuses Zendesk Get Api V2 Custom_statuses #

POST /api/v2/custom_statuses Zendesk Post Api V2 Custom_statuses #

GET /api/v2/custom_statuses/{custom_status_id} Zendesk Get Api V2 Custom_statuses Custom_status_id #

PUT /api/v2/custom_statuses/{custom_status_id} Zendesk Put Api V2 Custom_statuses Custom_status_id #

POST /api/v2/custom_statuses/{custom_status_id}/ticket_form_statuses Zendesk Post Api V2 Custom_statuses Custom_status_id Ticket_form_statuses #

Work with this as data

Every API 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 apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
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 API

curl "https://apis.io/api/v1/apis/zendesk-custom-ticket-statuses-api"

All apis

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

Discovery needs no key. Ratings and market analysis are Pro.

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.

OpenAPI Specification

openapi: 3.2.0
info:
  version: '1.0'
  title: Zendesk Account Account Settings Custom Ticket Statuses API
  description: Needs a description.
tags:
- name: Custom Ticket Statuses
paths:
  /api/v2/custom_status/default:
    put:
      operationId: BulkUpdateDefaultCustomStatus
      tags:
      - Custom Ticket Statuses
      summary: Zendesk Put  Api V2 Custom_status Default
      description: 'Updates the default values for many custom ticket statuses at once.


        #### Allowed For


        * Admins

        '
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateDefaultCustomStatusRequest'
            examples:
              default:
                $ref: '#/components/examples/BulkUpdateDefaultCustomStatusRequestExample'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkUpdateDefaultCustomStatusResponse'
              examples:
                default:
                  $ref: '#/components/examples/BulkUpdateDefaultCustomStatusResponseExample'
  /api/v2/custom_statuses:
    get:
      operationId: ListCustomStatuses
      tags:
      - Custom Ticket Statuses
      summary: Zendesk Get  Api V2 Custom_statuses
      description: 'Lists all undeleted custom ticket statuses for the account. No pagination is provided.


        #### Allowed For


        * End Users

        '
      parameters:
      - name: status_categories
        in: query
        description: Filter the list of custom ticket statuses by a comma-separated list of status categories
        schema:
          type: string
      - name: active
        in: query
        description: If true, show only active custom ticket statuses. If false, show only inactive custom ticket statuses. If the filter is not used, show all custom ticket statuses
        schema:
          type: boolean
      - name: default
        in: query
        description: If true, show only default custom ticket statuses. If false, show only non-default custom ticket statuses. If the filter is not used, show all custom ticket statuses
        schema:
          type: boolean
      responses:
        '200':
          description: List custom ticket statuses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomStatusesResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomStatusesResponseExample'
    post:
      operationId: CreateCustomStatus
      tags:
      - Custom Ticket Statuses
      summary: Zendesk Post  Api V2 Custom_statuses
      description: 'Takes a `custom_status` object that specifies the custom ticket status properties to create.


        #### Allowed For


        * Admins

        '
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomStatusCreateRequest'
            examples:
              default:
                $ref: '#/components/examples/CustomStatusCreateRequestExample'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomStatusResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomStatusResponseExample'
  /api/v2/custom_statuses/{custom_status_id}:
    get:
      operationId: ShowCustomStatus
      tags:
      - Custom Ticket Statuses
      summary: Zendesk Get  Api V2 Custom_statuses Custom_status_id
      description: 'Returns the custom ticket status object.


        #### Allowed For


        * End Users

        '
      parameters:
      - $ref: '#/components/parameters/CustomStatusId'
      responses:
        '200':
          description: Custom Status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomStatusResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomStatusResponseExample'
    put:
      operationId: UpdateCustomStatus
      tags:
      - Custom Ticket Statuses
      summary: Zendesk Put  Api V2 Custom_statuses Custom_status_id
      description: 'Takes a `custom_status` object that specifies the properties to update.


        #### Allowed For


        * Admins

        '
      parameters:
      - $ref: '#/components/parameters/CustomStatusId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomStatusUpdateRequest'
            examples:
              default:
                $ref: '#/components/examples/CustomStatusUpdateRequestExample'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomStatusResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomStatusResponseExample'
  /api/v2/custom_statuses/{custom_status_id}/ticket_form_statuses:
    parameters:
    - $ref: '#/components/parameters/CustomStatusId'
    post:
      operationId: CreateTicketFormStatusesForCustomStatus
      tags:
      - Custom Ticket Statuses
      summary: Zendesk Post  Api V2 Custom_statuses Custom_status_id Ticket_form_statuses
      description: 'Creates one or many tickets form status associations for a custom status.


        #### Allowed For


        * Admins

        '
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ticket_form_status:
                  type: array
                  items:
                    type: object
                    properties:
                      ticket_form_id:
                        type: integer
                        description: The id of the ticket form
                        example: 1
            example:
              ticket_form_status:
              - ticket_form_id: 1
              - ticket_form_id: 2
              - ticket_form_id: 3
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TicketFormStatusesResponse'
              examples:
                default:
                  $ref: '#/components/examples/TicketFormStatusesResponseExample'
components:
  schemas:
    TicketFormStatusesResponse:
      type: object
      properties:
        ticket_form_statuses:
          type: array
          items:
            $ref: '#/components/schemas/TicketFormStatusObject'
          maxItems: 1
    CustomStatusResponse:
      type: object
      properties:
        custom_status:
          $ref: '#/components/schemas/CustomStatusObject'
    CustomStatusesResponse:
      type: object
      properties:
        custom_statuses:
          type: array
          items:
            $ref: '#/components/schemas/CustomStatusObject'
    BulkUpdateDefaultCustomStatusResponse:
      type: object

Zendesk Custom Ticket Statuses API

Operations 6

Documentation

Specifications

Schemas & Data

Other Resources