JUjumpcloud
Bulk Job Requests

Bulk Users Update

The endpoint allows you to create a bulk job to asynchronously update users. See Update a System User for full list of attributes.

Sample Request

curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '[
	{
	  "id":"5be9fb4ddb01290001e85109",
		"firstname":"{UPDATED_FIRSTNAME}",
		"department":"{UPDATED_DEPARTMENT}",
		"attributes":[
			{"name":"Custom","value":"{ATTRIBUTE_VALUE}"}
		]
	},
	{
	  "id":"5be9fb4ddb01290001e85109",
		"firstname":"{UPDATED_FIRSTNAME}",
		"costCenter":"{UPDATED_COST_CENTER}",
		"phoneNumbers":[
			{"type":"home","number":"{HOME_PHONE_NUMBER}"},
			{"type":"work","number":"{WORK_PHONE_NUMBER}"}
		]
	}
]
patch/api/v2/bulk/users

Request

Query parameters

suppressEmailboolean

An option indicating whether to suppress the job results email that will otherwise be sent to the Administrator who created the job. If true, the email won't be sent. If omitted or false, the email will be sent.

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Request body

attributesobject[]

Map of additional attributes.

emailstring
firstnamestring
idstring

Object ID of the user being updated

organizationstring

Organization object id of the user

lastnamestring
usernamestring

Response

jobIdstring

Changes

No recorded changes to this operation across all 1 revision of this API.