WhatsApp Gateway
API referenceAdmin

Start a session data backfill (super_admin)

POST
/api/v1/admin/sessions/{session}:backfill

Start one in-memory backfill job for a single session.

The job fetches contacts and joined group metadata/members. Chat history is not pulled by backfill.

Returns 202 Accepted with job state. Poll GET /admin/sessions/{session}/backfill for progress.

Only one backfill can run per session; existing in-flight jobs return conflict (409).

Requires platform super_admin login JWT. Api-keys and org roles are rejected with forbidden (403).

Errors: not_found (404), conflict (409), not_implemented (501).

Authorization

AuthorizationBearer <token>

Send Authorization: Bearer <token>. The token can be a login JWT from the frontend or an api-key for a script. JWT access comes from the person's organization role. Api-key access comes from the permissions saved on the key.

In: header

Path Parameters

session*string

Session ID. As super_admin this may belong to any organization.

Example"01HZX9Q2K7"

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/admin/sessions/01HZX9Q2K7:backfill"
{  "contacts": 128,  "error": "session not connected",  "finishedAt": 1719662460000,  "groupMembers": 342,  "groups": 14,  "id": "01J9...",  "organizationId": "org_01J9ABC...",  "sessionId": "01J9ZX8K2QHV0M3T6R7P4N5W8C",  "startedAt": 1719662400000,  "status": "succeeded"}
{  "error": {    "code": "not_found",    "details": {      "property1": null,      "property2": null    },    "message": "session not found"  }}