Instances

Set the account profile picture

Updates the connected WhatsApp account's own profile photo. The image must be a base64-encoded JPEG; it replaces the current picture and returns the new picture ID.

POST
/profile/picture

Updates the connected WhatsApp account's own profile photo. The image must be a base64-encoded JPEG; it replaces the current picture and returns the new picture ID.

Authorization

bearerAuth
AuthorizationBearer <token>

Per-user API token (UUID v4) sent as Authorization: Bearer <token>. Identifies the tenant and user.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Payload for setting the account's own profile picture.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/profile/picture" \  -H "Content-Type: application/json" \  -d '{    "image_base64": "/9j/4AAQSkZJRgABAQAAAQABAAD..."  }'
{  "success": true,  "picture_id": "1718000000"}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}

Log out the instance POST

Performs a full logout: clears the stored WhatsApp credentials and removes the companion device server-side. Unlike POST /disconnect (which only drops the socket and keeps credentials), the instance must be re-paired (QR or pairing code) before it can connect again. Requires a live connection.

Create, edit, or delete a label PUT

Creates, renames, recolors, or deletes a label for the connected account via a WhatsApp app-state patch. Set deleted=true to remove the label.