Skip to main content
POST
Revoke a trial
  • Credential: an API key of the account that owns the trial. A trial key returns 401 unauthorized.
  • Line-scoped keys: the list of lines of a line-scoped key is not applied.
  • Idempotency-Key: not honored. A repeated revoke is safe: it returns 200 with already_revoked: true. See Revoking a trial.
  • Events: sends trial.revoked. A repeated revoke, and a revoke of a trial that never paired and whose pairing window had already ended, send no event: see Events.
  • Limits: reason: rebind can be turned off or limited per rolling 24 hours: see Revoking a trial.

Errors

The errors that every operation shares are in Errors.

Authorizations

Authorization
string
header
required

An API key created in the iSnap dashboard, or a trial key, sent as Authorization: Bearer <key>. An API key starts with isnap_live_ or isnap_test_; both act on the same account, lines and billing. A trial key acts on its trial only.

Path Parameters

trial_id
string
required

Id of the trial, as returned in trial_id by POST /v1/trial/init: trl_ followed by 25 letters or digits.

Minimum string length: 1
Example:

"trl_4Lp8Rn2xY7wQ9mK3vB5nH8dF2"

Body

application/json

The reason of a revoke. The body is optional.

reason
enum<string>

partner (default): you end the trial. rebind: you end it so that the same prospect can start a new one; limited per account. admin: reserved for dashboard sessions, and refused with an API key (422 admin_reason_forbidden).

Available options:
rebind,
partner,
admin
Example:

"rebind"

Response

The trial is revoked, by this call or by an earlier one.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

The result of a revoke.

trace_id
string
required

Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap.

request_id
string
required

Id of the request that produced this response: req_ followed by 25 letters or digits.