POST /api/v2/tickets

Default value: "application/json"

An array of the numeric IDs of sharing agreements. Note that this replaces any existing agreements

An array of objects that represent agent or end users email CCs to add or delete from the ticket. See Setting email CCs

Valid values:

• "put"
• "delete"

An object explaining how the ticket was created. See the Via object reference

For some channels a source object gives more information about how or why the ticket or event was created

This tells you how the ticket or event was created. Examples: "web", "mobile", "rule", "system". May be a string name or an integer channel ID.

Datetime of last update received from API. See the safe_update property

Custom metadata hash that can be set by API clients

Enterprise only. The id of the ticket form to render for the ticket

The value of the subject field for this ticket

The ids of agents or end users currently CC'ed on the ticket. See CCs and followers resources in the Support Help Center

The organization of the requester. You can only specify the ID of an organization associated with the requester. See Organization Memberships

A TPE voice comment for Talk Partner Edition tickets

The ticket ID. Ignored on update requests - included for client convenience.

The urgency with which the ticket should be addressed.

Valid values:

• "high"
• "normal"
• "low"
• "urgent"

A voice comment for Talk tickets. See Creating voicemail tickets

Dialed phone number

Duration of the call in seconds

The agent who answered the call

Transcription of the call

Location of the caller

URL of the recording

Incoming phone number

The ID of a forum topic to link this ticket to

TDE workspace information for the ticket

Valid values:

• "DELETE"
• "ADD"
• "CHANGE"

POST requests only. Users to add as cc's when creating a ticket. See Setting Collaborators

If this is a ticket of type "task" it has a due date. Due date format uses ISO 8601 format.

The predicted satisfaction probability score

The type of this ticket.

Valid values:

• "incident"
• "problem"
• "question"
• "task"

The Zendesk Resource Name (ZRN) of the origin for this ticket

The state of the ticket.

If your account has activated custom ticket statuses, this is the ticket's status category. See custom ticket statuses.

Valid values:

• "open"
• "hold"
• "new"
• "pending"
• "closed"
• "solved"

Alias for custom_fields. Custom field values to set on the ticket. Each entry specifies a field ID and its value.

The ID of the custom field

The value to assign to the custom field. Type depends on the field configuration:

• Text/textarea: string
• Checkbox: boolean or "true"/"false" string
• Dropdown/tagger: string or array of strings (multi-select)
• Number/decimal: number or string representation
• Date: string (ISO 8601 format)

Optional boolean. Prevents updates with outdated ticket data (updated_stamp property required when true)

An array of objects that represent agent followers to add or delete from the ticket. See Setting followers

Valid values:

• "put"
• "delete"

Alternative to requester_id for specifying the ticket requester.

Can be provided as:

• Email string: "user@example.com"
• User ID integer: 12345
• User object: {name: "John Doe", email: "john@example.com"}

If both requester and requester_id are provided, requester_id takes precedence.

When creating a ticket, if the user doesn't exist, they may be created automatically depending on account settings.

The user who requested this ticket

An array of numeric IDs, emails, or objects containing name and email properties. See Setting Collaborators. An email notification is sent to them when the ticket is updated

Enterprise only. The id of the brand this ticket is associated with

POST requests only. The id of a closed ticket when creating a follow-up ticket. See Creating a follow-up ticket

The array of tags applied to this ticket

The dynamic content placeholder, if present, or the "subject" value, if not. See Dynamic Content Items

An id you can use to link Zendesk Support tickets to local records

Sharing agreement configuration for the ticket. Can be a single object or array of objects.

The initial description/content of the ticket. Sets the body of the first comment on the ticket. Only applies when creating a ticket.

An array of the IDs of attribute values to be associated with the ticket

The ids of agents currently following the ticket. See CCs and followers resources

The agent currently assigned to the ticket

The custom ticket status id of the ticket. See custom ticket statuses

Custom field values to set on the ticket. Each entry specifies a field ID and its value. See Setting custom field values

The ID of the custom field

The value to assign to the custom field. Type depends on the field configuration:

• Text/textarea: string
• Checkbox: boolean or "true"/"false" string
• Dropdown/tagger: string or array of strings (multi-select)
• Number/decimal: number or string representation
• Date: string (ISO 8601 format)

For tickets of type "incident", the ID of the problem the incident is linked to

The suspension type ID when recovering a suspended ticket

The email address of the agent to assign the ticket to

A single macro ID to be recorded in the ticket audit

URL field

System metadata for the ticket, typically set by internal clients

The ids of users currently CC'ed on the ticket

The ID of the suspended ticket being recovered

The original recipient e-mail address of the ticket

Describes how the object was created. See the Via object reference

For some channels a source object gives more information about how or why the ticket or event was created

This tells you how the ticket or event was created. Examples: "web", "mobile", "rule", "system"

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

System information (web client, IP address, etc.) and comment flags, if any. See Comment flags

Automatically assigned when the comment is created

The comment presented as plain text. See Bodies

Attachments, if any. See Attachment

The content type of the image. Example value: "image/png"

If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false

The size of the image file in bytes

If true, the attachment has been deleted

The height of the image file in pixels. If height is unknown, returns null

A URL to access the attachment details

The width of the image file in pixels. If width is unknown, returns null

An array of attachment objects. Note that photo thumbnails do not have thumbnails

The content type of the image. Example value: "image/png"

If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false

The size of the image file in bytes

If true, the attachment has been deleted

The height of the image file in pixels. If height is unknown, returns null

A URL to access the attachment details

The width of the image file in pixels. If width is unknown, returns null

If true, you can download an attachment flagged as malware. If false, you can't download such an attachment.

The URL the attachment image file has been mapped to

The name of the image file

A full URL where the attachment image file can be downloaded. The file may be hosted externally so take care not to inadvertently send Zendesk authentication credentials. See Working with url properties

Automatically assigned when created

The result of the malware scan. There is a delay between the time the attachment is uploaded and when the malware scan is completed. Usually the scan is done within a few seconds, but high load conditions can delay the scan results. Possible values: "malware_found", "malware_not_found", "failed_to_scan", "not_scanned"

If true, you can download an attachment flagged as malware. If false, you can't download such an attachment.

The URL the attachment image file has been mapped to

The name of the image file

A full URL where the attachment image file can be downloaded. The file may be hosted externally so take care not to inadvertently send Zendesk authentication credentials. See Working with url properties

Automatically assigned when created

The result of the malware scan. There is a delay between the time the attachment is uploaded and when the malware scan is completed. Usually the scan is done within a few seconds, but high load conditions can delay the scan results. Possible values: "malware_found", "malware_not_found", "failed_to_scan", "not_scanned"

The id of the comment author. If null or omitted on create, defaults to the authenticated user. See Author id

The id of the ticket audit record. See Show Audit

The comment string. See Bodies

Comment or VoiceComment. The JSON object for adding voice comments to tickets is different. See Adding voice comments to tickets

The comment formatted as HTML. See Bodies

List of tokens received from uploading files for comment attachments. The files are attached by creating or updating tickets with the tokens. See Attaching files in Tickets

The time the comment was created

POST requests only. List of macro IDs to be recorded in the ticket audit

The group this ticket is assigned to

The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket.

If not specified, defaults to the authenticated user.