POST /api/v1/segments/{segment_id}/remove_customers
You can remove users from a manual segment by ID. You are limited to 1000 customer IDs per request.
This endpoint requires people to have id attributes. If your workspace does not use id as an identifier, or you have not assigned people id values, you cannot remove people from manual segments using the API. Our user interface does not have this limitation. You can remove people from manual segments through the UI as a part of a campaign workflow.
NOTE: You cannot remove people from data-driven segments using the API. See our documentation on segments for more information about segments.
Servers
- https://track.customer.io
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
segment_id |
Integer | Yes |
The identifier for a segment. You can find your segment's ID on its page in the dashboard—go to Segments, select your segment, and find the ID under Usage. Or you can find your segment using the App API. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
id_type |
String | No |
The type of Possible values:
Default value: "id" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
ids[] |
Array | Yes |
The customer IDs you want to remove from the segment. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.