Set business username

Claim or transfer a WhatsApp Business username for the account.

Username rules: 3-35 characters, letters/digits/period/underscore only, must contain at least one letter, no leading or trailing periods, no consecutive periods, no www prefix, no domain TLD suffix (e.g. .com).

If the desired username is currently held by another account, pass transferAction: "force_transfer" to request a transfer. On failure the API returns a standard error envelope with one of these codes: whatsapp_username_unavailable (already taken and transfer not requested), whatsapp_username_ineligible (account not eligible to claim a username), or whatsapp_username_transfer_required (username is held elsewhere; retry with force_transfer).

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Request Body

accountIdstring

WhatsApp social account ID

usernamestring

Desired username. Letters, digits, period, and underscore only. Must contain at least one letter. No leading, trailing, or consecutive periods. No www prefix. No domain TLD suffix.

Length3 <= length <= 35

transferAction?string

Pass force_transfer to request a transfer if the username is held by another account

Default"none"

Value in"none" | "force_transfer"

Response Body

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.whatsapp.setWhatsappBusinessUsername({  body: {    accountId: 'account_abc123',    username: 'Example',  },});console.log(data);

{
  "success": true,
  "username": "mybusiness",
  "status": "approved"
}

Empty

{
  "error": "Unauthorized"
}

Empty

Set business username

Claim or transfer a WhatsApp Business username for the account.

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Request Body

accountIdstring

WhatsApp social account ID

usernamestring

Desired username. Letters, digits, period, and underscore only. Must contain at least one letter. No leading, trailing, or consecutive periods. No www prefix. No domain TLD suffix.

Length3 <= length <= 35

transferAction?string

Pass force_transfer to request a transfer if the username is held by another account

Default"none"

Value in"none" | "force_transfer"

Response Body

application/json

import Zernio from '@zernio/node';

const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });

const { data } = await zernio.whatsapp.setWhatsappBusinessUsername({
  body: {
    accountId: 'account_abc123',
    username: 'Example',
  },
});
console.log(data);

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.whatsapp.setWhatsappBusinessUsername({  body: {    accountId: 'account_abc123',    username: 'Example',  },});console.log(data);

{
  "success": true,
  "username": "mybusiness",
  "status": "approved"
}

Empty

{
  "error": "Unauthorized"
}

Empty

Set business username

Authorization

Request Body

Response Body

200application/json

400

401application/json

404

Set business username

Authorization

Request Body

Response Body

200application/json

400

401application/json

404

application/json

application/json

application/json

application/json