Skip to navigation

Execute an idempotent WhatsApp management operation

View as Markdown

Required scope is full, or an admin/owner dashboard session. Only cataloged provider POST and DELETE operations are accepted. Reuse the same Idempotency-Key with identical inputs to retrieve a confirmed successful receipt without another provider write. A changed payload conflicts. Pending, unknown and rejected attempts never automatically dispatch again. After a timeout, inspect the receipt and provider resource before creating a new intent. Local synchronization failures are reported separately from confirmed provider success.

Authentication

AuthorizationBearer

Workspace API key: jl_ followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (Settings → API Keys) and sent as Authorization: Bearer jl_.... The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys.

ScopeGET / HEADPOST / PUT / PATCH / DELETEAdmin-only routes
readYesNoNo
writeYesYesNo
fullYesYesYes

Operations restricted to admins or owners reject keys without the full scope with 403, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See Authentication.

Path parameters

accountIdstringRequiredformat: "uuid"

Local connected-account UUID belonging to the authenticated workspace.

operationstringRequiredformat: "^[a-z_]+\.[a-z_]+$"<=100 characters
Exact operation key returned by the capabilities catalog, such as waba.read or template.update.

Headers

Idempotency-KeystringRequiredformat: "^[A-Za-z0-9_.:-]+$"8-200 characters

Request

This endpoint expects an object.
resourceIdstringOptionalformat: "^\d{3,32}$"

Meta child-node ID. WABA operations derive the WABA ID from the connected local account.

parametersmap from strings to anyOptionalDefaults to {}

Operation-specific fields validated against the capability catalog. Maximum serialized size is 256000 bytes.

Response

Existing successful receipt replayed without a second provider write.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error