Skip to main content
POST /v1/instances Creates a new WhatsApp instance. After creation, pair a phone number by scanning the QR code.

​
Request

​
Headers

HeaderValue
AuthorizationBearer <token>
Content-Typeapplication/json

​
Body

FieldTypeRequiredDescription
namestringYesA label for this instance
metadataobjectNoArbitrary key-value metadata
{
  "name": "sales-team-a",
  "metadata": {
    "region": "us-east"
  }
}

​
Response 201

Returns the created instance object.
FieldTypeDescription
idstringUnique instance ID (inst_ prefix)
namestringInstance label
statusstringAlways CREATED on creation
metadataobjectProvided metadata
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp
{
  "id": "inst_abc123",
  "name": "sales-team-a",
  "status": "CREATED",
  "metadata": { "region": "us-east" },
  "created_at": "2026-03-01T10:00:00Z",
  "updated_at": "2026-03-01T10:00:00Z"
}

​
Errors

CodeDescription
400name is missing
401Missing or invalid token

​
Example

curl -X POST https://cawme.com/api/v1/instances \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "sales-team-a",
    "metadata": { "region": "us-east" }
  }'