POST /api/v2/tickets

Default value: "application/json"

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

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

Possible 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"

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

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

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

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

The urgency with which the ticket should be addressed.

Possible values:

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

The agent currently assigned to the ticket

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 type of this ticket.

Possible values:

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

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

Custom fields for the ticket. See Setting custom field values

User-defined description of this field's purpose

Regular expression field only. The validation pattern for a field value to be deemed valid

The URL for this resource

Required and presented for a custom field of type "dropdown". Each option is represented by an object with a name and value property

Automatically assigned upon creation

Name of the dropdown option

URL of the dropdown option

Raw name of the dropdown option

Value of the dropdown option

Position of the dropdown option

Ordering of the field relative to other fields

Optional for custom field of type "checkbox"; not presented otherwise.

A representation of what type of object the field references. Options are "zen:user", "zen:organization", "zen:ticket", and "zen:custom_object:{key}" where key is a custom object key. For example "zen:custom_object:apartment".

The time of the last update of the ticket field

Automatically assigned upon creation

A filter definition that allows your autocomplete to filter down results

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

If true, this field is available for use

A unique key that identifies this custom field. This is used for updating the field and referencing in placeholders. The key must consist of only letters, numbers, and underscores. It can't be only numbers

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

If true, only active and position values of this field can be changed

The title of the custom field

The custom field type: "checkbox", "date", "decimal", "dropdown", "integer", "lookup", "multiselect", "regexp", "text", or "textarea"

The time of the last update of the ticket field

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

The email address of the agent to assign the ticket to

The ids of users currently CC'ed on the 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.

Possible values:

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

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

Possible values:

• "put"
• "delete"

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. 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

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. List of macro IDs to be recorded in the ticket audit

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 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

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