Skip to main content
PUT
Set the business username

Authorizations

Authorization
string
header
required

Your API key, e.g. sk_live_... or sk_test_....

Headers

Idempotency-Key
string

Optional. Makes this write safe to retry: the same key replays the first response instead of acting twice.

Maximum string length: 255

Path Parameters

connection
string<uuid>
required

The connection uuid.

Body

application/json
username
string
required
Required string length: 3 - 35
Example:

"acme.store"

move_from_other_number
boolean
default:false

Take the name from another number in the same business portfolio (Meta's transfer_action: force_transfer).

Response

Saved at Meta.

connection_uuid
string<uuid>
username
string | null
Example:

"acme.store"

status
string | null

Meta's status: approved (customers see it) or reserved (yours, shown once Meta turns usernames on for customers).

Example:

"reserved"