Skip to main content
POST /v1/projects/{id}/platforms/imessage/dedicated Claims one dedicated iMessage line for the project and enables iMessage on it. Always answers 202 with an operation: dedicated lines are allocated from available capacity, and unavailable capacity causes a wait rather than a failure — this can legitimately stay running for hours, which is exactly why the response is a handle to poll rather than a number. The project’s messaging subscription must grant the dedicated iMessage lines entitlement (imessage_dedicated_lines.can_purchase), and that is checked before capacity is reserved. The line’s own charge starts when a line is claimed; the subscription that grants the entitlement bills on its own terms, which cancelling a request does not change. Waiting requests are served first come, first served. One that is still waiting is cancelled with a reason if the project is deleted (project_deleted) or its plan stops selling dedicated lines (entitlement_lost); while the payer is restricted for overdue payment it keeps waiting. If you no longer want to wait, POST to the operation’s cancel endpoint, which charges nothing for the line. The Idempotency-Key is required and permanent: repeating it returns the same operation forever. A further line always needs a NEW key, including while others are still waiting. Requires the platforms:write permission bound to the project resource in the path.
TypeScript

Parameters

string
required
Identifies one logical mutation across retries.
string
required

Returns

202 The provision was accepted and is running. GET the Location after the Retry-After interval until state is terminal; the response there carries the line once one is claimed. Operation Headers: Location. The raw response carries these headers; see Raw responses.
boolean
required
string (date-time)
required
object
string (date-time)
OperationError
string
required
string
required
OperationReason
string
string
required
string (date-time)
OperationState
required
OperationType
required
string (date-time)
required