Create/Update object records in bulk
<Note title="Enterprise access only">Custom objects are only available to Enterprise plans.
This feature is in beta. These are subject to change.</Note>
This API allows bulk upsert of object records in a single request. Each object record may include
- Attributes
- Identifiers
- Associations
**Response:**
The API processes the request asynchronously and returns a processId that you can use to track the background process status.
**API and Schema Limitation:**
- Size:
- Max 1000 objects records per request
- Max request body size: 1 MB
- Max 500 attributes defined per object record upsert request
- This is coherent with schema limitation: an object cannot have more than 500 attributes.
- Worth noting: Nothing happens If an attribute is mentioned in the request, but was not previously defined for the object schema (no error, no attribute creation)
- Max 10 associations defined per associated object type, in each record of the request
- This is not a schema limitation. You can associate an object record to an unlimited number of other object records by running multiple requests.
**Errors:**
- Make sure both object records exist before associating them, else the API will return an error.
- This route does not create objects. The object where the object records are upserted by this API must be created already else the API will return an error "invalid object type".
Authentication
api-keystring
The API key should be passed in the request headers as api-key for authentication.
Path parameters
object_type
object type for the attribute
Request
Payload for batch upsert object records with associations
records
List of object records to be upsert. Each record can have attributes, identifiers, and associations.
Response
Batch request accepted for processing of upsert object records.
message
processId
Unique Id for the batch process used to track the status of the batch. How to use this processId: Refer to the Get process status API to check the execution status of this batch using the returned processId.