Zendesk

Zendesk Dynamic Content API

The Dynamic Content API from Zendesk — 3 operation(s) for dynamic content.

Documentation GitHub OpenAPI

Documentation

https://developer.zendesk.com/api-reference/ticketing/introduction/

https://developer.zendesk.com/api-reference/ticketing/targets/targets/

https://developer.zendesk.com/api-reference/sales-crm/resources/account/

https://developer.zendesk.com/api-reference/ticketing/tickets/activity_stream/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/channel_framework/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/audit_logs/

https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/

https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/bookmarks/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/brand_agents/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/

https://developer.zendesk.com/api-reference/live-chat/chat-api/chats/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/

https://developer.zendesk.com/api-reference/custom-data/introduction/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/

https://developer.zendesk.com/api-reference/ticketing/tickets/custom_ticket_statuses/

https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/

https://developer.zendesk.com/api-reference/ticketing/users/users/

https://developer.zendesk.com/api-reference/ticketing/business-rules/deletion_schedules/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content/

https://developer.zendesk.com/api-reference/ticketing/tickets/email_notifications/

https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/

https://developer.zendesk.com/api-reference/ticketing/business-rules/group_sla_policies/

https://developer.zendesk.com/api-reference/ticketing/groups/groups/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_import/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/

https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/

https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_tokens/

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_fields/

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_subscriptions/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/push_notification_devices/

https://developer.zendesk.com/api-reference/agent-availability/omnichannel_routing_queues/omnichannel_routing_queues/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/support_addresses/

https://developer.zendesk.com/api-reference/ticketing/lookup_relationships/lookup_relationships/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-requests/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/resource_collections/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/skill_based_routing/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_ratings/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_reasons/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/sessions/

https://developer.zendesk.com/api-reference/ticketing/tickets/sharing_agreements/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_skips/

https://developer.zendesk.com/api-reference/ticketing/business-rules/sla_policies/

https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_audits/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_form_statuses/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_metrics/

https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/

https://developer.zendesk.com/api-reference/ticketing/business-rules/views/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/workspaces/

Specifications

https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/openapi/zendesk-dynamic-content-api-openapi.yml

Schemas & Data

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

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

Other Resources

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

OpenAPI Specification

openapi: 3.1.0
info:
  version: '1.0'
  title: Zendesk Account Account Settings Dynamic Content API
  description: Needs a description.
tags:
- name: Dynamic Content
paths:
  /api/v2/dynamic_content/items:
    get:
      operationId: ListDynamicContents
      tags:
      - Dynamic Content
      summary: Zendesk Get  Api V2 Dynamic_content Items
      description: 'Returns a list of all dynamic content items for your account if accessed as an admin or agents who have permission to manage dynamic content.


        #### Allowed For


        * Admins, Agents


        #### Pagination


        * Cursor pagination (recommended)

        * Offset pagination


        See [Pagination](/api-reference/introduction/pagination/).

        '
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicContentsResponse'
              examples:
                default:
                  $ref: '#/components/examples/DynamicContentsResponseExample'
    post:
      operationId: CreateDynamicContent
      tags:
      - Dynamic Content
      summary: Zendesk Post  Api V2 Dynamic_content Items
      description: 'Create a new content item, with one or more variants in the item''s `variants` array. See [Specifying item variants](#specifying-item-variants).


        The `default_locale_id` and variant `locale_id` values must be one of the locales the account has active. You can get the list with the [List Locales](/api-reference/ticketing/account-configuration/locales/#list-locales) endpoint.


        #### Allowed For


        * Admins, Agents

        '
      responses:
        '201':
          description: Created response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicContentResponse'
              examples:
                default:
                  $ref: '#/components/examples/DynamicContentResponseExample'
  /api/v2/dynamic_content/items/{dynamic_content_item_id}:
    parameters:
    - $ref: '#/components/parameters/DynamicContentItemId'
    get:
      operationId: ShowDynamicContentItem
      tags:
      - Dynamic Content
      summary: Zendesk Get  Api V2 Dynamic_content Items Dynamic_content_item_id
      description: '#### Allowed For


        * Admins, Agents

        '
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicContentResponse'
              examples:
                default:
                  $ref: '#/components/examples/DynamicContentResponseExample'
    put:
      operationId: UpdateDynamicContentItem
      tags:
      - Dynamic Content
      summary: Zendesk Put  Api V2 Dynamic_content Items Dynamic_content_item_id
      description: 'The only attribute you can change is the name.


        To add a variant to the item, or to update or delete the variants of the item, use the [Item Variants API](/api-reference/ticketing/ticket-management/dynamic_content_item_variants/#update-many-variants).


        #### Allowed For


        * Admins, Agents

        '
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicContentResponse'
              examples:
                default:
                  $ref: '#/components/examples/DynamicContentUpdateResponseExample'
    delete:
      operationId: DeleteDynamicContentItem
      tags:
      - Dynamic Content
      summary: Zendesk Delete  Api V2 Dynamic_content Items Dynamic_content_item_id
      description: '#### Allowed For


        * Admins, Agents

        '
      responses:
        '204':
          description: No Content response
  /api/v2/dynamic_content/items/show_many:
    get:
      operationId: ShowManyDynamicContents
      tags:
      - Dynamic Content
      summary: Zendesk Get  Api V2 Dynamic_content Items Show_many
      description: '#### Stability


        * Development


        #### Allowed For


        * Admins, Agents

        '
      parameters:
      - name: identifiers
        in: query
        description: Identifiers for the dynamic contents
        schema:
          type: string
        example: item1,item2
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicContentsResponse'
              examples:
                default:
                  $ref: '#/components/examples/DynamicContentsResponseExample'
components:
  schemas:
    DynamicContentResponse:
      type: object
      properties:
        item:
          $ref: '#/components/schemas/DynamicContentObject'
    DynamicContentsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DynamicContentObject'