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

Request headers

Request body fields

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.