API ReferenceSmart Lists

Batch-remove members from all Smart Lists

Marks matching contacts removed from every active Smart List in the credential's workspace without scanning another tenant.

Authentication

AuthorizationBearer

Workspace API key created in Sailor Settings > Integrations > API access.

Headers

Idempotency-KeystringRequired8-255 characters
Unique retry key retained for 86400 seconds. Reusing it with different request data is rejected.

Request

This endpoint expects an object.
memberslist of objectsRequired
reasonstringOptional1-240 characters

Response headers

X-Request-IdstringOptional
Stable request identifier for support and observability.
RateLimit-PolicystringOptional
Versioned structured quota policy. The syntax follows IETF RateLimit draft 11 and may evolve before standardization.
RateLimitstringOptional
Current structured quota state for the authenticated credential.
Idempotent-ReplayedstringOptional
True when this exact response was replayed from a completed idempotency record.

Response

Batch processed.
oktrue
skippedinteger0-9007199254740991
unmatchedinteger0-9007199254740991
insertedintegerOptional0-9007199254740991
removedintegerOptional0-9007199254740991

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
413
Content Too Large Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
503
Service Unavailable Error