POST /api/v2/tickets/create_many

Accepts an array of up to 100 ticket objects. Note: Every ticket created with this endpoint may be affected by your business rules, which can include sending email notifications to your end users. If you are importing historical tickets or creating more than 1000 tickets, consider using the Ticket Bulk Import endpoint.

This endpoint returns a job_status JSON object and queues a background job to do the work. Use the Show Job Status endpoint to check for the job's completion. Only a certain number of jobs can be queued or running at the same time. See Job limit for more information.

Allowed For

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
tickets[] Array No
tickets[].external_id String No

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

tickets[].sharing_agreement_ids[] Array No

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

tickets[].email_ccs[] Array No

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

tickets[].email_ccs[].action String No

Possible values:

  • "put"
  • "delete"
tickets[].email_ccs[].user_email String No
tickets[].email_ccs[].user_name String No
tickets[].email_ccs[].user_id String No
tickets[].via Object No

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

tickets[].via.source Object No

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

tickets[].via.source.to Object No
tickets[].via.source.to.name String No
tickets[].via.source.to.address String No
tickets[].via.source.from Object No
tickets[].via.source.from.id Integer No
tickets[].via.source.from.name String No
tickets[].via.source.from.title String No
tickets[].via.source.from.address String No
tickets[].via.source.rel String No
tickets[].via.channel String No

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

tickets[].attribute_value_ids[] Array No

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

tickets[].updated_stamp String No

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

tickets[].ticket_form_id Integer No

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

tickets[].subject String No

The value of the subject field for this ticket

tickets[].email_cc_ids[] Array No

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

tickets[].organization_id Integer No

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

tickets[].follower_ids[] Array No

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

tickets[].priority String No

The urgency with which the ticket should be addressed.

Possible values:

  • "high"
  • "normal"
  • "low"
  • "urgent"
tickets[].assignee_id Integer No

The agent currently assigned to the ticket

tickets[].collaborators[] Array No

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

tickets[].collaborators[].email String No
tickets[].collaborators[].name String No
tickets[].due_at String No

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

tickets[].type String No

The type of this ticket.

Possible values:

  • "incident"
  • "problem"
  • "question"
  • "task"
tickets[].custom_status_id Integer No

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

tickets[].custom_fields[] Array No

Custom fields for the ticket. See Setting custom field values

tickets[].custom_fields[].description String No

User-defined description of this field's purpose

tickets[].custom_fields[].regexp_for_validation String No

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

tickets[].custom_fields[].url String No

The URL for this resource

tickets[].custom_fields[].custom_field_options[] Array No

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

tickets[].custom_fields[].custom_field_options[].id Integer No

Automatically assigned upon creation

tickets[].custom_fields[].custom_field_options[].name String Yes

Name of the dropdown option

tickets[].custom_fields[].custom_field_options[].url String No

URL of the dropdown option

tickets[].custom_fields[].custom_field_options[].raw_name String No

Raw name of the dropdown option

tickets[].custom_fields[].custom_field_options[].value String Yes

Value of the dropdown option

tickets[].custom_fields[].custom_field_options[].position Integer No

Position of the dropdown option

tickets[].custom_fields[].position Integer No

Ordering of the field relative to other fields

tickets[].custom_fields[].tag String No

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

tickets[].custom_fields[].relationship_target_type String No

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

tickets[].custom_fields[].updated_at String No

The time of the last update of the ticket field

tickets[].custom_fields[].id Integer No

Automatically assigned upon creation

tickets[].custom_fields[].relationship_filter Object No

A filter definition that allows your autocomplete to filter down results

tickets[].custom_fields[].raw_description String No

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

tickets[].custom_fields[].active Boolean No

If true, this field is available for use

tickets[].custom_fields[].key String Yes

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

tickets[].custom_fields[].raw_title String No

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

tickets[].custom_fields[].system Boolean No

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

tickets[].custom_fields[].title String Yes

The title of the custom field

tickets[].custom_fields[].type String Yes

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

tickets[].custom_fields[].created_at String No

The time of the last update of the ticket field

tickets[].problem_id Integer No

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

tickets[].assignee_email String No

The email address of the agent to assign the ticket to

tickets[].collaborator_ids[] Array No

The ids of users currently CC'ed on the ticket

tickets[].status String No

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"
tickets[].safe_update Boolean No

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

tickets[].followers[] Array No

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

tickets[].followers[].action String No

Possible values:

  • "put"
  • "delete"
tickets[].followers[].user_email String No
tickets[].followers[].user_id String No
tickets[].recipient String No

The original recipient e-mail address of the ticket

tickets[].comment Object Yes
tickets[].comment.via Object No

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

tickets[].comment.via.source Object No

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

tickets[].comment.via.channel String No

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

tickets[].comment.public Boolean No

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

tickets[].comment.metadata Object No

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

tickets[].comment.id Integer No

Automatically assigned when the comment is created

tickets[].comment.plain_body String No

The comment presented as plain text. See Bodies

tickets[].comment.attachments[] Array No

Attachments, if any. See Attachment

tickets[].comment.attachments[].content_type String No

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

tickets[].comment.attachments[].inline Boolean No

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

tickets[].comment.attachments[].size Integer No

The size of the image file in bytes

tickets[].comment.attachments[].deleted Boolean No

If true, the attachment has been deleted

tickets[].comment.attachments[].height String No

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

tickets[].comment.attachments[].url String No

A URL to access the attachment details

tickets[].comment.attachments[].width String No

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

tickets[].comment.attachments[].thumbnails[] Array No

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

tickets[].comment.attachments[].thumbnails[].content_type String No

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

tickets[].comment.attachments[].thumbnails[].inline Boolean No

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

tickets[].comment.attachments[].thumbnails[].size Integer No

The size of the image file in bytes

tickets[].comment.attachments[].thumbnails[].deleted Boolean No

If true, the attachment has been deleted

tickets[].comment.attachments[].thumbnails[].height String No

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

tickets[].comment.attachments[].thumbnails[].url String No

A URL to access the attachment details

tickets[].comment.attachments[].thumbnails[].width String No

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

tickets[].comment.attachments[].thumbnails[].malware_access_override Boolean No

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

tickets[].comment.attachments[].thumbnails[].mapped_content_url String No

The URL the attachment image file has been mapped to

tickets[].comment.attachments[].thumbnails[].file_name String No

The name of the image file

tickets[].comment.attachments[].thumbnails[].content_url String No

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

tickets[].comment.attachments[].thumbnails[].id Integer No

Automatically assigned when created

tickets[].comment.attachments[].thumbnails[].malware_scan_result String No

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"

tickets[].comment.attachments[].malware_access_override Boolean No

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

tickets[].comment.attachments[].mapped_content_url String No

The URL the attachment image file has been mapped to

tickets[].comment.attachments[].file_name String No

The name of the image file

tickets[].comment.attachments[].content_url String No

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

tickets[].comment.attachments[].id Integer No

Automatically assigned when created

tickets[].comment.attachments[].malware_scan_result String No

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"

tickets[].comment.author_id Integer No

The id of the comment author. See Author id

tickets[].comment.audit_id Integer No

The id of the ticket audit record. See Show Audit

tickets[].comment.body String No

The comment string. See Bodies

tickets[].comment.type String No

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

tickets[].comment.html_body String No

The comment formatted as HTML. See Bodies

tickets[].comment.uploads[] Array No

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

tickets[].comment.created_at String No

The time the comment was created

tickets[].requester_id Integer No

The user who requested this ticket

tickets[].additional_collaborators[] Array No

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

tickets[].additional_collaborators[].email String No
tickets[].additional_collaborators[].name String No
tickets[].brand_id Integer No

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

tickets[].macro_ids[] Array No

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

tickets[].via_followup_source_id Integer No

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

tickets[].tags[] Array No

The array of tags applied to this ticket

tickets[].group_id Integer No

The group this ticket is assigned to

tickets[].submitter_id Integer No

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

tickets[].raw_subject String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.