Customer.io Track API

Add or update a device for a customer profile. Use this tool to add or update iOS and Android devices linked to a customer's profile. Ideal for managing multiple devices associated with a customer. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Add people to a manual segment by ID. This tool adds people to a pre-existing manual segment using customer identifiers. It supports up to 1000 customer IDs per request, using identifiers like `id`, `email`, or `cio_id` based on the `id_type` query parameter. Note that this is limited to manual segments, not data-driven ones. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Batch process requests for people and object entities. This tool allows batching of multiple requests involving people and object entities into a single operation. Useful for applying changes to various entities simultaneously, such as associating objects with people. Ensure request size limits are observed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Delete a customer and all associated information. This tool deletes a customer and their information from Customer.io. It should be called when you want to completely remove a customer from the database. Note: After deletion, customers may be accidentally recreated if new data is sent through other means.

Retrieve the region and URL for Track API credentials. Use this tool to find the appropriate region and URL necessary for Track API requests. It also provides the environment ID representing the workspace for which the credentials are valid. This is essential for setting up correct API calls.

Set a user's global unsubscribe status in Customer.io. Use this tool to set a person's global unsubscribe status to true in Customer.io, attributed to a specific email delivery. Ideal when managing unsubscribe actions outside the default subscription pathways. It helps in segmenting audiences based on unsubscribe actions. Note: For custom subscription centers, additional requests are needed to manage custom attributes.

Create, update, or delete entities and manage relationships. Use this tool to manage people or objects, including associating them with other entities. Useful for handling companies, courses, products, and more. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Merge two customer profiles into one primary profile. Use this tool to merge two customer profiles. The primary profile remains and the secondary is deleted. Ensure the primary profile exists in Customer.io before calling this tool. The merge includes unfilled attributes, recent events, segments, and campaign journeys from the secondary to the primary. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Remove a device from a customer's profile. This tool removes a specified device from a customer's profile in Customer.io. It should be called when you need to ensure a device is detached from a customer's profile to prevent re-adding it accidentally.

Remove users from a manual segment by ID. Use this tool to remove users from a manual segment by specifying their IDs. Note that this functionality requires each user to have an 'id' attribute, and cannot be used for data-driven segments. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Report metrics from non-native Customer.io channels. Use this tool to report metrics from channels not supported natively by Customer.io or those not using their SDKs. It is useful for tracking user interactions like clicks or conversions using the CIO-Delivery-ID as a UTM parameter. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Send an event associated with a customer by identifier. This tool sends an event tied to a specific customer, identified by a unique identifier. Events can be page views, screen views, or custom events. Use this tool to track customer interactions on websites or apps, ensuring events are associated with the correct customer profile. Reserved properties can override campaign settings if included. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Submit and record form responses with Customer.io. Use this tool to submit form responses to Customer.io. It creates or updates a form connection if the `form_id` is unfamiliar. Ensure `data` includes identifiers like `id` or `email` to recognize the respondent. Additional data fields map directly to user attributes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Permanently delete and suppress a customer profile. This tool deletes a customer profile and suppresses the person's identifier(s) to prevent future re-addition. Use mainly for GDPR/CCPA compliance. Once suppressed, the profile cannot be recovered. If suppression is not necessary, consider other subscription preference attributes.

Log anonymous events for unidentified users. Use this tool to log anonymous events for individuals who have not been identified yet. Events can be of type `page`, `screen`, or `event` and are useful for tracking website page views, app screen views, or other activities. Helps in associating events with users for triggering campaigns if merged later. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Unsuppress a customer profile in Customer.io. Use this tool to unsuppress a customer profile, making the identifier available again in Customer.io. This will not restore previous profile data, only make the identifier reusable.

Add or update a person's information in the database. Use this tool to add a new person or update existing person details based on identifiers. If no individual is found with the given identifiers, a new person is added. If existing identifiers match, the person's information is updated. For identifier updates, use `cio_id`. If identifiers conflict, the request may result in an Attribute Update Failure warning. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.