Customer.io
v1.0.0
OpenAPI 3.1.0

Add or update a customer device

US region

Client Libraries
Shell Curl

Add or update a customer device

​

Customers can have more than one device. Use this method to add iOS and Android devices to, or update devices for, a customer profile.

Path Parameters
  • identifier
    required

    The unique value representing a person. The values you use to identify a person may be an id, email address, or the cio_id (when updating people), depending on your workspace settings. When you reference people by cio_id, you must prefix the value with cio_.

    You can't reference a person by their phone number here. We determine the identifier type from the shape of the value, so a phone number in the path is treated as an id. To identify people by phone number, use the Track v2 API.

    • Type: string · id

      The unique identifier for a person that you want to create or modify.

Body
application/json

Define the device you want to add to the customer profile.

  • device
    Type: object
    required

    Device properties collected by Customer.io SDKs unless autoTrackDeviceAttributes is disabled. You can use these properties in segments and Liquid.

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 put/api/v1/customers/{identifier}/devices
{
  "device": {
    "id": "",
    "platform": "ios",
    "attributes": {
      "app_identifier": "",
      "app_version": "",
      "cio_sdk_version": "",
      "device_locale": "",
      "device_model": "",
      "device_os": "",
      "push_enabled": "true",
      "Custom Device Attributes": ""
    },
    "last_used": 1
  }
}
No Body

A successful request returns an empty object response.