WhatsApp API Platform
Agent Assignments

Unassign specific agents from a customer

PATCH
/api/v1/agents/unassign

Removes the listed agents from a customer's assignments. Agents not currently assigned are silently ignored — the response reports only the agents actually removed.

Authorization

ApiKeyAuth
X-API-Key<token>

API key from your dashboard (Settings > API Keys)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://loading/api/v1/agents/unassign" \  -H "Content-Type: application/json" \  -d '{    "customer": "919876543210",    "agentIds": [      "agt_abc123"    ]  }'
{
  "success": true,
  "data": {
    "removed_count": 0,
    "removed_agent_ids": [
      "string"
    ]
  }
}
{
  "success": false,
  "message": "to field is required"
}
{
  "success": false,
  "message": "user not authenticated"
}
{
  "success": false,
  "message": "forbidden"
}
{
  "success": false,
  "message": "customer not found"
}
{
  "success": false,
  "message": "internal server error"
}

Replace the full agent set for a customer PUT

Sets the customer's assigned agents to exactly the provided list. The server diffs against the current set and applies the necessary adds and removes in one call. Pass an empty `agentIds` array to clear all assignments. Returns three lists: `added`, `removed`, and `unchanged`.

Get your account overview GET

One call for everything that describes the calling account: profile details, the active plan and subscription, the default WhatsApp number (including its last-synced Meta business profile), and the wallet balance. Useful as a startup call — it saves fanning out to the plan, WABA, and wallet endpoints separately. `wallet.balance` is in **major currency units** (rupees, not paise) — unlike the agent wallet endpoint, which reports the raw fixed-point integer. `active_plan`, `active_subscription`, and `default_waba` are omitted when the account has none.