Customer.io
v1.0.0
OpenAPI 3.1.0

Make a single request

US region

Client Libraries
Shell Curl

Make a single request

​

This endpoint lets you create, update, or delete a single person or object—including managing relationships between objects and people.

An "object" is any kind of non-person entity that you want to associate with one or more people—like a company, an educational course that people signed up for, a product, etc.

Your request must be smaller than 32kb.

Body
application/json

    • Add or update a person.

      • action
        Discriminator
        enum
        const:  
        identify
        required

        Indicates that the operation will identify the item of the specified type.

        values
        • identify
      • identifiers
        required

        The person you want to perform an action for—one of id, email, phone, or cio_id. You cannot pass multiple identifiers. You can use email and phone only if they're enabled as identifiers in your workspace settings.

      • type
        enum
        const:  
        person
        required

        The operation modifies a person in Customer.io

        values
        • person
      • attributes
        Type: object

        Attributes that you want to add or update for this person. You can pass properties that aren't defined below to set custom attributes; the defined properties are reserved in the Customer.io Track API.

      • cio_relationships
        Type: array object[]

        Each object in the array represents a relationship you want to add to, or remove from, a person.

      • timestamp
        Type: integer

        The Unix timestamp for when the attribute update occurred. This can be used to control the order of attribute updates when multiple requests are sent in rapid succession.

Responses
  • 200

    A successful request returns an empty object response.

  • application/json
  • 401

    Unauthorized request. Make sure that you provided the right credentials.

Request Example for post/api/v2/entity
{
  "action": "identify",
  "identifiers": {
    "id": "42"
  },
  "type": "person",
  "attributes": {
    "first_name": "Jane"
  }
}
No Body

A successful request returns an empty object response.