Skip to main content
POST

Authorizations

X-API-Key
string
header
required

Body

application/json
wabaId
string
required

WhatsApp Business Account ID available to the account authenticated by the API key. The WABA must be connected to YCloud and have valid authorization.

Minimum string length: 1
Example:

"102012345678901"

ctwaClid
string
required

Click-to-WhatsApp click identifier from referral.ctwa_clid in an inbound WhatsApp message. Must be nonblank and at most 1024 UTF-8 bytes. Use the original identifier for the selected WABA; Meta determines click validity.

Minimum string length: 1
Example:

"REPLACE_WITH_REAL_CTWA_CLID"

eventName
enum<string>
required

Conversion type. Lead is sent to Meta as LeadSubmitted; Purchase is sent as Purchase. Values are case-sensitive.

Available options:
Lead,
Purchase
Example:

"Purchase"

eventTime
integer<int64>
required

Actual conversion time as a positive Unix timestamp in seconds, not milliseconds. Must not be later than the current server time. Meta may reject events or clicks outside its accepted time window.

Required range: x >= 1
Example:

1794798000

customData
object

Additional conversion data sent to Meta. Required for Purchase, including both value and currency. For Lead, this object is optional; value and currency must either both be supplied or both be omitted. Omit optional fields instead of sending null.

Response

Processing completed. Inspect each result status; event failures also use HTTP 200.

Result for one event. Failed results omit identity fields that could not be validated. index is present only in batch results.

status
enum<string>
required

succeeded means the Meta request returned normally and YCloud saved the success record. It does not guarantee Meta ad attribution or dashboard visibility. Inspect this field even when the HTTP status is 200.

Available options:
succeeded,
failed
Example:

"succeeded"

index
integer

Zero-based position in the batch events array. Returned for every batch item; omitted for single submissions.

Required range: x >= 0
Example:

0

wabaId
string

WABA ID used for this submission.

Example:

"102012345678901"

ctwaClid
string

Validated click identifier from the request.

Example:

"REPLACE_WITH_REAL_CTWA_CLID"

eventName
enum<string>

Validated conversion type from the request.

Available options:
Lead,
Purchase
Example:

"Purchase"

eventTime
integer<int64>

Validated conversion time from the request, in Unix seconds.

Example:

1794798000

error
object

Returned only when status is failed; omitted on success. Per-event failure codes and their retryable values: