Upsert conversion pixel

PUT 
/ad-publishing/facebook/pixels

Create a Facebook conversion pixel, or rename an existing one by passing conversionPixelId. The two paths acknowledge differently: a create returns the new id, a rename returns only { success: true }. Renaming is the only update supported, and it rejects type: INSTAGRAM_DM. Creating an INSTAGRAM_DM dataset requires igUserId and fails if one already exists for that account.

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location identifier

conversionPixelIdstring

Conversion pixel ID

namestring

Pixel name

igUserIdstring

Instagram user ID

typestringrequired
Pixel event type
Available optionsLEAD_EVENTFUNNEL_EVENTINSTAGRAM_DM

Example (auto)

{
  "locationId": "loc_abc123",
  "conversionPixelId": "px_123",
  "name": "My Pixel",
  "igUserId": "ig_user_123",
  "type": "LEAD_EVENT"
}

application/json

The new id when a pixel was created, or a success flag when an existing pixel was renamed

application/json

Schema

Schema

oneOf
• FacebookUpsertPixelCreatedDTO
• FacebookUpsertPixelUpdatedDTO

idstringrequired

Id of the pixel or dataset that was created

Example (auto)

{
  "id": "1712619223343735"
}