---
title: "Set the username"
method: PUT
path: "/api/profiles/{profile_id}/whatsapp/set_username"
tags: ["WhatsApp"]
---

# Set the username

`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

Claims a wa.me username for the number.

## Query parameters

- `profile_group_id` string
- `phone_number_id` string, required
- `username` string, required
- `transfer_action` 'none' | 'force_transfer'

## Response `200`

The username was set.

- WhatsAppUsernameResponse
  - `username` string, nullable
  - `status` string: Meta’s status lowercased — e.g. approved, reserved, pending, or none when the number has no username.
  - `placement_id` string

## Other responses

- `400`: Missing required parameters.
- `401`: Invalid, missing, or insufficient API key permissions.
- `404`: Resource does not exist or is not accessible.
- `422`: Validation failed.

---

[API](https://skmtc.dev/postproxy/apis/postproxy-social-media-api.md) - [All operations](https://skmtc.dev/postproxy/apis/postproxy-social-media-api/llms.txt) - [OpenAPI document](https://skmtc.dev/postproxy/apis/postproxy-social-media-api/revisions/d54482ac4ce7?raw)
