ATattentive
Segments

Clear all members from a segment

Changed on

Removes all members from a segment identified by its external ID. This operation is asynchronous — the response indicates that the clear request has been accepted for processing.

Only segments created via the Public API can be cleared using this endpoint.

Scopes Required: [segments:Write]

Default Rate Limit: 100 requests per second

post/v2/segments/external/{externalId}/clear-segment

Request

  • Base URL
    https://api.attentivemobile.com
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://ui-devel.attentivemobile.com/integrations/oauth-install?client_id={clientId}&redirect_uri={redirectUri}&scope={scope}
      Token URL: https://api.attentivemobile.com/v1/authorization-codes/tokens scopes: segments:write

Path parameters

externalIdstring required

External ID of the segment whose members should be cleared

Response

Clear members request accepted for asynchronous processing

status'ACCEPTED'

The status of the request. ACCEPTED indicates the clear members request was received and will be processed asynchronously.

messagestring

A human-readable message about the request status

Example response

{
  "status": "ACCEPTED",
  "message": "Clear members request accepted for processing"
}

Changes