Обновление бизнес-имени пользователя

POST

/v1/apps/{appId}/wa/username

Данный эндпоинт API предназначен для обновления или установки уникального бизнес-имени (username) приложения WhatsApp Business. Бизнес-имя позволяет пользователям находить ваш бизнес в WhatsApp по короткому имени.

Авторизация

Для доступа к методу необходим токен системного пользователя. Передайте его в заголовке HTTP-запроса.

Authorization: Bearer <ACCESS_TOKEN>

Параметры

Параметр	Расположение	Тип	Обязательный	Описание
appId	Path	string	Да	Уникальный идентификатор приложения.
username	Body	string	Да	Уникальное бизнес-имя. Может содержать только буквы латинского алфавита, цифры и знак подчёркивания. Минимум 3 символа, максимум 30.
transfer_action	Body	string	Да	Действие по переносу бизнес-имени. Возможные значения: NONE — FORCE_TRANSFER —

Правила для бизнес-имени

• Минимальная длина: 3 символа
• Максимальная длина: 30 символов
• Разрешённые символы: латинские буквы (a-z, A-Z), цифры (0-9), знак подчёркивания (_)
• Имя должно быть уникальным в системе WhatsApp Business
• Имя не может содержать пробелы или специальные символы

Примеры запросов

Установка нового бизнес-имени

curl -X POST \
  https://space.getloo.ru/api/v1/apps/{appId}/wa/username \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "mybusiness",
    "transfer_action": "NONE"
  }'

{
  "username": "mybusiness",
  "transfer_action": "NONE"
}

Пример ответа

Успешное обновление

{
  "status": "RESERVED"
}

Ошибка - некорректный формат

{
  "message": "Username format invalid",
  "code": "USERNAME_FORMAT_INVALID",
  "status_code": 424,
  "timestamp": 1787837773
}

Ошибка - имя недоступно

{
  "message": "Username not available",
  "code": "USERNAME_NOT_AVAILABLE",
  "status_code": 424,
  "timestamp": 1787838044
}

Параметры ответа

Успешный ответ

Параметр	Тип	Описание
status	string	Статус бизнес-имени. Возможные значения: SUCCESS — успешно установлено APPROVED — одобрено RESERVED — зарезервировано

Ответ с ошибкой (424)

Параметр	Тип	Описание
message	string	Сообщение об ошибке.
code	string	Код ошибки. Возможные значения: USERNAME_FORMAT_INVALID — некорректный формат имени USERNAME_NOT_AVAILABLE — имя недоступно
status_code	number	HTTP статус-код ошибки (424).
timestamp	number	Временная метка ошибки в Unix time. Например, 1787837773 соответствует 2026-08-27 12:42:53 UTC.

Коды состояния

Код состояния	Описание
200	Запрос успешно выполнен
400	Некорректный запрос (ошибка при валидации)
401	Неавторизованный запрос
403	Доступ запрещён
404	Не найдено
424	Зависимость не выполнена