Ad Accounts

Create custom conversion

Changed on

Creates a Meta custom conversion for ads to optimise toward, reusing an existing one with the same name and pixel.

Provision the Meta custom conversion an ads flow optimises toward, and hand back the customConversionId for promotedObject.customConversionId on POST /v1/ads/create. Removes the manual "create it in Ads Manager first" step.

Reuse is ours, not Meta's. Meta's create is not idempotent, so a retried request would otherwise mint a duplicate carrying none of the original's optimisation history. A non-archived conversion with the same name on the same pixelId is returned instead of created, with reused: true and a 200 rather than a 201.

rule is forwarded verbatim in Meta's own grammar (e.g. {"url": {"i_contains": "thank-you"}}); Meta validates it and rejects a malformed one with "A conversion rule is required at creation time".

post/v1/accounts/{accountId}/custom-conversions

Request

  • Base URL: https://zernio.com/api
  • URL: https://zernio.com/api/v1/accounts/{accountId}/custom-conversions
  • Auth: HTTP bearer

Path parameters

accountIdstring required

Meta ads SocialAccount id.

Request body

adAccountIdstring required

Platform ad account id (Meta act_<n>, Google customer id, LinkedIn account id, ...).

namestring required

Also the reuse key, together with pixelId.

pixelIdstring required

Meta pixel id (event_source_id). From GET /v1/accounts/{accountId}/tracking-tags.

customEventTypestring required

Meta custom_event_type, e.g. LEAD, PURCHASE, OTHER.

ruleobject required

Meta conversion rule, forwarded verbatim.

Response

An existing custom conversion was reused

adAccountIdstring
customConversionIdstring

Drops straight into promotedObject.customConversionId on POST /v1/ads/create.

reusedboolean

True when an existing conversion matched name + pixelId; the response is then a 200.

Changes

  • f8c8f34fb41aRevision changes
    • warning

      added the new account enum value to the / response property for the response status

    • warning

      added the new account enum value to the / response property for the response status

    • warning

      added the new account enum value to the / response property for the response status

  • d556591af3f6Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status