Track Segments

Add people to a manual segment

Add people to a manual segment by ID. You are limited to 1000 customer IDs per request.

This endpoint lets you add people to manual segments, but a segment must exist before you can add people to it. You can create and find manual segments using the App API.

When you call this API, you can pass an id_type query parameter determining the type of identifier you want to use, id, email, or cio_id; If you don't pass this parameter, it defaults to id. The request body always uses ids, even though it'll accept either IDs, emails, or cio_ids depending on the query parameter. Everybody in the payload must use the same kind of identifier; we'll ignore values in the ids array that don't match the id_type parameter.

NOTE: You cannot add people to data-driven segments using the API. See our documentation on segments for more information about segments.

post/api/v1/segments/{segment_id}/add_customers

Request body

idsstring[] required

The customer IDs you want to add to the segment. The type of value you pass in the array corresponds to the id_type query parameter—id, email, or cio_id. Entries in the array that don't match the id_type are ignored.

Response

A successful request returns an empty object response.

Changes

No recorded changes to this endpoint across all 1 revision of this API.