POST /objects/{object_type}/batch/upsert
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 object record upsert request
- This is coherent with schema limitation: an object cannot have more than 10 associations with other objects. and each object record can be linked to max 10 other records. 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".
Servers
- https://api.brevo.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
object_type |
String | Yes |
object type for the attribute |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
records[] |
Array | Yes |
List of object records to be upsert. Each record can have attributes, identifiers, and associations. |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.