Create/Update object records in bulk

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".
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

Enterprise access only

  • Custom objects are only available to Enterprise plans.
  • This feature is in beta. These are subject to change.
Path Params
string
required

object type for the attribute

Body Params

Payload for batch upsert object records with associations

records
array
required
length between 1 and 1000

List of object records to be upsert. Each record can have attributes, identifiers, and associations.

records*
Responses

400

Bad request (e.g., invalid organization ID, invalid object_type, records cannot be empty or more than 1000)

403

Custom objects are not available on this account.

404

Object not found for the provided organization or object type

500

Internal server error

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json