Docs
Templates

Sync WhatsApp templates

POSThttps://api.norreach.app/v1/whatsapp-templates/sync

Reads the workspace's templates and their review states from WhatsApp again (the Sync button of Campaigns › Templates). Every changed review state fires template.status_changed. Owners, admins and managers. dry_run=true changes nothing.

templates:writeRole must allow: channels.templatesSupports dry_runOperation id: sync_whatsapp_templates
POST/whatsapp-templates/sync
curl -X POST "https://api.norreach.app/v1/whatsapp-templates/sync" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
Sync WhatsApp templates
{
  "object": "whatsapp_template_action",
  "action": "sync",
  "dry_run": false,
  "synced": 12,
  "template": null,
  "note": "Templates synced."
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope templates:write. API keys and scopes

Query parameters

dry_runbooleanquery

Run every check and return what would happen, changing nothing.

Headers

Idempotency-Keystringheader

Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.

Response

200application/json— Sync WhatsApp templates

object"whatsapp_template_action"required
actionenumrequired
One of:submitsync
dry_runbooleanrequired
syncedinteger | nullrequired
templateobject | nullrequired
notestringrequired

Errors

Errors are application/problem+json with a stable code.

StatusCodeMeaning
400bad_requestThe request couldn't be read.
400unknown_fieldThe request has a field this operation doesn't know.
401unauthorizedA valid API key is required.
403insufficient_scopeThis API key doesn't have the scope this operation needs.
403feature_not_enabledThe API isn't switched on for this workspace.
403role_forbiddenThe key's creator's role can't do this.
409idempotency_in_progressA request with this Idempotency-Key is still running.
413too_largeThe request body is too large.
422validation_failedThe request has invalid fields.
422idempotency_mismatchThis Idempotency-Key was used with a different request.
429rate_limitedToo many requests. Slow down and try again.
500server_errorSomething went wrong on our side.
503unavailableThe API isn't available right now. Try again shortly.