Profile operations

Set the account display name#

PUT /api/v1/channels/{channel_id}/profile/name

Token scope: manage. Paid access and a ready, customer-owned session are required. Supply an Idempotency-Key. Returns an operation ID; inspect /api/v1/operations/{id}. A completed result is recorded; an unconfirmed result is uncertain and never automatically retried.

Upstream permissions and engine support apply. Unsupported operations may return 501; WhatsApp can refuse actions even when a session is connected.

nameRequired

string

Maximum 25 characters. See JSON schema for all validation constraints.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 25
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

Set the account about/status text#

PUT /api/v1/channels/{channel_id}/profile/status

Token scope: manage. Paid access and a ready, customer-owned session are required. Supply an Idempotency-Key. Returns an operation ID; inspect /api/v1/operations/{id}. A completed result is recorded; an unconfirmed result is uncertain and never automatically retried.

Upstream permissions and engine support apply. Unsupported operations may return 501; WhatsApp can refuse actions even when a session is connected.

statusRequired

string

Maximum 139 characters. See JSON schema for all validation constraints.

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "maxLength": 139
    }
  },
  "required": [
    "status"
  ],
  "additionalProperties": false
}

Set the account profile picture (URL or base64 image)#

PUT /api/v1/channels/{channel_id}/profile/picture

Token scope: manage. Paid access and a ready, customer-owned session are required. Supply an Idempotency-Key. Returns an operation ID; inspect /api/v1/operations/{id}. A completed result is recorded; an unconfirmed result is uncertain and never automatically retried.

Upstream permissions and engine support apply. Unsupported operations may return 501; WhatsApp can refuse actions even when a session is connected.

urlOptional

string

Maximum 2048 characters. See JSON schema for all validation constraints.

base64Optional

string

Maximum 1400000 characters. See JSON schema for all validation constraints.

mimetypeOptional

string

Maximum 4096 characters. See JSON schema for all validation constraints.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 2048
    },
    "base64": {
      "type": "string",
      "maxLength": 1400000,
      "pattern": "^[A-Za-z0-9+/]+={0,2}$"
    },
    "mimetype": {
      "type": "string",
      "maxLength": 4096
    }
  },
  "additionalProperties": false,
  "required": []
}

Remove the account's profile picture#

DELETE /api/v1/channels/{channel_id}/profile/picture

Token scope: manage. Paid access and a ready, customer-owned session are required. Supply an Idempotency-Key. Returns an operation ID; inspect /api/v1/operations/{id}. A completed result is recorded; an unconfirmed result is uncertain and never automatically retried.

Upstream permissions and engine support apply. Unsupported operations may return 501; WhatsApp can refuse actions even when a session is connected.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "required": []
}