v1

latestOpenAPI 3.1.02026-07-26950137.9 KB

Update a Conversion Rule

Submit a JSON object in a PUT or POST request body. Fields that are omitted or null will not be updated.

post/backstage/api/1.0/{account_id}/universal_pixel/conversion_rule/{rule_id}/

Path parameters

account_idstring required

An alphabetic ID. See Get Account Details.

rule_idstring required

A numeric string.

Request body

RAW_BODYstring json required

A JSON object representing the fields to be updated. (See examples below.)

Response

200

idinteger

display_namestring

categorystring

statusstring

typestring

event_namestring

include_in_total_conversionsboolean

exclude_from_campaignsboolean

descriptionstring

advertiser_idstring

last_modified_bystring

audience_sizeinteger

Example response

{
  "id": 203,
  "display_name": "Updated Test Rule Name",
  "category": "ADD_TO_CART",
  "status": "ACTIVE",
  "type": "EVENT_BASED",
  "event_name": "add-to-cart",
  "effects": [
    {
      "type": "REVENUE",
      "data": "15"
    }
  ],
  "include_in_total_conversions": true,
  "description": "abc",
  "advertiser_id": "taboola-demo-advertiser",
  "last_modified_by": "a@taboola.com",
  "audience_size": 12345
}