discovery

Remove roster members

Remove customers from a Discovery campaign's roster at once: no later run interviews them, a conversation already started finishes, and past results stay. Refused on a campaign that is not active or paused or is a one-time campaign whose run has finished, or while its first run is still choosing its customers. Returns how many left.

post/api/v1/discovery/roster-members/remove

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/discovery/roster-members/remove
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

campaignIdstring required

The Discovery campaign's id, or its campaign key.

customerIdsstring[] required

The customers' ids (1–1000)

Response

Success.

changedinteger required

Customers who left.

Changes

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