Create Or Update Many Users

POST {{baseUrl}}/api/v2/users/create_or_update_many

Accepts an array of up to 100 user objects. For each user, the user is created if it does not already exist, or the existing user is updated.

Each individual user object can identify an existing user by email or by external_id.

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.

Allowed For

  • Agents, with restrictions on certain actions

Request Body

{"users"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;job_status&quot;:{&quot;id&quot;:&quot;82de0b044094f0c67893ac9fe64f1a99&quot;,&quot;message&quot;:&quot;Completed at 2018-03-08 10:07:04 +0000&quot;,&quot;progress&quot;:2,&quot;results&quot;:[{&quot;action&quot;:&quot;update&quot;,&quot;id&quot;:244,&quot;status&quot;:&quot;Updated&quot;,&quot;success&quot;:true},{&quot;action&quot;:&quot;update&quot;,&quot;id&quot;:245,&quot;status&quot;:&quot;Updated&quot;,&quot;success&quot;:true}],&quot;status&quot;:&quot;completed&quot;,&quot;total&quot;:2,&quot;url&quot;:&quot;https://example.zendesk.com/api/v2/job_statuses/82de0b0467893ac9fe64f1a99.json&quot;}}