Skip to main content
PATCH
Connect Telnyx or update phone capabilities

Authorizations

Authorization
string
header
required

A Contact Button scoped bearer key. Send Authorization: Bearer <token>. Token abilities are enforced independently of workspace membership; both checks must pass. OAuth 2.0 authorization-code flows are not currently available.

Headers

Idempotency-Key
string

Stable 8–120 character key for safe mutation retries.

Required string length: 8 - 120

Path Parameters

workspace
string<uuid>
required

Body

application/json

Initial setup requires both credentials. Omit saved credentials on later capability updates.

api_key
string
write-only

Telnyx API V2 key. Keep this out of model context and logs.

Required string length: 20 - 500
webhook_public_key
string
write-only

Telnyx account Ed25519 public key used to verify webhook signatures.

Required string length: 32 - 2000
inbound_calls
boolean
call_forwarding
boolean
outbound_calling
boolean
sms_lead_alerts
boolean
default_sms_sender
string

Required when SMS lead alerts are enabled.

Pattern: ^\+[1-9][0-9]{7,14}$

Response

Successful data envelope.

data
any
required
meta
object
required