Zendesk

Zendesk Deletion Schedules API

The Deletion Schedules API from Zendesk — 2 operation(s) for deletion schedules.

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-deletion-schedules-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 Deletion Schedules API
  description: Needs a description.
tags:
- name: Deletion Schedules
paths:
  /api/v2/deletion_schedules:
    get:
      operationId: ListDeletionSchedules
      tags:
      - Deletion Schedules
      summary: Zendesk Get  Api V2 Deletion_schedules
      description: 'Lists all deletion schedules for the account. Deletion schedules are used to automatically delete data from the account after a certain period of time.


        #### Allowed For


        * Admins

        '
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletion_schedules:
                    type: array
                    items:
                      $ref: '#/components/schemas/DeletionSchedule'
              examples:
                default:
                  $ref: '#/components/examples/GetDeletionSchedulesResponseExample'
    post:
      operationId: CreateDeletionSchedule
      tags:
      - Deletion Schedules
      summary: Zendesk Post  Api V2 Deletion_schedules
      description: 'Creates a new deletion schedule.


        #### Allowed For


        * Admins

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                deletion_schedule:
                  $ref: '#/components/schemas/DeletionSchedule'
            examples:
              default:
                $ref: '#/components/examples/CreateDeletionScheduleRequestExample'
      responses:
        '201':
          description: Success Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletion_schedule:
                    $ref: '#/components/schemas/DeletionSchedule'
              examples:
                default:
                  $ref: '#/components/examples/CreateDeletionScheduleResponseExample'
  /api/v2/deletion_schedules/{deletion_schedule_id}:
    get:
      operationId: GetDeletionSchedule
      tags:
      - Deletion Schedules
      summary: Zendesk Get  Api V2 Deletion_schedules Deletion_schedule_id
      description: 'Gets a deletion schedule by its id.


        #### Allowed For


        * Admins

        '
      parameters:
      - $ref: '#/components/parameters/DeletionScheduleId'
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletion_schedule:
                    $ref: '#/components/schemas/DeletionSchedule'
              examples:
                default:
                  $ref: '#/components/examples/GetDeletionScheduleResponseExample'
    put:
      operationId: UpdateDeletionSchedule
      tags:
      - Deletion Schedules
      summary: Zendesk Put  Api V2 Deletion_schedules Deletion_schedule_id
      description: 'Updates a deletion schedule by its id.


        **Note**: Updating a condition updates the conditions array, clearing all existing values of the array. Include all your conditions when updating any condition.


        #### Allowed For


        * Admins

        '
      parameters:
      - $ref: '#/components/parameters/DeletionScheduleId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                deletion_schedule:
                  $ref: '#/components/schemas/DeletionSchedule'
            examples:
              default:
                $ref: '#/components/examples/UpdateDeletionScheduleRequestExample'
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletion_schedule:
                    $ref: '#/components/schemas/DeletionSchedule'
              examples:
                default:
                  $ref: '#/components/examples/UpdateDeletionScheduleResponseExample'
    delete:
      operationId: DeleteDeletionSchedule
      tags:
      - Deletion Schedules
      summary: Zendesk Delete  Api V2 Deletion_schedules Deletion_schedule_id
      description: 'Deletes a deletion schedule by its id.


        #### Allowed For


        * Admins

        '
      parameters:
      - $ref: '#/components/parameters/DeletionScheduleId'
      responses:
        '204':
          description: Success Response