Sign in

v4

latestOpenAPI 3.0.12026-07-131437115.1 KB
Batch

Create a batch of users

Create multiple users in a single request by providing a batch of user properties and associations. This endpoint returns the created users along with their IDs.

post/crm/objects/2026-09/{objectType}/batch/create

Path parameters

objectTypestring required

Object type.

Request body

Response

successful operation

completedAtstring date-time required

The timestamp when the batch processing was completed, in ISO 8601 format.

linksobject

An object containing relevant links related to the batch request.

numErrorsinteger

The total number of errors that occurred during the batch operation.

requestedAtstring date-time

The timestamp when the batch request was initially made, in ISO 8601 format.

startedAtstring date-time required

The timestamp when the batch processing began, in ISO 8601 format.

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

The status of the batch processing request: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE"