Skip to main content
POST
Activate a reserved line
  • Credential: an API key. See Activation.
  • Account: wholesale partners only: any other account receives 402 checkout_required. A direct account buys a line in the iSnap dashboard: see Accounts.
  • Line-scoped keys: a line-scoped key gets 403 forbidden unless the line is in its list.
  • Test keys: an activation sent with an isnap_test_ account key activates a real line, billed like any other: see Test keys.
  • Idempotency-Key: not honored. After a lost response, read GET /v1/lines/my before you call again: see Retries.
  • Events: none. See Events.

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

id
string
required

Id of a line: line_ followed by 25 letters or digits.

Pattern: ^line_[0-9A-Za-z]{25}$

Body

application/json

Optional settings of the activated line: its variant and its billing anchor.

inbound_only
boolean

true to activate the line as an inbound-only line. Rented lines only (400 inbound_only_not_rental otherwise). Defaults to false: a two-way line.

billing_anchor_at
string<date-time>

The billing anchor of the line: an ISO 8601 timestamp in UTC, with a Z suffix. A line billed on the monthly wholesale invoice is charged one full month at each monthly occurrence of this timestamp: the same day of the month, moved to the last day of a shorter month, at the same time of day. At the first occurrence after its activation, the line is also credited for the days that the month charged at activation had already paid for past that occurrence. Omit it to bill the line at each monthly occurrence of its activation. A past timestamp is accepted. A timestamp more than 31 days after the request returns 400 billing_anchor_too_far.

Example:

"2026-09-11T09:15:00Z"

Response

The activated line.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

A line. billing_tier, byod, shared, test_line and inbound_only tell the kinds of line apart: a rented line (two-way or inbound-only), a BYOD line, a shared line, a test line.

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.