Customer.io
v1.0.0
OpenAPI 3.1.0

Create objects and relationships

US region

Client Libraries
Shell Curl

Create objects and relationships

​

Group calls add people to a group. Groups could be a companies, accounts, online classes, and so on. How groups are represented in your destination depends on the destination. Some destinations have concepts of "groups"; Customer.io's destination calls groups "objects."

When you use our libraries, you'll typically only provide an ID for the user, the groupId, and traits. The libraries fill in the rest of the payload automatically.

Headers
  • X-Strict-Mode
    enum
    const:  
    1

    When set to 1, enables strict validation that returns proper HTTP error codes (400/401) for validation failures. When not set or set to any other value, the API operates in permissive mode, logging errors but returning HTTP 200. Learn more

    values
    • 1
Body
application/json
    • groupId
      Type: string
      required

      ID of the group

    • context

      A dictionary of context about a source call/event, like the user’s IP address or locale. Context is automatically collected by our source libraries.

      A dictionary of context about a source call/event, like the user’s IP address or locale. Context is automatically collected by our source libraries.

      • active
        Type: boolean

        Whether a user is active.

        This is usually used when you send an .identify() call to update the traits independently of when you've “last seen” a user.

      • campaign
        Type: object

        Contains information about the campaign that resulted in the API call, gathered from, or mapping to, UTM parameters (e.g. utm_source).

      • channel
        Type: string enum

        The channel the event originated from.

        values
        • browser
        • server
        • mobile
      • ip
        Type: string

        The user's IP address. This isn't captured by our libraries, but by our servers when we receive client-side events (like from our JavaScript source).

      • locale
        Type: string

        The locale string for the current user, e.g. en-US.

      • page
        Type: object

        Contains information about the current page in the browser. This is automatically collected by our JavaScript source.

      • userAgent
        Type: string

        The user agent of the device making the request

    • integrations
      Type: object

      Contains a list of booleans indicating the integrations that are enabled (true) or disabled (false). By default, all integrations are enabled (returning an empty object). Set "All": false to reverse this behavior.

    • messageId
      Type: string

      A unique identifier for a Data Pipelines call, ensuring that each individual event is unique. This is set by Customer.io

    • originalTimestamp
      Type: string Format: date-time

      In general, you can use timestamp rather than this field if you want to back-date events. This is the timestamp on the client device you invoke a call or the timestamp value you manually passed in a server-side library call.

    • sentAt
      Type: string Format: date-time

      The ISO-8601 timestamp when a library sends an event to Data Pipelines.

    • timestamp
      Type: string Format: date-time

      The ISO-8601 timestamp when the event originally took place. This is mostly useful when you backfill past events. If you're not backfilling data, you can leave this field empty and we'll use the current time or server time.

    • traits
      Type: object

      Additional information about the group.

    • userId
      Type: string

      The unique identifier for a person. This value should be unique across systems, so you recognize the same person in your sources and destinations.

Responses
  • 200

    A successful request returns an empty object response.

Request Example for post/group
{
  "groupId": "0e8c78ea9d97a7b8185e8632,",
  "context": {
    "ip": "8.8.8.8",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/40.0.2214.115 Safari/537.36"
  },
  "integrations": {
    "All": true,
    "Mixpanel": false,
    "Salesforce": false
  },
  "messageId": "022bb90c-bbac-11e4-8dfc-aa07a5b093db,",
  "sentAt": "2015-02-23T22:28:55.111Z,",
  "timestamp": "2015-02-23T22:28:55.111Z,",
  "traits": {
    "name": "ACME, Inc.",
    "industry": "Technology",
    "employees": 329,
    "plan": "enterprise",
    "total billed": 830
  },
  "userId": "97980cfea0067",
  "anonymousId": "507f191e810c19729de860ea,",
  "channel": "browser,"
}
No Body

A successful request returns an empty object response.