Skip to main content
POST
Issue a BYOD activation code
  • Credential: an API key.
  • Account: a direct account needs a free BYOD slot. A wholesale partner needs none. See BYOD slots.
  • Line-scoped keys: the list of lines of a line-scoped key is not applied.
  • Test keys: a code issued with an isnap_test_ account key creates a real line: see Test keys.
  • Idempotency-Key: not honored. A repeated call issues another activation code. See Operations that honor the key.
  • Events: none. line.connected is sent when the user completes the pairing in the bridge app: see Pairing a device.
  • Secret: activation_code is a credential: see The activation code is a credential. The response carries Cache-Control: no-store, whatever its status.

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.

Body

application/json

Metadata for the line that the pairing creates. The body accepts no other key.

metadata
object

Your metadata for the line that this pairing creates. It is copied onto the line, returned on every read of that line, and sent as data.metadata on its line.* events. At most 20 keys and 8,192 bytes once serialized as JSON.

Example:

Response

The activation code and the download links of the bridge app.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

An activation code and the download links of the bridge app.

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.