For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
AcademyContact SalesHelp CenterDashboard
DocumentationAPI ReferenceIntegrationsAdministrationChangelog
DocumentationAPI ReferenceIntegrationsAdministrationChangelog
  • Get Started
    • Introduction
    • Authentication
  • Resources
    • Custom Variables
    • Dynamic Prompt Injection
    • Outbound Number Pooling
    • Timezones
  • Platform API
      • GETList phone numbers
      • GETGet a phone number
      • POSTImport phone number
      • PATCHUpdate a phone number
      • DELDelete a phone number
LogoLogo
AcademyContact SalesHelp CenterDashboard
Platform APIPhone Numbers

Update a phone number

||View as Markdown|
PATCH
/numbers/:phone_number_slug
PATCH
/v2/numbers/:phone_number_slug
$curl -X PATCH https://api.synthflow.ai/v2/numbers/33782990580 \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{
> "friendly_name": "My Updated Number"
>}'
1{
2 "status": "ok"
3}
Updates the configuration of a phone number.
Was this page helpful?
Previous

Delete a phone number

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

phone_number_slugstringRequired

The phone number slug (phone number without the leading +).

Request

This endpoint expects an object.
friendly_namestringOptional

A human-readable name for the phone number.

sip_auth_usernamestringOptional
SIP authentication username.
sip_outbound_proxystringOptional
SIP outbound proxy.
sip_term_uristringOptional
SIP termination URI.

Response

200
statusstring
Whether the request was successful.

Errors

400
Bad Request Error