POpostproxy
WhatsApp

Set the username

Claims a wa.me username for the number.

put/api/profiles/{profile_id}/whatsapp/set_username

Request

  • Base URL
    https://api.postproxy.dev
  • URL
    https://api.postproxy.dev/api/profiles/{profile_id}/whatsapp/set_username
  • Auth
    HTTP bearer

Query parameters

profile_group_idstring

Profile group context for the request. Optional when the API key is scoped to a profile group (that group is used automatically); with a full-access key, defaults to the first profile group in the account.

phone_number_idstring required

Phone number id — the placement id from GET /api/profiles/:id/placements

usernamestring required

Letters, digits, periods and underscores; must contain a letter; no leading, trailing or consecutive periods

transfer_action'none' | 'force_transfer'

none (default), or force_transfer to move a username the same business holds on another number

Response

The username was set.

usernamestring nullable
statusstring

Meta’s status lowercased — e.g. approved, reserved, pending, or none when the number has no username.

placement_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.