Skip to main content
POST
cURL

Headers

X-CSRF-Token
string
required

Echoes the token from the current session. Required on every unsafe method.

Idempotency-Key
string
required
Required string length: 8 - 128
X-Operator-Reason
string
required

Why the change is being made. Carried as a header because almost every operations mutation needs one; the API refuses a change that requires a reason and did not get one.

Required string length: 1 - 400

Body

application/json
kind
enum<string>
required
Available options:
customer_export,
subscription_extend,
subscription_disable,
subscription_enable,
wallet_credit
targets
object[]
required
Required array length: 1 - 1000 elements
parameters
object

Response

Previewed

id
string<uuid>
required
kind
string
required
status
enum<string>
required
Available options:
previewing,
ready,
running,
completed,
failed,
cancelled
requestedBy
string<uuid>
required
reason
string
required
total
integer
required
succeeded
integer
required
failed
integer
required
skipped
integer
required
createdAt
string<date-time>
required
parameters
object
completedAt
string<date-time>