POST /api/v2/custom_objects/{custom_object_key}/jobs

Queues a background job to perform bulk actions on up to 100 custom object records per single request. Takes a job object with two nested fields:

action, one of:
- "create"
- "delete"
- "delete_by_external_id"
- "create_or_update_by_external_id"
- "create_or_update_by_name"
- "update"
items
- For a "create" action, an array of JSON objects representing the custom object records being created
- For a "delete" action, an array of strings representing Zendesk record ids
- For a "delete_by_external_id" action, an array of strings representing external ids
- For a "create_or_update_by_external_id" action, an array of JSON objects representing the custom object records being created or updated by external id
- For a "create_or_update_by_name" action, an array of JSON objects representing the custom object records being created or updated by name. The is_unique property on the custom object's name field must be enabled.
- For an "update" action, an array of JSON objects representing the custom object records being updated

Note: If autonumbering is selected for the custom object's name field, record names aren't allowed in the request body because they are generated automatically. If uniqueness is enabled, the record names must be unique.

Allowed For

Agents

Response

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.

Servers

https://{subdomain}.{domain}.com

Path parameters

Name	Type	Required	Description
`custom_object_key`	String	Yes	The key of a custom object

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
`job`	Object	No
`job.action`	String	No
`job.items[]`	Array	No	An array of record objects for job actions that create, update, or set. An array of strings for job actions that delete.
`job.items[].created_by_user_id`	String	No	Id of a user who created the object
`job.items[].custom_object_fields`	Object	No
`job.items[].id`	String	No	Automatically assigned upon creation
`job.items[].external_id`	String	No	An id you can use to link custom object records to external data
`job.items[].name`	String	Yes	User-defined display name for the object. If autonumbering is selected for the custom object's name field, the name isn't allowed because it's automatically generated. If uniqueness is enabled, the name must be unique.
`job.items[].url`	String	No	Direct link to the specific custom object
`job.items[].custom_object_key`	String	No	A user-defined unique identifier
`job.items[].created_at`	String	No	The time the object was created
`job.items[].updated_at`	String	No	The time of the last update of the object
`job.items[].updated_by_user_id`	String	No	Id of the last user who updated the object

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.