POST /api/v2/channels/voice/tickets

Default value: "application/json"

Optional value such as the ID of the agent that will see the newly created ticket.

Ticket object that lists the values to set when the ticket is created

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

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. Ignored when CCs and followers is not enabled

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.

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

The ids of the followups created from this ticket. Ids are only visible once the ticket is closed

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

Enterprise only. The id of the ticket form to render for the 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 value of the subject field for this ticket. See Subject

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

Write only. A TPE voice comment for Talk Partner Edition tickets

Automatically assigned when the ticket is created

The urgency with which the ticket should be addressed

Valid values:

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

Dialed phone number

Duration in seconds of the call

The agent who answered the call

Whether the voice comment is public

Transcription of the call (optional)

Location of the caller (optional)

Incoming phone number

Timestamp of the call starting time

Incoming phone number

The topic in the Zendesk Web portal this ticket originated from, if any. The Web portal is deprecated

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

Write only. TDE workspace information for the ticket

Valid values:

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

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

If true, the ticket's via type is a messaging channel.

The type of this ticket

Valid values:

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

Write only. 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)

Write only. Optional boolean. When true and an updated_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. A value of false has the same effect as true. Omit the property to force the updates to not be safe

Write only. An array of objects that represents agent followers to add or delete from the ticket. See Setting followers. Ignored when CCs and followers is not enabled

Valid values:

• "put"
• "delete"

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

Required for Create Ticket operation

Valid values:

• 44
• 45
• 46

Is true if a ticket is a problem type and has one or more incidents linked to it. Otherwise, the value is false.

The user who requested this ticket

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

The id of the brand this ticket is associated with. See Setting up multiple brands

Write only. Alternative to submitter_id for specifying the ticket submitter. Can be provided as a user email string or user ID integer.

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

The tags applied to this ticket. Unless otherwise specified, the set tag behavior is used, which overwrites and replaces existing tags

Is false if channelback is disabled, true otherwise. Only applicable for channels framework ticket

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

The dynamic content placeholder, if present, or the "subject" value, if not. See Dynamic Content Items. When set on create or update, overrides the subject field.

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

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

The first comment on the ticket. When creating a ticket, use comment to set the description. See Description and first comment. On create, can be set directly as an alternative to comment. Silently ignored on update.

Permission for agents to add add attachments to a comment. Defaults to true

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

The ids of agents currently following the ticket. Ignored when CCs and followers is not enabled

An encoded string representing the ticket's unique identifier

When this record last got updated. It is updated only if the update generates a ticket event

An array of tags to add to the ticket

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

Write only. The suspension type ID when recovering a suspended ticket

Write only. The email address of the agent to assign the ticket to

A Unix timestamp that represents the most accurate reading of when this record was last updated. It is updated for all ticket updates, including system updates

Write only. A single macro ID to be recorded in the ticket audit

The API url of this ticket

Write only. System metadata for the ticket, typically set by internal clients

The ids of users currently CC'ed on the ticket

An array of tags to remove from the ticket

Write only. The ID of the suspended ticket being recovered

The original recipient e-mail address of the ticket. Notification emails for the ticket are sent from this address

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

Internal flag for adding short URLs to the comment

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

The locale code to translate the comment body to.

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

Internal channel back identifier for the comment

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

Internal channel source identifier for the comment

Is true if any comments are public, false otherwise

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

When this record was created

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.