Form Ticket Statuses API Documentation

Definitions

Ticket Form Status

A mapping record between a Ticket Form and a Custom Status for a given account. The mapping serves as configuration information to help inform which Custom Statuses to show in the Status Picker in Agent Workspace when working using a particular Ticket Form.

A ticket form status contains 3 primary pieces of information:

• custom_status_id - the id of the custom status associated with this object
• ticket_form_id - the id of the ticket form associated with this object
• id - the unique identifier for the record

Authentication / Authorization

The operations and endpoints for this feature set follow the established authentication scheme for public facing Zendesk APIs as referenced in our api documentation.

 

Details about authentication can be found here:
https://developer.zendesk.com/api-reference/introduction/security-and-auth/  

Limitations

Rate Limiting

The operations and endpoints for this feature set follow the established rate limiting scheme for accounts as described in our online documentation here:

 

https://developer.zendesk.com/api-reference/introduction/rate-limits/

Operations & Endpoints

View all Ticket Form Statuses for my account

Available For: Agents and Admins

GET /api/v2/ticket_form_statuses


Response:
200
{
  "ticket_form_statuses" : [
    {
      "custom_status_id" : 7485541848574,
      "id" : "01HFD81Y01D65FJ7EPNNM58GPK",
      "ticket_form_id" : 7485506877054
      "created_at": "2024-01-01T21:00:00Z",
      "updated_at": "2024-01-01T21:00:00Z"
    },
    {
      "custom_status_id" : 7485541848574,
      "id" : "01HFD81Y01D6ABD#PNNM54DPA",
      "ticket_form_id" : 7485506877055,
      "created_at": "2024-01-01T21:00:00Z",
      "updated_at": "2024-01-01T21:00:00Z"
    }
  ]
}

View filtered Ticket Form Statuses for my account

Available For: Agents and Admins

Supported filter keys:

• custom_status_id
• id

Filter key values can be single or multiple values. Use a comma delimited list of values to pass many. For example  filter[custom_status_id]=abc,def

GET /api/v2/ticket_form_statuses?filter[custom_status_id]=7485541848574


Response:
200
{
  "ticket_form_statuses" : [
    {
      "custom_status_id" : 7485541848574,
      "id" : "01HFD81Y01D65FJ7EPNNM58GPK",
      "ticket_form_id" : 7485506877054,
      "created_at": "2024-01-01T21:00:00Z",
      "updated_at": "2024-01-01T21:00:00Z"
    },
    {
      "custom_status_id" : 7485541848574,
      "id" : "01HFD81Y01D6ABD#PNNM54DPA",
      "ticket_form_id" : 7485506877055,
      "created_at": "2024-01-01T21:00:00Z",
      "updated_at": "2024-01-01T21:00:00Z"
    }
  ]
}

View all Ticket Form Statuses for a particular Ticket Form

Available For: Agents and Admins

GET /api/v2/ticket_forms/7485506877054/ticket_form_statuses


Response:
200
{
  "ticket_form_statuses" : [
    {
      "custom_status_id" : 7485541848574,
      "id" : "01HFD81Y01D65FJ7EPNNM58GPK",
      "ticket_form_id" : 7485506877054,
      "created_at": "2024-01-01T21:00:00Z",
      "updated_at": "2024-01-01T21:00:00Z"
    }
  ]
}

View all Ticket Form Statuses filtered by a list of IDs

Available For: Agents and Admins

GET /api/v2/ticket_form_statuses/show_many?ids=01HFD81Y01D65FJ7EPNNM58GPK,01HFD81Y01D65FJ7EPNNM58GPL


Response:
200
{
  "ticket_form_statuses" : [
    {
      "custom_status_id" : 7485541848574,
      "id" : "01HFD81Y01D65FJ7EPNNM58GPK",
      "ticket_form_id" : 7485506877054,
      "created_at": "2024-01-01T21:00:00Z",
      "updated_at": "2024-01-01T21:00:00Z"
    },
    {
      "custom_status_id" : 7485541848575,
      "id" : "01HFD81Y01D65FJ7EPNNM58GPL",
      "ticket_form_id" : 7485506877054,
      "created_at": "2024-01-01T21:00:00Z",
      "updated_at": "2024-01-01T21:00:00Z"
    }
  ]
}

Create one Ticket Form Status

Available For: Admins

POST /api/v2/ticket_forms/7485506877054/ticket_form_statuses


Request Body:
{
 "ticket_form_status": {
   "custom_status_id": 7485541848575
 }
}


Response:
201
{
  "ticket_form_status" : {
    "custom_status_id" : 7485541848575,
    "id" : "01HFD81Y01D65FJ7EPNNM58GPL",
    "ticket_form_id" : 7485506877054,
    "created_at": "2024-01-01T21:00:00Z",
    "updated_at": "2024-01-01T21:00:00Z"
  }
}

Create many Ticket Form Statuses

Available For: Admins

POST /api/v2/ticket_forms/7485506877054/ticket_form_statuses


Request Body:
{
 "ticket_form_status": [
   { "custom_status_id": 7485541848575 },
   { "custom_status_id": 7485541848574 }
 ]
}


Response:
201
{
  "ticket_form_statuses" : [
    {
      "custom_status_id" : 7485541848574,
      "id" : "01HFD81Y01D65FJ7EPNNM58GPK",
      "ticket_form_id" : 7485506877054,
      "created_at": "2024-01-01T21:00:00Z",
      "updated_at": "2024-01-01T21:00:00Z"
    },
    {
      "custom_status_id" : 7485541848575,
      "id" : "01HFD81Y01D65FJ7EPNNM58GPL",
      "ticket_form_id" : 7485506877054,
      "created_at": "2024-01-01T21:00:00Z",
      "updated_at": "2024-01-01T21:00:00Z"
    }
  ]
}

Remove custom status association from a Ticket Form

Available For: Admins

DELETE /api/v2/ticket_forms/7485506877054/ticket_form_statuses/01HFD81Y01D65FJ7EPNNM58GPL


Response:
200
<no content>

Remove custom status associations from a Ticket Form

Available For: Admins

DELETE /api/v2/ticket_forms/7485506877054/ticket_form_statuses


Request Body:
{
  "id": [
    "01HFD81Y01D65FJ7EPNNM58GPL",
    "01HFD81Y01D65FJ7EPNNM58GPK"
  ]
}


Response:
200
<no content>

Modify collection of Ticket Form Statuses for a Ticket Form

Available For: Admins

This endpoint is used primarily for bulk operations such as adding and removing custom status associations for a form at the same time.

The following example request both adds a Ticket Form Status and removes the Ticket Form Status identified with id 01HFD81Y01D65FJ7EPNNM58GPL

PUT /api/v2/ticket_forms/7485506877054/ticket_form_statuses


Request Body:
{
  "ticket_form_status": [
    { "custom_status_id": 7485541848575 },
    { "id": "01HFD81Y01D65FJ7EPNNM58GPL", "_destroy": "1" }
  ]
}


Response:
200
{
  "ticket_form_statuses" : [
    {
      "custom_status_id" : 7485541848575,
      "id" : "01HFD81Y01D65FJ7EPNNM58GPK",
      "ticket_form_id" : 7485506877054,
      "created_at": "2024-01-01T21:00:00Z",
      "updated_at": "2024-01-01T21:00:00Z"
    }
  ]
}