TargetJira
{
"type": "object",
"required": [
"target_url",
"username",
"password"
],
"properties": {
"password": {
"type": "string",
"description": "only writable"
},
"username": {
"type": "string"
},
"target_url": {
"type": "string"
}
}
}
TargetObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TargetCommonFields"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TargetBasecamp"
},
{
"$ref": "#/components/schemas/TargetCampfire"
},
{
"$ref": "#/components/schemas/TargetClickatell"
},
{
"$ref": "#/components/schemas/TargetEmail"
},
{
"$ref": "#/components/schemas/TargetFlowdock"
},
{
"$ref": "#/components/schemas/TargetGetSatisfaction"
},
{
"$ref": "#/components/schemas/TargetJira"
},
{
"$ref": "#/components/schemas/TargetPivotal"
},
{
"$ref": "#/components/schemas/TargetTwitter"
},
{
"$ref": "#/components/schemas/TargetURL"
},
{
"$ref": "#/components/schemas/TargetHTTP"
},
{
"$ref": "#/components/schemas/TargetYammer"
}
]
}
],
"example": {
"id": 88335,
"url": "https://company.zendesk.com/api/v2/targets/88335.json",
"type": "basecamp_target",
"title": "basecamp target",
"active": false,
"created_at": "2012-02-20T22:55:29Z"
},
"additionalProperties": true
}
TargetPivotal
{
"type": "object",
"required": [
"token",
"project_id",
"story_type",
"story_title"
],
"properties": {
"token": {
"type": "string"
},
"owner_by": {
"type": "string"
},
"project_id": {
"type": "string"
},
"story_type": {
"type": "string"
},
"story_title": {
"type": "string"
},
"requested_by": {
"type": "string"
},
"story_labels": {
"type": "string"
}
}
}
TargetResponse
{
"type": "object",
"properties": {
"target": {
"$ref": "#/components/schemas/TargetObject"
}
}
}
TargetTwitter
{
"type": "object",
"properties": {
"token": {
"type": "string"
},
"secret": {
"type": "string",
"description": "only writable"
}
}
}
TargetURL
{
"type": "object",
"required": [
"target_url",
"attribute"
],
"properties": {
"method": {
"type": "string",
"description": "\"get\""
},
"password": {
"type": "string",
"description": "only writable"
},
"username": {
"type": "string"
},
"attribute": {
"type": "string"
},
"target_url": {
"type": "string"
}
}
}
TargetYammer
{
"type": "object",
"properties": {
"token": {
"type": "string"
},
"group_id": {
"type": "string"
}
}
}
TargetsResponse
{
"type": "object",
"properties": {
"targets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TargetObject"
}
}
}
}
TicketAuditObject
{
"type": "object",
"example": {
"id": 35436,
"via": {
"channel": "web"
},
"events": [
{
"id": 1564245,
"body": "Thanks for your help!",
"type": "Comment",
"public": true,
"attachments": []
},
{
"id": 1564246,
"body": "Ticket #47 has been updated",
"type": "Notification",
"subject": "Your ticket has been updated"
}
],
"metadata": {
"custom": {
"time_spent": "3m22s"
},
"system": {
"ip_address": "184.106.40.75"
}
},
"author_id": 35436,
"ticket_id": 47,
"created_at": "2009-07-20T22:55:29Z"
},
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when creating audits"
},
"via": {
"$ref": "#/components/schemas/TicketAuditViaObject"
},
"events": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
},
"description": "An array of the events that happened in this audit. See the [Ticket Audit events reference](https://developer.zendesk.com)"
},
"metadata": {
"type": "object",
"readOnly": true,
"description": "Metadata for the audit, custom and system data",
"additionalProperties": true
},
"author_id": {
"type": "integer",
"readOnly": true,
"description": "The user who created the audit"
},
"ticket_id": {
"type": "integer",
"readOnly": true,
"description": "The ID of the associated ticket"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the audit was created"
}
}
}
TicketAuditResponse
{
"type": "object",
"properties": {
"audit": {
"$ref": "#/components/schemas/TicketAuditObject"
}
}
}
TicketAuditViaObject
{
"type": "object",
"properties": {
"source": {
"type": "object",
"readOnly": true,
"description": "For some channels a source object gives more information about how or why the ticket or event was created",
"additionalProperties": true
},
"channel": {
"type": "string",
"readOnly": true,
"description": "This tells you how the ticket or event was created. Examples: \"web\", \"mobile\", \"rule\", \"system\""
}
},
"description": "Describes how the object was created. See the [Via object reference](https://developer.zendesk.com)"
}
TicketAuditsConvertToPrivateResponse
{
"type": "string",
"example": "",
"description": "Empty response"
}
TicketAuditsCountResponse
{
"type": "object",
"properties": {
"count": {
"type": "object",
"properties": {
"value": {
"type": "integer"
},
"refreshed_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}
TicketAuditsResponse
{
"type": "object",
"properties": {
"audits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TicketAuditObject"
}
},
"after_url": {
"type": "string",
"readOnly": true
},
"before_url": {
"type": "string",
"readOnly": true
},
"after_cursor": {
"type": "string",
"readOnly": true
},
"before_cursor": {
"type": "string",
"readOnly": true
}
}
}
TicketAuditsResponseNoneCursor
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"readOnly": true
},
"audits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TicketAuditObject"
}
},
"next_page": {
"type": "string",
"nullable": true,
"readOnly": true
},
"previous_page": {
"type": "string",
"nullable": true,
"readOnly": true
}
}
}
TicketBulkImportRequest
{
"type": "object",
"properties": {
"tickets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TicketImportInput"
}
}
}
}
TicketChatCommentRedactionResponse
{
"type": "object",
"example": {
"chat_event": {
"id": 1932802680168,
"type": "ChatStartedEvent",
"value": {
"chat_id": "2109.10502823.Sjuj2YrBpXwei",
"history": [
{
"type": "ChatJoin",
"actor_id": 1900448983828,
"timestamp": 1632470783218,
"actor_name": "Visitor 36044085",
"actor_type": "end-user",
"chat_index": 0
}
],
"visitor_id": "10502823-16EkM3T6VNq7KMd"
}
}
},
"properties": {
"chat_event": {
"type": "object",
"readOnly": true,
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Id assigned to the chat event object"
},
"type": {
"type": "string",
"readOnly": true,
"description": "Type of chat event"
},
"value": {
"type": "object",
"readOnly": true,
"properties": {
"chat_id": {
"type": "string",
"readOnly": true,
"description": "Id of the chat session"
},
"history": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
},
"description": "Chat events within the chat session"
},
"visitor_id": {
"type": "string",
"readOnly": true,
"description": "Id assigned to the visitor"
}
},
"description": "The value of the chat event object"
}
},
"description": "Chat event object"
}
}
}
TicketCommentObject
{
"type": "object",
"example": {
"id": 1274,
"body": "Thanks for your help!",
"type": "Comment",
"public": true,
"metadata": {
"via": {
"source": {
"to": {},
"rel": "web_widget",
"from": {}
},
"channel": "web"
},
"system": {
"client": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/61.0.3163.100 Safari/537.36",
"latitude": -37.000000000001,
"location": "Melbourne, 07, Australia",
"longitude": 144.0000000000002,
"ip_address": "1.1.1.1"
}
},
"author_id": 123123,
"created_at": "2009-07-20T22:55:29Z",
"attachments": [
{
"id": 498483,
"size": 2532,
"file_name": "crash.log",
"thumbnails": [],
"content_url": "https://company.zendesk.com/attachments/crash.log",
"content_type": "text/plain"
}
]
},
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when the comment is created"
},
"via": {
"$ref": "#/components/schemas/TicketAuditViaObject"
},
"body": {
"type": "string",
"description": "The comment string. See [Bodies](https://developer.zendesk.com)"
},
"type": {
"type": "string",
"readOnly": true,
"description": "`Comment` or `VoiceComment`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](https://developer.zendesk.com)"
},
"public": {
"type": "boolean",
"description": "true if a public comment; false if an internal note. The initial value set on ticket creation persists for any additional comment unless you change it"
},
"uploads": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tokens received from [uploading files](/api-reference/ticketing/tickets/ticket-attachments/#upload-files) for comment attachments. The files are attached by creating or updating tickets with the tokens. See [Attaching files](/api-reference/ticketing/tickets/tickets/#attaching-files) in Tickets"
},
"audit_id": {
"type": "integer",
"readOnly": true,
"description": "The id of the ticket audit record. See [Show Audit](/api-reference/ticketing/tickets/ticket_audits/#show-audit)"
},
"metadata": {
"type": "object",
"readOnly": true,
"description": "System information (web client, IP address, etc.) and comment flags, if any. See [Comment flags](https://developer.zendesk.com)",
"additionalProperties": true
},
"author_id": {
"type": "integer",
"description": "The id of the comment author. See [Author id](https://developer.zendesk.com)"
},
"html_body": {
"type": "string",
"description": "The comment formatted as HTML. See [Bodies](https://developer.zendesk.com)"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the comment was created"
},
"plain_body": {
"type": "string",
"readOnly": true,
"description": "The comment presented as plain text. See [Bodies](https://developer.zendesk.com)"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentObject"
},
"readOnly": true,
"description": "Attachments, if any. See [Attachment](https://developer.zendesk.com)"
}
}
}
TicketCommentResponse
{
"type": "object",
"properties": {
"comment": {
"$ref": "#/components/schemas/TicketCommentObject"
}
}
}
TicketCommentsCountResponse
{
"type": "object",
"properties": {
"count": {
"type": "object",
"properties": {
"value": {
"type": "integer"
},
"refreshed_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}
TicketCommentsMakePrivateResponse
{
"type": "string",
"example": "",
"description": "Empty response"
}
TicketCommentsResponse
{
"type": "object",
"properties": {
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TicketCommentObject"
}
}
}
}
TicketCreateInput
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TicketUpdateInput"
},
{
"type": "object",
"required": [
"comment"
],
"properties": {
"via": {
"$ref": "#/components/schemas/ViaObject"
},
"brand_id": {
"type": "integer",
"description": "Enterprise only. The id of the brand this ticket is associated with"
},
"macro_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "POST requests only. List of macro IDs to be recorded in the ticket audit"
},
"recipient": {
"type": "string",
"description": "The original recipient e-mail address of the ticket"
},
"raw_subject": {
"type": "string",
"description": "The dynamic content placeholder, if present, or the \"subject\" value, if not. See [Dynamic Content Items](https://developer.zendesk.com)\n"
},
"email_cc_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The ids of agents or end users currently CC'ed on the ticket. See [CCs and followers resources](https://support.zendesk.com/hc/en-us/articles/360020585233) in the Support Help Center"
},
"follower_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The ids of agents currently following the ticket. See [CCs and followers resources](https://support.zendesk.com/hc/en-us/articles/360020585233)"
},
"submitter_id": {
"type": "integer",
"description": "The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket"
},
"collaborators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollaboratorObject"
},
"description": "POST requests only. Users to add as cc's when creating a ticket. See [Setting Collaborators](/documentation/ticketing/managing-tickets/creating-and-updating-tickets#setting-collaborators)"
},
"ticket_form_id": {
"type": "integer",
"description": "Enterprise only. The id of the ticket form to render for the ticket"
},
"via_followup_source_id": {
"type": "integer",
"description": "POST requests only. The id of a closed ticket when creating a follow-up ticket. See [Creating a follow-up ticket](/documentation/ticketing/managing-tickets/creating-and-updating-tickets#creating-a-follow-up-ticket)"
}
}
}
],
"example": {
"comment": {
"body": "The smoke is very colorful."
},
"subject": "My printer is on fire!",
"priority": "urgent"
}
}
TicketCreateRequest
{
"type": "object",
"properties": {
"ticket": {
"$ref": "#/components/schemas/TicketCreateInput"
}
}
}
TicketCreateVoicemailTicketInput
{
"type": "object",
"properties": {
"via_id": {
"enum": [
44,
45,
46
],
"type": "integer",
"description": "Required for Create Ticket operation"
},
"comment": {
"$ref": "#/components/schemas/TicketCommentObject"
},
"priority": {
"enum": [
"urgent",
"high",
"normal",
"low"
],
"type": "string",
"description": "The urgency with which the ticket should be addressed."
},
"voice_comment": {
"$ref": "#/components/schemas/TicketCreateVoicemailTicketVoiceCommentInput"
}
},
"x-konfig-properties": {
"voice_comment": {
"type": "object",
"description": "Required if creating voicemail ticket"
}
}
}
TicketCreateVoicemailTicketRequest
{
"type": "object",
"properties": {
"ticket": {
"$ref": "#/components/schemas/TicketCreateVoicemailTicketInput"
},
"display_to_agent": {
"type": "integer",
"description": "Optional value such as the ID of the agent that will see the newly created ticket."
}
},
"x-konfig-properties": {
"ticket": {
"type": "object",
"description": "Ticket object that lists the values to set when the ticket is created"
}
}
}
TicketCreateVoicemailTicketVoiceCommentInput
{
"type": "object",
"properties": {
"to": {
"type": "string",
"description": "Dialed phone number"
},
"from": {
"type": "string",
"description": "Incoming phone number"
},
"location": {
"type": "string",
"description": "Location of the caller (optional)"
},
"started_at": {
"type": "string",
"format": "date-time",
"description": "[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the call starting time"
},
"call_duration": {
"type": "integer",
"description": "Duration in seconds of the call"
},
"recording_url": {
"type": "string",
"description": "Incoming phone number"
},
"answered_by_id": {
"type": "integer",
"description": "The agent who answered the call"
},
"transcription_text": {
"type": "string",
"description": "Transcription of the call (optional)"
}
}
}
TicketFieldCountResponse
{
"type": "object",
"properties": {
"count": {
"type": "object",
"properties": {
"value": {
"type": "integer"
},
"refreshed_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}
TicketFieldCustomStatusObject
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when the custom ticket status is created"
},
"active": {
"type": "boolean",
"description": "If true, if the custom status is set to active. If false, the custom status is set to inactive"
},
"default": {
"type": "boolean",
"description": "If true, the custom status is set to default. If false, the custom status is set to non-default"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The date and time at which the custom ticket status was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The date and time at which the custom ticket status was last updated"
},
"agent_label": {
"type": "string",
"description": "The label displayed to agents"
},
"description": {
"type": "string",
"description": "The description of when the user should select this custom ticket status"
},
"end_user_label": {
"type": "string",
"description": "The label displayed to end users"
},
"status_category": {
"enum": [
"new",
"open",
"pending",
"hold",
"solved"
],
"type": "string",
"description": "The status category the custom ticket status belongs to"
},
"end_user_description": {
"type": "string",
"description": "The description displayed to end users"
}
}
}
TicketFieldObject
{
"type": "object",
"example": {
"id": 34,
"tag": null,
"url": "https://company.zendesk.com/api/v2/ticket_fields/34.json",
"type": "subject",
"title": "Subject",
"active": true,
"position": 21,
"required": true,
"raw_title": "{{dc.my_title}}",
"removable": false,
"created_at": "2009-07-20T22:55:29Z",
"updated_at": "2011-05-05T10:38:52Z",
"description": "This is the subject field of a ticket",
"raw_description": "This is the subject field of a ticket",
"title_in_portal": "Subject",
"agent_description": "This is the agent only description for the subject field",
"visible_in_portal": true,
"editable_in_portal": true,
"required_in_portal": true,
"raw_title_in_portal": "{{dc.my_title_in_portal}}",
"collapsed_for_agents": false,
"regexp_for_validation": null
},
"required": [
"type",
"title"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when created"
},
"tag": {
"type": "string",
"nullable": true,
"description": "For \"checkbox\" fields only. A tag added to tickets when the checkbox field is selected"
},
"url": {
"type": "string",
"readOnly": true,
"description": "The URL for this resource"
},
"type": {
"type": "string",
"description": "System or custom field type. Editable for custom field types and only on creation. See [Create Ticket Field](https://developer.zendesk.com)"
},
"title": {
"type": "string",
"description": "The title of the ticket field"
},
"active": {
"type": "boolean",
"description": "Whether this field is available"
},
"position": {
"type": "integer",
"description": "The relative position of the ticket field on a ticket. Note that for accounts with ticket forms, positions are controlled by the different forms"
},
"required": {
"type": "boolean",
"description": "If true, agents must enter a value in the field to change the ticket status to solved"
},
"raw_title": {
"type": "string",
"description": "The dynamic content placeholder if present, or the `title` value if not. See [Dynamic Content](https://developer.zendesk.com)"
},
"removable": {
"type": "boolean",
"readOnly": true,
"description": "If false, this field is a system field that must be present on all tickets"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the custom ticket field was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the custom ticket field was last updated"
},
"description": {
"type": "string",
"description": "Describes the purpose of the ticket field to users"
},
"sub_type_id": {
"type": "integer",
"description": "For system ticket fields of type \"priority\" and \"status\". Defaults to 0. A \"priority\" sub type of 1 removes the \"Low\" and \"Urgent\" options. A \"status\" sub type of 1 adds the \"On-Hold\" option"
},
"creator_user_id": {
"type": "integer",
"description": "The id of the user that created the ticket field, or a value of \"-1\" if an app created the ticket field"
},
"custom_statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TicketFieldCustomStatusObject"
},
"readOnly": true,
"description": "List of customized ticket statuses. Only presented for a system ticket field of type \"custom_status\""
},
"raw_description": {
"type": "string",
"description": "The dynamic content placeholder if present, or the `description` value if not. See [Dynamic Content](https://developer.zendesk.com)"
},
"title_in_portal": {
"type": "string",
"description": "The title of the ticket field for end users in Help Center"
},
"creator_app_name": {
"type": "string",
"description": "Name of the app that created the ticket field, or a null value if no app created the ticket field"
},
"agent_description": {
"type": "string",
"description": "A description of the ticket field that only agents can see"
},
"visible_in_portal": {
"type": "boolean",
"description": "Whether this field is visible to end users in Help Center"
},
"editable_in_portal": {
"type": "boolean",
"description": "Whether this field is editable by end users in Help Center"
},
"required_in_portal": {
"type": "boolean",
"description": "If true, end users must enter a value in the field to create the request"
},
"raw_title_in_portal": {
"type": "string",
"description": "The dynamic content placeholder if present, or the \"title_in_portal\" value if not. See [Dynamic Content](https://developer.zendesk.com)"
},
"relationship_filter": {
"type": "object",
"description": "A filter definition that allows your autocomplete to filter down results"
},
"collapsed_for_agents": {
"type": "boolean",
"description": "If true, the field is shown to agents by default. If false, the field is hidden alongside infrequently used fields. Classic interface only"
},
"custom_field_options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldOptionObject"
},
"description": "Required and presented for a custom ticket field of type \"multiselect\" or \"tagger\""
},
"system_field_options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SystemFieldOptionObject"
},
"readOnly": true,
"description": "Presented for a system ticket field of type \"tickettype\", \"priority\" or \"status\""
},
"regexp_for_validation": {
"type": "string",
"nullable": true,
"description": "For \"regexp\" fields only. The validation pattern for a field value to be deemed valid"
},
"relationship_target_type": {
"type": "string",
"description": "A representation of what type of object the field references. Options are \"zen:user\", \"zen:organization\", \"zen:ticket\", or \"zen:custom_object:{key}\" where key is a custom object key. For example \"zen:custom_object:apartment\"."
}
}
}
TicketFieldResponse
{
"type": "object",
"properties": {
"ticket_field": {
"$ref": "#/components/schemas/TicketFieldObject"
}
}
}
TicketFieldsResponse
{
"type": "object",
"properties": {
"ticket_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TicketFieldObject"
}
}
}
}
TicketFormObject
{
"type": "object",
"example": {
"id": 47,
"url": "https://company.zendesk.com/api/v2/ticket_forms/47.json",
"name": "Snowboard Problem",
"active": true,
"default": true,
"position": 9999,
"raw_name": "Snowboard Problem",
"created_at": "2012-04-02T22:55:29Z",
"updated_at": "2012-04-02T22:55:29Z",
"display_name": "Snowboard Damage",
"in_all_brands": false,
"agent_conditions": [
{
"value": "matching_value",
"child_fields": [
{
"id": 101,
"is_required": false,
"required_on_statuses": {
"type": "SOME_STATUSES",
"statuses": [
"new",
"open",
"pending",
"hold"
]
}
},
{
"id": 200,
"is_required": true,
"required_on_statuses": {
"type": "SOME_STATUSES",
"statuses": [
"solved"
]
}
}
],
"parent_field_id": 100
},
{
"value": "matching_value_2",
"child_fields": [
{
"id": 102,
"is_required": true,
"required_on_statuses": {
"type": "ALL_STATUSES"
}
},
{
"id": 200,
"is_required": false,
"required_on_statuses": {
"type": "NO_STATUSES"
}
}
],
"parent_field_id": 101
}
],
"end_user_visible": true,
"raw_display_name": "{{dc.my_display_name}}",
"ticket_field_ids": [
2,
4,
5,
10,
100,
101,
102,
200
],
"end_user_conditions": [
{
"value": "matching_value",
"child_fields": [
{
"id": 101,
"is_required": true
}
],
"parent_field_id": 100
},
{
"value": "matching_value",
"child_fields": [
{
"id": 202,
"is_required": false
}
],
"parent_field_id": 200
}
],
"restricted_brand_ids": [
47,
33,
22
]
},
"required": [
"name"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when creating ticket form"
},
"url": {
"type": "string",
"readOnly": true,
"description": "URL of the ticket form"
},
"name": {
"type": "string",
"description": "The name of the form"
},
"active": {
"type": "boolean",
"description": "If the form is set as active"
},
"default": {
"type": "boolean",
"description": "Is the form the default form for this account"
},
"position": {
"type": "integer",
"description": "The position of this form among other forms in the account, i.e. dropdown"
},
"raw_name": {
"type": "string",
"description": "The dynamic content placeholder, if present, or the \"name\" value, if not. See [Dynamic Content Items](https://developer.zendesk.com)"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the ticket form was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time of the last update of the ticket form"
},
"display_name": {
"type": "string",
"description": "The name of the form that is displayed to an end user"
},
"in_all_brands": {
"type": "boolean",
"description": "Is the form available for use in all brands on this account"
},
"agent_conditions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
},
"description": "Array of condition sets for agent workspaces"
},
"end_user_visible": {
"type": "boolean",
"description": "Is the form visible to the end user"
},
"raw_display_name": {
"type": "string",
"description": "The dynamic content placeholder, if present, or the \"display_name\" value, if not. See [Dynamic Content Items](https://developer.zendesk.com)"
},
"ticket_field_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "ids of all ticket fields which are in this ticket form. The products use the order of the ids to show the field values in the tickets"
},
"end_user_conditions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
},
"description": "Array of condition sets for end user products"
},
"restricted_brand_ids": {
"type": "array",
"items": {
"type": "integer"
},
"readOnly": true,
"description": "ids of all brands that this ticket form is restricted to"
}
}
}
TicketFormResponse
{
"type": "object",
"properties": {
"ticket_form": {
"$ref": "#/components/schemas/TicketFormObject"
}
}
}
TicketFormsResponse
{
"type": "object",
"properties": {
"ticket_forms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TicketFormObject"
}
}
}
}
TicketImportInput
{
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The array of tags applied to this ticket"
},
"subject": {
"type": "string",
"description": "The value of the subject field for this ticket"
},
"comments": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The comment string value"
}
}
},
{
"$ref": "#/components/schemas/TicketCommentObject"
}
]
},
"description": "The conversation between requesters, collaborators, and agents",
"additionalProperties": true
},
"assignee_id": {
"type": "integer",
"description": "The agent currently assigned to the ticket"
},
"description": {
"type": "string",
"description": "Read-only first comment on the ticket. When [creating a ticket](https://developer.zendesk.com), use `comment` to set the description. See [Description and first comment](https://developer.zendesk.com)"
},
"requester_id": {
"type": "integer",
"description": "The user who requested this ticket"
}
}
}
TicketImportRequest
{
"type": "object",
"properties": {
"ticket": {
"$ref": "#/components/schemas/TicketImportInput"
}
}
}
TicketMergeInput
{
"type": "object",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Ids of tickets to merge into the target ticket"
},
"source_comment": {
"type": "string",
"description": "Private comment to add to the source ticket"
},
"target_comment": {
"type": "string",
"description": "Private comment to add to the target ticket"
},
"source_comment_is_public": {
"type": "boolean",
"description": "Whether comment in source tickets are public or private"
},
"target_comment_is_public": {
"type": "boolean",
"description": "Whether comment in target ticket is public or private"
}
}
}
TicketMetricEventBaseObject
{
"type": "object",
"title": "Ticket Metric Events",
"example": {
"id": 926256957613,
"time": "2020-10-26T12:53:12Z",
"type": "measure",
"metric": "agent_work_time",
"ticket_id": 155,
"instance_id": 1
},
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when the record is created"
},
"time": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the event occurred"
},
"type": {
"enum": [
"activate",
"pause",
"fulfill",
"apply_sla",
"breach",
"update_status",
"measure"
],
"type": "string",
"readOnly": true,
"description": "The type of the metric event. See [Ticket metric event types reference](https://developer.zendesk.com)"
},
"metric": {
"enum": [
"agent_work_time",
"pausable_update_time",
"periodic_update_time",
"reply_time",
"requester_wait_time",
"resolution_time"
],
"type": "string",
"readOnly": true,
"description": "The metric being tracked"
},
"ticket_id": {
"type": "integer",
"readOnly": true,
"description": "Id of the associated ticket"
},
"instance_id": {
"type": "integer",
"readOnly": true,
"description": "The instance of the metric associated with the event. See [instance_id](https://developer.zendesk.com)"
}
}
}
TicketMetricEventBreachObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TicketMetricEventBaseObject"
},
{
"type": "object",
"properties": {
"deleted": {
"type": "boolean",
"readOnly": true,
"description": "Available if `type` is `breach`. In general, you can ignore any breach event when `deleted` is true. See [deleted](https://developer.zendesk.com)"
}
}
}
],
"title": "Ticket Metric Event"
}
TicketMetricEventGroupSLAObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TicketMetricEventBaseObject"
},
{
"type": "object",
"properties": {
"group_sla": {
"type": "object",
"readOnly": true,
"description": "Available if `type` is \"apply_group_sla\". The Group SLA policy and target being enforced on the ticket and metric in question, if any. See [group_sla](https://developer.zendesk.com)"
}
}
}
],
"title": "Ticket Metric Event"
}
TicketMetricEventSLAObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TicketMetricEventBaseObject"
},
{
"type": "object",
"properties": {
"sla": {
"type": "object",
"readOnly": true,
"description": "Available if `type` is `apply_sla`. The SLA policy and target being enforced on the ticket and metric in question, if any. See [sla](https://developer.zendesk.com)"
}
}
}
],
"title": "Ticket Metric Event"
}
TicketMetricEventUpdateStatusObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TicketMetricEventBaseObject"
},
{
"type": "object",
"properties": {
"status": {
"type": "object",
"readOnly": true,
"description": "Available if `type` is `update_status`. Minutes since the metric has been open. See [status](https://developer.zendesk.com)"
}
}
}
],
"title": "Ticket Metric Event"
}
TicketMetricEventsResponse
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"ticket_metric_events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TicketMetricEventBaseObject"
}
}
}
},
{
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"end_time": {
"type": "integer"
},
"next_page": {
"type": "string"
}
}
}
]
}
TicketMetricObject
{
"type": "object",
"example": {
"id": 33,
"reopens": 55,
"replies": 322,
"solved_at": "2011-05-09T10:38:52Z",
"ticket_id": 4343,
"created_at": "2009-07-20T22:55:29Z",
"updated_at": "2011-05-05T10:38:52Z",
"assigned_at": "2011-05-05T10:38:52Z",
"group_stations": 7,
"assignee_stations": 1,
"status_updated_at": "2011-05-04T10:38:52Z",
"assignee_updated_at": "2011-05-06T10:38:52Z",
"requester_updated_at": "2011-05-07T10:38:52Z",
"initially_assigned_at": "2011-05-03T10:38:52Z",
"reply_time_in_minutes": {
"business": 737,
"calendar": 2391
},
"reply_time_in_seconds": {
"calendar": 143460
},
"latest_comment_added_at": "2011-05-09T10:38:52Z",
"on_hold_time_in_minutes": {
"business": 637,
"calendar": 2290
},
"custom_status_updated_at": "2011-05-09T10:38:52Z",
"agent_wait_time_in_minutes": {
"business": 737,
"calendar": 2391
},
"requester_wait_time_in_minutes": {
"business": 737,
"calendar": 2391
},
"full_resolution_time_in_minutes": {
"business": 737,
"calendar": 2391
},
"first_resolution_time_in_minutes": {
"business": 737,
"calendar": 2391
}
},
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when the client is created"
},
"url": {
"type": "string",
"readOnly": true,
"description": "The API url of the ticket metric"
},
"reopens": {
"type": "integer",
"readOnly": true,
"description": "Total number of times the ticket was reopened"
},
"replies": {
"type": "integer",
"readOnly": true,
"description": "The number of public replies added to a ticket by an agent"
},
"solved_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the ticket was solved"
},
"ticket_id": {
"type": "integer",
"readOnly": true,
"description": "Id of the associated ticket"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the record was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the record was last updated"
},
"assigned_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the ticket was assigned"
},
"group_stations": {
"type": "integer",
"readOnly": true,
"description": "Number of groups the ticket passed through"
},
"assignee_stations": {
"type": "integer",
"readOnly": true,
"description": "Number of assignees the ticket had"
},
"status_updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the status of the ticket was last updated"
},
"assignee_updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the assignee last updated the ticket"
},
"requester_updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the requester last updated the ticket"
},
"initially_assigned_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the ticket was initially assigned"
},
"reply_time_in_minutes": {
"$ref": "#/components/schemas/TicketMetricTimeObject"
},
"reply_time_in_seconds": {
"$ref": "#/components/schemas/TicketMetricTimeObject"
},
"latest_comment_added_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the latest comment was added"
},
"on_hold_time_in_minutes": {
"$ref": "#/components/schemas/TicketMetricTimeObject"
},
"custom_status_updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The date and time the ticket's custom status was last updated"
},
"agent_wait_time_in_minutes": {
"$ref": "#/components/schemas/TicketMetricTimeObject"
},
"requester_wait_time_in_minutes": {
"$ref": "#/components/schemas/TicketMetricTimeObject"
},
"full_resolution_time_in_minutes": {
"$ref": "#/components/schemas/TicketMetricTimeObject"
},
"first_resolution_time_in_minutes": {
"$ref": "#/components/schemas/TicketMetricTimeObject"
}
},
"x-konfig-properties": {
"reply_time_in_minutes": {
"type": "object",
"readOnly": true,
"description": "Number of minutes to the first reply during calendar and business hours"
},
"reply_time_in_seconds": {
"type": "object",
"readOnly": true,
"description": "Number of seconds to the first reply during calendar hours, only available for Messaging tickets"
},
"on_hold_time_in_minutes": {
"type": "object",
"readOnly": true,
"description": "Number of minutes on hold"
},
"agent_wait_time_in_minutes": {
"type": "object",
"readOnly": true,
"description": "Number of minutes the agent spent waiting during calendar and business hours"
},
"requester_wait_time_in_minutes": {
"type": "object",
"readOnly": true,
"description": "Number of minutes the requester spent waiting during calendar and business hours"
},
"full_resolution_time_in_minutes": {
"type": "object",
"readOnly": true,
"description": "Number of minutes to the full resolution during calendar and business hours"
},
"first_resolution_time_in_minutes": {
"type": "object",
"readOnly": true,
"description": "Number of minutes to the first resolution time during calendar and business hours"
}
}
}
TicketMetricTimeObject
{
"type": "object",
"properties": {
"business": {
"type": "integer",
"readOnly": true,
"description": "Time in business hours"
},
"calendar": {
"type": "integer",
"readOnly": true,
"description": "Time in calendar hours"
}
}
}
TicketMetricsByTicketMetricIdResponse
{
"type": "object",
"properties": {
"ticket_metric": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TicketMetricObject"
}
}
}
}
TicketMetricsResponse
{
"type": "object",
"properties": {
"ticket_metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TicketMetricObject"
}
}
}
}
TicketObject
{
"type": "object",
"example": {
"id": 35436,
"url": "https://company.zendesk.com/api/v2/tickets/35436.json",
"via": {
"channel": "web"
},
"tags": [
"enterprise",
"other_tag"
],
"type": "incident",
"due_at": null,
"status": "open",
"subject": "Help, my printer is on fire!",
"group_id": 98738,
"priority": "high",
"recipient": "support@company.com",
"created_at": "2009-07-20T22:55:29Z",
"problem_id": 9873764,
"updated_at": "2011-05-05T10:38:52Z",
"assignee_id": 235323,
"description": "The fire is very colorful.",
"external_id": "ahg35h3jh",
"raw_subject": "{{dc.printer_on_fire}}",
"follower_ids": [
35334,
234
],
"requester_id": 20978392,
"submitter_id": 76872,
"custom_fields": [
{
"id": 27642,
"value": "745"
},
{
"id": 27648,
"value": "yes"
}
],
"has_incidents": false,
"organization_id": 509974,
"collaborator_ids": [
35334,
234
],
"custom_status_id": 123,
"satisfaction_rating": {
"id": 1234,
"score": "good",
"comment": "Great support!"
},
"sharing_agreement_ids": [
84432
],
"from_messaging_channel": false
},
"required": [
"requester_id"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when the ticket is created"
},
"url": {
"type": "string",
"readOnly": true,
"description": "The API url of this ticket"
},
"via": {
"type": "object",
"properties": {
"source": {
"type": "object",
"description": "For some channels a source object gives more information about how or why the ticket or event was created\n",
"additionalProperties": true
},
"channel": {
"type": "string",
"description": "This tells you how the ticket or event was created. Examples: \"web\", \"mobile\", \"rule\", \"system\"\n"
}
},
"description": "For more information, see the [Via object reference](https://developer.zendesk.com)"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The array of tags applied to this ticket. Unless otherwise specified, the [set tag](/api-reference/ticketing/ticket-management/tags/#set-tags) behavior is used, which overwrites and replaces existing tags"
},
"type": {
"enum": [
"problem",
"incident",
"question",
"task"
],
"type": "string",
"description": "The type of this ticket"
},
"due_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "If this is a ticket of type \"task\" it has a due date. Due date format uses [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format"
},
"status": {
"enum": [
"new",
"open",
"pending",
"hold",
"solved",
"closed"
],
"type": "string",
"description": "The state of the ticket.\n\nIf your account has activated custom ticket statuses, this is the ticket's\nstatus category. See [custom ticket statuses](https://developer.zendesk.com)\n"
},
"via_id": {
"type": "integer",
"writeOnly": true,
"description": "Write only. For more information, see the [Via object reference](https://developer.zendesk.com)"
},
"comment": {
"type": "object",
"writeOnly": true,
"description": "Write only. An object that adds a comment to the ticket. See [Ticket comments](https://developer.zendesk.com). To include an attachment with the comment, see [Attaching files](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#attaching-files)"
},
"subject": {
"type": "string",
"description": "The value of the subject field for this ticket. See [Subject](/api-reference/ticketing/tickets/tickets/#subject)\n"
},
"brand_id": {
"type": "integer",
"description": "The id of the brand this ticket is associated with. See [Setting up multiple brands](https://support.zendesk.com/hc/en-us/articles/4408829476378)"
},
"group_id": {
"type": "integer",
"description": "The group this ticket is assigned to"
},
"macro_id": {
"type": "integer",
"writeOnly": true,
"description": "Write only. A macro ID to be recorded in the ticket audit"
},
"metadata": {
"type": "object",
"writeOnly": true,
"description": "Write only. Metadata for the audit. In the `audit` object, the data is specified in the `custom` property of the `metadata` object. See [Setting Metadata](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#setting-metadata)"
},
"priority": {
"enum": [
"urgent",
"high",
"normal",
"low"
],
"type": "string",
"description": "The urgency with which the ticket should be addressed"
},
"email_ccs": {
"type": "object",
"writeOnly": true,
"description": "Write only. An array of objects that represent agent or end users email CCs to add or delete from the ticket. See [Setting email CCs](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#setting-email-ccs)"
},
"followers": {
"type": "object",
"writeOnly": true,
"description": "Write only. An array of objects that represent agent followers to add or delete from the ticket. See [Setting followers](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#setting-followers)"
},
"is_public": {
"type": "boolean",
"readOnly": true,
"description": "Is true if any comments are public, false otherwise"
},
"macro_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "POST requests only. List of macro IDs to be recorded in the ticket audit"
},
"recipient": {
"type": "string",
"description": "The original recipient e-mail address of the ticket. Notification emails for the ticket are sent from this address"
},
"requester": {
"type": "object",
"writeOnly": true,
"description": "Write only. See [Creating a ticket with a new requester](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#creating-a-ticket-with-a-new-requester)"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When this record was created"
},
"problem_id": {
"type": "integer",
"description": "For tickets of type \"incident\", the ID of the problem the incident is linked to"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When this record last got updated. It is updated only if the update generates a [ticket event](https://developer.zendesk.com)"
},
"assignee_id": {
"type": "integer",
"description": "The agent currently assigned to the ticket"
},
"description": {
"type": "string",
"readOnly": true,
"description": "Read-only first comment on the ticket. When [creating a ticket](https://developer.zendesk.com), use `comment` to set the description. See [Description and first comment](https://developer.zendesk.com)\n"
},
"external_id": {
"type": "string",
"description": "An id you can use to link Zendesk Support tickets to local records"
},
"raw_subject": {
"type": "string",
"description": "The dynamic content placeholder, if present, or the \"subject\" value, if not. See [Dynamic Content Items](https://developer.zendesk.com)\n"
},
"safe_update": {
"type": "boolean",
"writeOnly": true,
"description": "Write only. Optional boolean. When true and an `update_stamp` date is included, protects against ticket update collisions and returns a message to let you know if one occurs. See [Protecting against ticket update collisions](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#protecting-against-ticket-update-collisions). A value of false has the same effect as true. Omit the property to force the updates to not be safe"
},
"email_cc_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The ids of agents or end users currently CC'ed on the ticket. See [CCs and followers resources](https://support.zendesk.com/hc/en-us/articles/360020585233) in the Support Help Center"
},
"follower_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The ids of agents currently following the ticket. See [CCs and followers resources](https://support.zendesk.com/hc/en-us/articles/360020585233)"
},
"followup_ids": {
"type": "array",
"items": {
"type": "integer"
},
"readOnly": true,
"description": "The ids of the followups created from this ticket. Ids are only visible once the ticket is closed"
},
"requester_id": {
"type": "integer",
"description": "The user who requested this ticket"
},
"submitter_id": {
"type": "integer",
"description": "The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket"
},
"collaborators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollaboratorObject"
},
"description": "POST requests only. Users to add as cc's when creating a ticket. See [Setting Collaborators](/documentation/ticketing/managing-tickets/creating-and-updating-tickets#setting-collaborators)"
},
"custom_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The id of the custom field"
},
"value": {
"type": "string",
"description": "The value of the custom field"
}
}
},
"description": "Custom fields for the ticket. See [Setting custom field values](/documentation/ticketing/managing-tickets/creating-and-updating-tickets#setting-custom-field-values)"
},
"has_incidents": {
"type": "boolean",
"readOnly": true,
"description": "Is true if a ticket is a problem type and has one or more incidents linked to it. Otherwise, the value is false."
},
"updated_stamp": {
"type": "string",
"writeOnly": true,
"description": "Write only. Datetime of last update received from API. See the `safe_update` property"
},
"voice_comment": {
"type": "object",
"writeOnly": true,
"description": "Write only. See [Creating voicemail ticket](/api-reference/voice/talk-partner-edition-api/reference/#creating-voicemail-tickets)"
},
"assignee_email": {
"type": "string",
"writeOnly": true,
"description": "Write only. The email address of the agent to assign the ticket to"
},
"forum_topic_id": {
"type": "integer",
"readOnly": true,
"description": "The topic in the Zendesk Web portal this ticket originated from, if any. The Web portal is deprecated"
},
"ticket_form_id": {
"type": "integer",
"description": "Enterprise only. The id of the ticket form to render for the ticket"
},
"organization_id": {
"type": "integer",
"description": "The organization of the requester. You can only specify the ID of an organization associated with the requester. See [Organization Memberships](https://developer.zendesk.com)"
},
"collaborator_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The ids of users currently CC'ed on the ticket"
},
"custom_status_id": {
"type": "integer",
"description": "The custom ticket status id of the ticket. See [custom ticket statuses](https://developer.zendesk.com)"
},
"allow_attachments": {
"type": "boolean",
"readOnly": true,
"description": "Permission for agents to add add attachments to a comment. Defaults to true"
},
"allow_channelback": {
"type": "boolean",
"readOnly": true,
"description": "Is false if channelback is disabled, true otherwise. Only applicable for channels framework ticket"
},
"attribute_value_ids": {
"type": "array",
"items": {
"type": "integer"
},
"writeOnly": true,
"description": "Write only. An array of the IDs of attribute values to be associated with the ticket"
},
"satisfaction_rating": {
"type": "object",
"readOnly": true,
"description": "The satisfaction rating of the ticket, if it exists, or the state of satisfaction, \"offered\" or \"unoffered\". The value is null for plan types that don't support CSAT",
"additionalProperties": true
},
"sharing_agreement_ids": {
"type": "array",
"items": {
"type": "integer"
},
"readOnly": true,
"description": "The ids of the sharing agreements used for this ticket"
},
"from_messaging_channel": {
"type": "boolean",
"readOnly": true,
"description": "If true, the ticket's [via type](https://developer.zendesk.com) is a messaging channel."
},
"via_followup_source_id": {
"type": "integer",
"description": "POST requests only. The id of a closed ticket when creating a follow-up ticket. See [Creating a follow-up ticket](/documentation/ticketing/managing-tickets/creating-and-updating-tickets#creating-a-follow-up-ticket)"
}
}
}
TicketRelatedInformation
{
"type": "object",
"properties": {
"twitter": {
"type": "object",
"description": "X (formerly Twitter) information associated with the ticket",
"additionalProperties": true
},
"topic_id": {
"type": "string",
"nullable": true,
"description": "Related topic in the Web portal (deprecated feature)"
},
"incidents": {
"type": "integer",
"description": "A count of related incident occurrences"
},
"from_archive": {
"type": "boolean",
"description": "Is true if the current ticket is archived"
},
"followup_source_ids": {
"type": "array",
"items": {
"type": "string",
"description": "Sources to follow up"
}
}
}
}