Set / adopt business username

Adopts or changes the business username for the app's WhatsApp phone number.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Sample Request:

curl --location 'https://partner.gupshup.io/partner/app/{{APP_ID}}/username' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=<USERNAME>' \
--data-urlencode 'transfer_action=none'

Sample Response:

{
  "status": "reserved"
}

KeyDescriptionValue
AuthorizationAccess token for the applicationsk_*****
Content-TypeRequest media typeapplication/x-www-form-urlencoded
APP_IDApp ID (path param)e.g. 04e6c66b-bb95-4bfc-b75e-4e7391ddc680
usernameDesired business usernamee.g. mybusiness
transfer_actionUsername transfer actionnone, force_transfer

Path Params
uuid
required

Application ID

Form Data

Form-urlencoded request body for setting / adopting the business username

string
required

Desired business username. Letters (a-z), digits (0-9), period (.), underscore (_); see Meta docs for full rules.

string
enum

Username transfer action. Defaults to none. Use force_transfer on Meta error 147005.

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json