Skip to main content
POST
Pick a rep from a pool and advance the rotation

Authorizations

x-api-key
string
header
required

API key from Settings > API Keys or POST /v1/api-keys. Format f9_live_<32 hex chars> (live) or f9_test_<32 hex chars> (sandbox — no real sends, ever). Legacy wcrm_live_ / wcrm_test_ keys still authenticate but are no longer issued. Shown once at creation; only a hash is stored.

Path Parameters

id
string<uuid>
required

Body

application/json
policy_id
string<uuid>
at
string<date-time>

Evaluate availability at this instant; defaults to now.

exclude_users
string<uuid>[]
must_include_tags
string<uuid>[]

Response

Rep assigned

success
enum<boolean>
Available options:
true
data
object
meta
object