discovery

Replace roster members

Replace one customer on a Discovery campaign's roster with another in one step: the first leaves at once and the replacement joins this month's calendar. Refused on a campaign that is not active or paused or is a one-time campaign whose run has finished, when the first is not on the roster, the replacement already is or cannot join, or while the campaign's first run is still choosing its customers. Returns when the replacement starts.

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

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/discovery/roster-members/replace
  • 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.

fromCustomerIdstring uuid required

The customer who leaves.

toCustomerIdstring uuid required

The customer who joins in their place.

Response

Success.

changedinteger required

Changes

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