Skip to content
Meta and ChatGPT Ads

Save Meta destination

Creates or updates the property's Meta Conversions API destination, so its purchases are also sent to Meta.

PUT /companies/{companyId}/properties/{propertyId}/destinations/meta

Scope setup · Access Changes data · Operation id destinations.set_meta

Try it

productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $COMPANY_ID, $PROPERTY_ID first.

productmetrics destinations set-meta \
  --company-id $COMPANY_ID \
  --property-id $PROPERTY_ID \
  --pixel-id 6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b \
  --test-event-code TEST12345 \
  --enabled \
  --json

Response

API response (200), shortened:

{
  "data": {
    "id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
    "property_id": "8c1f4d2e-7a3b-4c5d-9e6f-0a1b2c3d4e5f",
    "property_name": "Example Store",
    "pixel_id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
    "pixel_name": "Example Store pixel",
    "token_hint": "…9c2e"
    // … 8 more fields
  },
  "request_id": "req_01JZMP4EGYY091KX7DNK96VD8H"
}

CLI output: productmetrics destinations set-meta --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.

Before you call

Needs editor or admin access and a tracked property. pixelId is the Meta pixel (dataset) id; accessToken is a Conversions API access token the person generates in Meta Events Manager for that pixel. accessToken is required when the destination is created or its pixel changes, and may be left out otherwise. It is a credential: ask the person for it, never invent, guess or reuse one, and never repeat it back. Then call destinations.test_meta to send a test event and destinations.list_meta to read the status.

Path parameters

NameTypeDescription
companyIdstring (uuid)Your workspace id, from productmetrics whoami or properties.list (company_id).
propertyIdstring (uuid)The property id, from productmetrics whoami or properties.list (property_id).

Body

NameTypeRequiredDescription
pixelIdstringYesThe Meta pixel (dataset) id.
accessTokenstringNoA Conversions API access token the person generates in Meta Events Manager for that pixel. Required when the destination is created or its pixel changes. 20 to 4096 characters.
testEventCodestring or nullYesA test event code from Meta Events Manager, so events show under Test events; null for live events.
enabledbooleanYesWhether purchases are sent to this Meta destination.

Errors

A failure answers with its HTTP status and { error: { code, message, details? }, request_id }. Branch on code (stable, lower_snake); show message to the person. The CLI prints the same error with "ok": false.

{
  "error": {
    "code": "insufficient_scope",
    "message": "This operation needs the setup scope; connect again and allow it.",
    "details": {
      "required_scope": "setup"
    }
  },
  "request_id": "req_01JDCDMAVDMXXY3NKB5HE30XG4"
}
StatusCodeWhen
400invalid_requestA path, query or body value does not match this page. details.issues lists each location, path and message.
401invalid_tokenThe token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why.
403insufficient_scopeThe token lacks the setup scope (details.required_scope): sign in again and allow it.
404not_foundAn id in the path does not exist, or the signed-in person cannot open it.
429rate_limitedMore than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry.

All Meta and ChatGPT Ads operations