Provision CTWA dataset

Creates (or fetches, if one already exists) the Meta dataset that Click-to-WhatsApp ad events are reported against via the Conversions API, and persists its ID on the account as metadata.metaCapiDatasetId.

The call is GET-first idempotent: a WABA can only own one CTWA dataset, so a second call after a successful provision is a safe no-op that returns the same ID with created: false.

Requires the connected WhatsApp account's token to carry the whatsapp_business_manage_events permission. If the permission is missing the endpoint returns 422 with a message asking the user to reconnect the account.

Billing: Request; paid actions are priced in credits (see GET /v1/messaging/prices) · Rate limit: 60/min

post/v1/messaging/whatsapp/dataset

Request

Base URL: https://apihub.co.il
URL: https://apihub.co.il/v1/messaging/whatsapp/dataset
Auth: HTTP bearer

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Request body

accountIdstring required

WhatsApp account ID

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

operationstring

tagstring nullable

Your X-Tag, if sent

created_atstring date-time

completed_atstring date-time nullable

errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.