Skip to main content
PATCH
Update the metadata of 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. See Operations that honor the key.
  • Events: none. The call works in every status, revoked included.
  • Personal data: paired_handle, the prospect’s phone number or the email address of their Apple ID. Request it only when needed, do not copy it into logs, tickets or other tools, and refer to a prospect by an id of your own.
  • Body: required. It has one field, metadata, and is sent with Content-Type: application/json. The merge rules are in Metadata.

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

Metadata to merge into the metadata of a trial.

metadata
object
required

Keys to merge into the metadata of the trial. A key with a value is set, and a key with null is deleted. At most 20 keys and 8,192 bytes once serialized as JSON.

Example:

Response

The trial, with its metadata after the merge.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

A trial, as the account that started it reads it.

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.