Send multiple requests

This endpoint lets you batch requests for different people and objects in a single request. Each object in your array represents an individual "entity" operation—it represents a change for a person, an object, or a delivery.

You can mix types in this request; you are not limited to a batch containing only objects or only people. An "object" is a non-person entity that you want to associate with one or more people—like a company, an educational course that people enroll in, etc.

Your batch request must be smaller than 500kb. Each of the requests within the batch must also be 32kb or smaller.

post/api/v2/batch

Request body

Example request

{
  "batch": [
    {
      "type": "person",
      "identifiers": {
        "id": "42"
      },
      "action": "identify",
      "attributes": {
        "first_name": "Jane",
        "last_name": "Doe",
        "plan": "premium"
      }
    },
    {
      "type": "object",
      "identifiers": {
        "object_type_id": "1",
        "object_id": "acme"
      },
      "action": "identify",
      "attributes": {
        "name": "Acme Corp",
        "plan": "enterprise",
        "seats": 50
      }
    },
    {
      "type": "object",
      "identifiers": {
        "object_type_id": "1",
        "object_id": "acme"
      },
      "action": "add_relationships",
      "cio_relationships": [
        {
          "identifiers": {
            "id": "42"
          },
          "relationship_attributes": {
            "role": "admin"
          }
        }
      ]
    }
  ]
}

Response

A successful request returns an empty object response.

Changes

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