Identify people

You need to identify a person using a mobile device before you can send them messages or track events for things they do in your app. You need the CioDataPipelines package to identify people.

Identify a person

Identifying a person:

  1. Adds or updates the person in your workspace. This is basically the same as an identify call to our server-side API.
  2. Saves the person’s information on the device. Future calls to the SDK reference the identified person. For example, after you identify a person, any events that you track are automatically associated with that person.
  3. If you already registered a device token, identifying a person automatically associates the token with the identified person. You can register for a device token before or after you identify a person. See our Push Documentation for help registering device tokens.

You can only identify one customer at a time. The SDK “remembers” the most recently-identified customer. If you identify person A, and then call the identify function for person B, the SDK “forgets” person A and assumes that person B is the current app user. You can also stop identifying a person, which you might do when someone logs off or stops using your app for a significant period of time.

An identify request takes the following parameters:

  • userId (required): The unique value representing a person—an ID or email address that represents a person in Customer.io (and your downstream destinations).
  • traits (Optional): Contains attributesA key-value pair that you associate with a person or an object—like a person’s name, the date they were created in your workspace, or a company’s billing date etc. Use attributes to target people and personalize messages. Attributes are analogous to traits in Data Pipelines. that you want to set for a person. https://customer.io/docs/api/track/#operation/identify
import CioDataPipelines

CustomerIO.shared.identify(userId: "989388339", traits: ["first_name": firstName]) 

// `traits` accepts [String: Any] or an `Encodable` object 

// 1. [String: Any]:
let traits = ["first_name": "Dana", "last_name": "Green"]
CustomerIO.shared.identify(userId: "989388339", traits: traits)


// 2. `Encodable` object:
struct IdentifyRequestTraits: Encodable {
  let firstName: String
  let lastName: String 
}
CustomerIO.shared.identify(userId: "989388339", traits: IdentifyRequestTraits(firstName: "Dana", lastName: "Green"))

Update a person’s attributes

You store information about a person in Customer.io as attributesA key-value pair that you associate with a person or an object—like a person’s name, the date they were created in your workspace, or a company’s billing date etc. Use attributes to target people and personalize messages. Attributes are analogous to traits in Data Pipelines.. When you call the identify() function, you can update a person’s attributes on the server-side.

If a person is already identified, and then updates their preferences, provides additional information about themselves, or performs other attribute-changing actions, you can update their attributes with profileAttributes.

CustomerIO.shared.profileAttributes = ["favorite_food": "pizza"]

You only need to pass the attributes that you want to create or modify to profileAttributes. For example, if you identify a new person with the attribute ["first_name": "Dana"], and then you call CustomerIO.shared.profileAttributes = ["favorite_food": "pizza"] after that, the person’s first_name attribute will still be Dana.

Device attributes

By default (if you don’t set .autoTrackDeviceAttributes(false) in your config), the SDK automatically collects a series of attributesA key-value pair that you associate with a person or an object—like a person’s name, the date they were created in your workspace, or a company’s billing date etc. Use attributes to target people and personalize messages. Attributes are analogous to traits in Data Pipelines. for each device. You can use these attributes in segmentsA group of people who match a series of conditions. People enter and exit the segment automatically when they match or stop matching conditions. and other campaign workflow conditions to target the device owner, just like you would use a person’s other attributes. You cannot, however, use device attributes to personalize messages with liquidA syntax that supports variables, letting you personalize messages for your audience. For example, if you want to reference a person’s first name, you might use the variable {{customer.first_name}}. yet.

Along with these attributes, we automatically set a last_used timestamp for each device indicating when the device owner was last identified, and the last_status of a push notification you sent to the device. You can also set your own custom device attributes. You’ll see a person’s devices and each device’s attributes when you go to Journeys > People > Select a person, and click Devices.

device attributes on a person's profile
device attributes on a person's profile

 Your source shows device attributes in the context object

When you inspect calls from the SDK (the sourceA source is a website or server that you want to capture data from—it’s a source of data! in Data Pipelines), you’ll see device information in the context object. We flatten the device attributes that you send into your workspace/Journeys, so that they’re easier to use in segmentsA segment is a group of people in your audience that you want to target with campaigns, messages, etc. You can join groups of people manually, or by attribues and event data.. For example, context.network.cellular becomes network_cellular.

  • id string
    Required The device token.
    • _last_status string
      The delivery status of the last message sent to the device—sent, bounced, or suppressed. An empty string indicates that that the device hasn’t received a push yet.

      Accepted values:,bounced,sent,suppressed

    • app_version string
      The version of your app that a customer uses. You might target app versions to let people know when they need to update, or expose them to new features when they do.
    • cio_sdk_version string
      The version of the Customer.io SDK in the app.
    • device_locale string
      The four-letter IETF language code for the device. For example, en-MX (indicating an app in Spanish formatted for a user in Mexico) or es-ES (indicating an app in Spanish formatted for a user in Spain).
    • device_model string
      The model of the device a person uses.
    • device_os string
      The operating system, including the version, on the device.
    • network_bluetooth boolean
      If true, the device’s bluetooth connection is on.
    • network_cellular boolean
      If true, the device’s cellular connection is on.
    • network_wifi boolean
      If true, the device’s WiFi connection is on.
    • push_enabled string
      If "true", the device is opted-in and can receive push notifications.

      Accepted values:true,false

    • screen_height integer
      The height of the device’s screen in pixels.
    • screen_width integer
      The width of the device’s screen in pixels.
    • timezone string
      The timezone of the device.
    • Custom Device Attributes* string
      Custom properties that you want to associate with the device.
  • last_used integer  (unix timestamp)
    The timestamp when you last identified this device. If you don’t pass a timestamp when you add or update a device, we use the time of the request itself. Our SDKs identify a device when a person launches their app.
  • platform string
    Required The device/messaging platform.

    Accepted values:ios,android

Custom device attributes

When we collect device attributes, you can also set custom device attributes with the deviceAttributes method. You might do this to save app preferences, timezone, or other custom values specific to the device.

CustomerIO.shared.deviceAttributes = ["company" : "cio", "checklist" : "complete"]

However, before you set custom device attributes, consider whether the attribute is specific to the device or if it applies to the person broadly. Device tokens are ephemeral—they can change based on user behavior, like when a person uninstalls and reinstalls your app. If you want an attribute to persist beyond the life of the device, you should apply it to the person rather than the device.

Disable automatic device attribute collection

By default, the SDK automatically collects the device attributes defined above. You can change your config to prevent the SDK from automatically collecting these attributes.

import CioDataPipelines

let config = SDKConfigBuilder(cdpApiKey: "YOUR_CDP_API_KEY")
            .migrationSiteId("YOUR_SITE_ID")
            .autoTrackDeviceAttributes(false)

CustomerIO.initialize(withConfig: config.build()) 

Stop identifying a person

When a person logs out, or does something else to tell you that they no longer want to be tracked, you should stop identifying them.

Use clearIdentify() to stop identifying the previously identified person (if there was one).

// Future calls to the Customer.io SDK are anonymous 
CustomerIO.shared.clearIdentify()

Identify a different person

If you want to identify a new person—like when someone switches profiles on a streaming app, etc—you can simply call identify() for the new person. The new person then becomes the currently-identified person, with whom all new information—messages, events, etc—is associated.

Copied to clipboard!
  Contents
Current release
 3.3.0
Is this page helpful?
Chat with AI