Zendesk

Zendesk Skill Based Routing API

The Skill Based Routing API from Zendesk — 10 operation(s) for skill based routing.

GitHub OpenAPI
Business capability
Customer Inquiry Management BC-430.10

Operations 18

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v2/routing/agents/{user_id}/instance_values List an agent's routing skills · Zendesk Get Api V2 Routing Agents User_id Instance_values #
Ask an LLM
“Which skills are assigned to a particular agent for routing?”
“How can I see the attribute values one agent has in skills-based routing?”
Tell an agent
Show the routing skills currently assigned to this agent.
List the attribute values set on that agent's profile.
POST /api/v2/routing/agents/{user_id}/instance_values Set or replace an agent's routing skills · Zendesk Post Api V2 Routing Agents User_id Instance_values #
Ask an LLM
“Does setting skills on an agent replace the ones they already have?”
“How do I give one agent a new set of routing skills?”
Tell an agent
Replace this agent's skills with Spanish and Billing.
Assign routing attribute values to the agent, overwriting any existing ones.
GET /api/v2/routing/agents/instance_values Get skills for up to 100 agents · Zendesk Get Api V2 Routing Agents Instance_values #
Ask an LLM
“Can I pull the routing skills for a whole team of agents in one call?”
“What's the maximum number of agents I can fetch skills for at once?”
Tell an agent
Get the skills for agents {agent_ids}.
Show attribute values for agents {agent_ids}, {page_size} per page.
POST /api/v2/routing/agents/instance_values/job Bulk add, replace or remove agent skills · Zendesk Post Api V2 Routing Agents Instance_values Job #
Ask an LLM
“How do I add a skill to 100 agents at once?”
“Can a bulk job remove a routing skill from many agents together?”
Tell an agent
Start a job that adds the French skill to every agent on the EMEA team.
Bulk remove the Legacy Product skill from these agents.
GET /api/v2/routing/attributes List routing attributes on the account · Zendesk Get Api V2 Routing Attributes #
Ask an LLM
“What routing attributes, like Language or Product, are defined on our account?”
“Can I sideload attribute values when listing routing attributes?”
Tell an agent
List all skills-based routing attributes in the account.
Show every routing attribute along with its available values.
POST /api/v2/routing/attributes Create a routing attribute · Zendesk Post Api V2 Routing Attributes #
Ask an LLM
“How do I add a new skill category such as Language for routing?”
“Can I create a routing attribute type that skills will belong to?”
Tell an agent
Create a routing attribute called Product Line.
Add a new skill category named Region for skills-based routing.
GET /api/v2/routing/attributes/{attribute_id} Get a routing attribute · Zendesk Get Api V2 Routing Attributes Attribute_id #
Ask an LLM
“How do I see the details of one routing attribute?”
“What does a single skills-based routing attribute record contain?”
Tell an agent
Show the Language routing attribute.
Get the details of that one routing attribute.
PUT /api/v2/routing/attributes/{attribute_id} Rename a routing attribute · Zendesk Put Api V2 Routing Attributes Attribute_id #
Ask an LLM
“Can I rename an existing routing attribute?”
“Who is allowed to update a skills-based routing attribute?”
Tell an agent
Rename the Product routing attribute to Product Line.
Update that routing attribute's name.
DELETE /api/v2/routing/attributes/{attribute_id} Delete a routing attribute · Zendesk Delete Api V2 Routing Attributes Attribute_id #
Ask an LLM
“What happens if I delete a whole routing attribute category?”
“Can admins remove a routing attribute we no longer use?”
Tell an agent destructive · confirm first
Delete the Region routing attribute.
Remove that unused skill category from routing.
GET /api/v2/routing/attributes/{attribute_id}/values List the skills under a routing attribute · Zendesk Get Api V2 Routing Attributes Attribute_id Values #
Ask an LLM
“Which skills exist under the Language attribute?”
“How do I see every value defined for one routing attribute?”
Tell an agent
List all skills under the Language routing attribute.
Show the values defined for that attribute.
POST /api/v2/routing/attributes/{attribute_id}/values Add a skill to a routing attribute · Zendesk Post Api V2 Routing Attributes Attribute_id Values #
Ask an LLM
“How do I add a new skill like German under the Language attribute?”
“Can I create a skill value inside an existing routing attribute?”
Tell an agent
Add a German skill to the Language attribute.
Create a new value called Enterprise under the Plan routing attribute.
GET /api/v2/routing/attributes/{attribute_id}/values/{attribute_value_id} Get one skill (attribute value) · Zendesk Get Api V2 Routing Attributes Attribute_id Values Attribute_value_id #
Ask an LLM
“How can I inspect a single skill and its settings?”
“What details come back for one attribute value in routing?”
Tell an agent
Show the German skill under the Language attribute.
Get that single attribute value's details.
PATCH /api/v2/routing/attributes/{attribute_id}/values/{attribute_value_id} Update a skill's name and ticket conditions · Zendesk Patch Api V2 Routing Attributes Attribute_id Values Attribute_value_id #
Ask an LLM
“How do I make a skill apply automatically to tickets that meet certain conditions?”
“Can I change the conditions that attach a skill to new tickets?”
Tell an agent
Update the Billing skill so it's applied to tickets tagged invoice.
Rename that skill and change its ticket conditions.
DELETE /api/v2/routing/attributes/{attribute_id}/values/{attribute_value_id} Delete a skill from an attribute · Zendesk Delete Api V2 Routing Attributes Attribute_id Values Attribute_value_id #
Ask an LLM
“Can I delete a skill value we've stopped supporting?”
“How do I remove one value from a routing attribute?”
Tell an agent destructive · confirm first
Delete the Portuguese skill from the Language attribute.
Remove that outdated skill value.
GET /api/v2/routing/attributes/definitions List conditions usable to apply skills · Zendesk Get Api V2 Routing Attributes Definitions #
Ask an LLM
“What ticket conditions can I use to automatically apply skills?”
“Which condition definitions are available for routing attributes?”
Tell an agent
List the condition definitions available for applying skills to tickets.
Show which ticket conditions I can use in skill rules.
GET /api/v2/routing/requirements/fulfilled Find tickets whose skills match mine · Zendesk Get Api V2 Routing Requirements Fulfilled #
Ask an LLM
“Which of these tickets match my own skills?”
“Can I check whether I'm qualified for a set of tickets based on routing skills?”
Tell an agent
Tell me which of tickets {ticket_ids} match my skills.
Check tickets {ticket_ids} against my routing attributes and return the ones I fulfill.
GET /api/v2/routing/tickets/{ticket_id}/instance_values List the skills required by a ticket · Zendesk Get Api V2 Routing Tickets Ticket_id Instance_values #
Ask an LLM
“What skills does a specific ticket require?”
“How do I see which attribute values are attached to a ticket?”
Tell an agent
Show the skills attached to this ticket.
List the routing attribute values on that ticket.
POST /api/v2/routing/tickets/{ticket_id}/instance_values Set or replace a ticket's required skills · Zendesk Post Api V2 Routing Tickets Ticket_id Instance_values #
Ask an LLM
“How do I set the skills a ticket needs so it routes to the right agent?”
“Are invalid or deleted attributes ignored when I set ticket skills?”
Tell an agent
Set this ticket's required skills to Spanish and Payments.
Replace the skills on that ticket with the Enterprise value.

Documentation

📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/introduction/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/targets/targets/
📖
Documentation
https://developer.zendesk.com/api-reference/sales-crm/resources/account/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/activity_stream/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/channel_framework/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/audit_logs/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/bookmarks/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/brand_agents/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/
📖
Documentation
https://developer.zendesk.com/api-reference/live-chat/chat-api/chats/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/
📖
Documentation
https://developer.zendesk.com/api-reference/custom-data/introduction/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/custom_ticket_statuses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/users/users/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/deletion_schedules/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/email_notifications/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/group_sla_policies/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/groups/groups/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_import/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_tokens/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organization_fields/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organization_subscriptions/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/push_notification_devices/
📖
Documentation
https://developer.zendesk.com/api-reference/agent-availability/omnichannel_routing_queues/omnichannel_routing_queues/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/support_addresses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/lookup_relationships/lookup_relationships/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-requests/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/resource_collections/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/skill_based_routing/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_ratings/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_reasons/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/sessions/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/sharing_agreements/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_skips/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/sla_policies/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_audits/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_form_statuses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_metrics/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/views/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/workspaces/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/openapi/zendesk-skill-based-routing-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/json-schema/zendesk-ticket-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/json-schema/zendesk-user-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/json-ld/zendesk-context.jsonld

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:zendesk-skill-based-routing-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

zendesk-skill-based-routing-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Zendesk Skill Based Routing API
  version: '1.0'
  description: 'Operations tagged Skill Based Routing across 2 of this provider''s published API definitions: routing-openapi-original.yml, tickets-openapi-original.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Skill Based Routing
paths:
  /api/v2/routing/agents/{user_id}/instance_values:
    parameters:
    - $ref: '#/components/parameters/UserId'
    get:
      operationId: ListAGentAttributeValues
      tags:
      - Skill Based Routing
      summary: Zendesk Get Api V2 Routing Agents User_id Instance_values
      description: 'Returns an attribute value.


        #### Allowed For


        * Agents and admins'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillBasedRoutingAttributeValuesResponse'
              examples:
                default:
                  $ref: '#/components/examples/SkillBasedRoutingAttributeValuesResponseExample'
    post:
      operationId: SetAgentAttributeValues
      tags:
      - Skill Based Routing
      summary: Zendesk Post Api V2 Routing Agents User_id Instance_values
      description: 'Adds the specified attributes if no attributes exists, or replaces all existing attributes with the specified attributes.


        #### Allowed For


        * Admins'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillBasedRoutingAttributeValuesResponse'
              examples:
                default:
                  $ref: '#/components/examples/SkillBasedRoutingAttributeValuesResponseExample'
  /api/v2/routing/agents/instance_values:
    get:
      operationId: ListManyAgentsAttributeValues
      tags:
      - Skill Based Routing
      summary: Zendesk Get Api V2 Routing Agents Instance_values
      description: 'Accepts a comma-separated list of up to 100 agent ids and returns attribute values for each agent in the list.


        #### Allowed For

        * Admins

        * Agents in custom role with permission to manage skills


        #### Pagination

        * Cursor pagination only.

        Note: `page[before]` and `page[after]` can''t be used together in the same request.'
      parameters:
      - name: filter[agent_ids]
        in: query
        description: A comma-separated list of agent ids
        required: true
        schema:
          type: string
        example: 224,225
      - name: page[before]
        in: query
        description: 'A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.before_cursor` value from a previous request.

          '
        schema:
          type: string
      - name: page[after]
        in: query
        description: 'A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.after_cursor` value from a previous request.

          '
        schema:
          type: string
      - name: page[size]
        in: query
        description: The number of items to return per page
        schema:
          type: integer
          format: int32
          minimum: 1
          maximum: 100
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManySkillBasedRoutingAttributeValuesResponse'
              examples:
                default:
                  $ref: '#/components/examples/ManySkillBasedRoutingAttributeValuesResponseExample'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillBasedRoutingAttributeValuesError'
              examples:
                default:
                  $ref: '#/components/examples/ManySkillBasedRoutingAttributeValuesErrorExample'
  /api/v2/routing/agents/instance_values/job:
    post:
      operationId: BulkSetAgentAttributeValuesJob
      tags:
      - Skill Based Routing
      summary: Zendesk Post Api V2 Routing Agents Instance_values Job
      description: 'Adds, replaces or removes multiple attributes for up to 100 agents.


        #### Allowed For

        * Admins

        * Agents in custom role with permission to manage skills


        #### Available Parameters


        The request takes a data object with the following properties:

        | Name | Type | Required | Description |

        | ---------- | ------ | -------- | ------------------------------------------------------------------------------------------------- |

        | action | string | true | The action to perform on the attribute values. One of the following: "upsert", "update", "delete" |

        | attributes | object | true | The attribute values to update. See Attribute Values |

        | items | array | true | The list of agent ids |


        Action can be one of the following:

        * upsert: Adds new attribute values to the agents

        * update: Replaces all the current attribute values of the agents with the new values

        * delete: Removes specified attribute values from the agents


        This endpoint returns a `job_status` JSON object and queues a background job to do the work. Use the Show Job Status endpoint to check for the job''s completion.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkSkillBasedRoutingAttributeValuesRequest'
            examples:
              default:
                $ref: '#/components/examples/BulkSkillBasedRoutingAttributeValuesRequestExample'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobStatusResponse'
              examples:
                default:
                  $ref: '#/components/examples/BulkSkillBasedRoutingAttributeValuesJobStatusResponseExample'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillBasedRoutingAttributeValuesError'
              examples:
                default:
                  $ref: '#/components/examples/BulkSkillBasedRoutingAttributeValuesErrorExample'
  /api/v2/routing/attributes:
    get:
      operationId: ListAccountAttributes
      tags:
      - Skill Based Routing
      summary: Zendesk Get Api V2 Routing Attributes
      description: 'Returns a list of attributes for the account.


        #### Sideloads


        The following sideloads are supported:


        | Name | Will sideload

        | ---------------- | -------------

        | attribute_values | The attribute values available on the account


        #### Allowed For


        * Agents and admins'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillBasedRoutingAttributesResponse'
              examples:
                default:
                  $ref: '#/components/examples/SkillBasedRoutingAttributesResponseExample'
    post:
      operationId: CreateAttribute
      tags:
      - Skill Based Routing
      summary: Zendesk Post Api V2 Routing Attributes
      description: 'Creates an attribute.


        #### Allowed For


        * Agents'
      responses:
        '201':
          description: Created response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillBasedRoutingAttributeResponse'
              examples:
                default:
                  $ref: '#/components/examples/SkillBasedRoutingAttributeCreateResponseExample'
  /api/v2/routing/attributes/{attribute_id}:
    parameters:
    - $ref: '#/components/parameters/SkillBasedRoutingAttributeId'
    get:
      operationId: ShowAttribute
      tags:
      - Skill Based Routing
      summary: Zendesk Get Api V2 Routing Attributes Attribute_id
      description: 'Returns an attribute.


        #### Allowed For


        * Admins'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillBasedRoutingAttributeResponse'
              examples:
                default:
                  $ref: '#/components/examples/SkillBasedRoutingAttributeResponseExample'
    put:
      operationId: UpdateAttribute
      tags:
      - Skill Based Routing
      summary: Zendesk Put Api V2 Routing Attributes Attribute_id
      description: 'Updates an attribute.


        #### Allowed For


        * Admins'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillBasedRoutingAttributeResponse'
              examples:
                default:
                  $ref: '#/components/examples/SkillBasedRoutingAttributeUpdateResponseExample'
    delete:
      operationId: DeleteAttribute
      tags:
      - Skill Based Routing
      summary: Zendesk Delete Api V2 Routing Attributes Attribute_id
      description: 'Deletes an attribute.


        #### Allowed For


        * Admins'
      responses:
        '204':
          description: No Content response
  /api/v2/routing/attributes/{attribute_id}/values:
    parameters:
    - $ref: '#/components/parameters/SkillBasedRoutingAttributeId'
    get:
      operationId: ListAttributeValues
      tags:
      - Skill Based Routing
      summary: Zendesk Get Api V2 Routing Attributes Attribute_id Values
      description: 'Returns a list of attribute values for a provided attribute.


        #### Allowed For


        * Agents'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillBasedRoutingAttributeValuesResponse'
              examples:
                default:
                  $ref: '#/components/examples/SkillBasedRoutingAttributeValuesResponseExample'
    post:
      operationId: CreateAttributeValue
      tags:
      - Skill Based Routing
      summary: Zendesk Post Api V2 Routing Attributes Attribute_id Values
      description: 'Creates an attribute value.


        #### Allowed For


        * Admins'
      responses:
        '201':
          description: Created response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillBasedRoutingAttributeValueResponse'
              examples:
                default:
                  $ref: '#/components/examples/SkillBasedRoutingAttributeValueCreateResponseExample'
  /api/v2/routing/attributes/{attribute_id}/values/{attribute_value_id}:
    parameters:
    - $ref: '#/components/parameters/SkillBasedRoutingAttributeId'
    - $ref: '#/components/parameters/SkillBasedRoutingAttributeValueId'
    get:
      operationId: ShowAttributeValue
      tags:
      - Skill Based Routing
      summary: Zendesk Get Api V2 Routing Attributes Attribute_id Values Attribute_value_id
      description: 'Returns an attribute value.


        #### Allowed For


        * Agents'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillBasedRoutingAttributeValueResponse'
              examples:
                default:
                  $ref: '#/components/examples/SkillBasedRoutingAttributeValueResponseExample'
    patch:
      operationId: UpdateAttributeValue
      tags:
      - Skill Based Routing
      summary: Zendesk Patch Api V2 Routing Attributes Attribute_id Values Attribute_value_id
      description: 'Updates the name and ticket conditions of a skill. When a ticket is created, the skill is applied to a ticket if the ticket meets the specified condition or conditions. See the Conditions reference for more information.


        #### Allowed For


        * Admins'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillBasedRoutingAttributeValueResponse'
              examples:
                default:
                  $ref: '#/components/examples/SkillBasedRoutingAttributeValueUpdateResponseExample'
    delete:
      operationId: DeleteAttributeValue
      tags:
      - Skill Based Routing
      summary: Zendesk Delete Api V2 Routing Attributes Attribute_id Values Attribute_value_id
      description: 'Deletes an attribute value.


        #### Allowed For


        * Agents'
      responses:
        '204':
          description: No Content response
  /api/v2/routing/attributes/definitions:
    get:
      operationId: ListRoutingAttributeDefinitions
      tags:
      - Skill Based Routing
      summary: Zendesk Get Api V2 Routing Attributes Definitions
      description: 'Returns the condition definitions that can be configured to apply attributes to a ticket.


        #### Allowed For


        * Admins'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillBasedRoutingAttributeDefinitions'
              examples:
                default:
                  $ref: '#/components/examples/SkillBasedRoutingAttributeDefinitionsExample'
  /api/v2/routing/requirements/fulfilled:
    get:
      operationId: ListTicketsFullfilledByUser
      tags:
      - Skill Based Routing
      summary: Zendesk Get Api V2 Routing Requirements Fulfilled
      description: 'Returns a list of ticket ids that contain attributes matching the current user''s attributes. Accepts a `ticket_ids` parameter for relevant tickets to check for matching attributes.


        #### Allowed For


        * Agents and admins'
      parameters:
      - name: ticket_ids
        in: query
        description: The IDs of the relevant tickets to check for matching attributes
        required: true
        schema:
          type: integer
        example: 1
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillBasedRoutingTicketFulfilledResponse'
              examples:
                default:
                  $ref: '#/components/examples/SkillBasedRoutingTicketFulfilledResponseExample'
  /api/v2/routing/tickets/{ticket_id}/instance_values:
    parameters:
    - $ref: '#/components/parameters/TicketId'
    get:
      operationId: ListTicketAttributeValues
      tags:
      - Skill Based Routing
      summary: Zendesk Get Api V2 Routing Tickets Ticket_id Instance_values
      description: 'Returns a list of attributes values for the ticket.


        #### Allowed For


        * Agents and admins'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillBasedRoutingAttributeValuesResponse'
              examples:
                default:
                  $ref: '#/components/examples/SkillBasedRoutingTicketAttributesResponseExample'
    post:
      operationId: SetTicketAttributeValues
      tags:
      - Skill Based Routing
      summary: Zendesk Post Api V2 Routing Tickets Ticket_id Instance_values
      description: 'Adds the specified attributes if no attributes exists, or replaces all existing attributes with the specified attributes.


        Invalid or deleted attributes are ignored.


        #### Allowed For


        * Admins'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillBasedRoutingAttributeValuesResponse'
              examples:
                default:
                  $ref: '#/components/examples/SkillBasedRoutingTicketAttributesResponseExample'
components:
  schemas:
    ManySkillBasedRoutingAttributeValuesResponse:
      type: object
      properties:
        count:
          type: integer
          format: int32
          description: The number of instance values returned
          readOnly: true
        instance_values:
          type: array
          items:
            $ref: '#/components/schemas/ManySkillBasedRoutingAttributeValues'
        next_page:
          type: string
          description: The URL for the next page of results
          nullable: true
          readOnly: true
        previous_page:
          type: string
          description: The URL for the previous page of results
          nullable: true
          readOnly: true
    SkillBasedRoutingTicketFulfilledResponse:
      type: object
      properties:
        fulfilled_ticket_ids:
          type: array
          items:
            type: integer
    SkillBasedRoutingAttributesResponse:
      type: object
      properties:
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/SkillBasedRoutingAttributeObject'
        count:
          type: integer
          readOnly: true
        next_page:
          type: string
          nullable: true
          readOnly: true
        previous_page:
          type: string
          nullable: true
          readOnly: true
    SkillBasedRoutingAttributeResponse:
      type: object
      properties:
        attribute:
          $ref: '#/components/schemas/SkillBasedRoutingAttributeObject'
    SkillBasedRoutingAttributeValueResponse:
      type: object
      properties:
        attribute_value:
          $ref: '#/components/schemas/SkillBasedRoutingAttributeValueObject'
    SkillBasedRoutingAttributeValuesResponse:
      type: object
      properties:
        attribute_values:
          type: array
          items:
            $ref: '#/components/schemas/SkillBasedRoutingAttributeValueObject'
    SkillBasedRoutingAttributeDefinitions:
      type: object
      properties:
        definitions:
          type: object
          properties:
            conditions_all:
              type: array
              items:
                type: object
                properties:
                  subject:
                    type: string
                  title:
                    type: string
            conditions_any:
              type: array
              items:
                type: object
                properties:
                  subject:
                    type: string
                  title:
                    type: string
    JobStatusResponse:
      type: object
      properties:
        job_status:
          $ref: '#/components/schemas/JobStatusObject'
x-refined-from:
- routing-openapi-original.yml
- tickets-openapi-original.yml