Skip to main content

Update Ad Account Profit Signals

PUT 

/api/advertising/accounts/:adAccount/profit-signals

Updates an ad account's profit-signal settings. Profit signals send each matched order's contribution before ads (and, for Google, unit costs in the product feed) to the ad platform so it can bid on profit. Omitted fields keep their stored values.

Required scope: advertising:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Body fields (all optional)

  • send_profit_conversion_values (boolean): send order profit as conversion values.
  • send_cogs_to_feed (boolean, Google Ads only; forced off elsewhere): push unit cost of goods to Merchant Center.
  • mode: adjust_existing (restate the existing purchase conversion) or separate_conversion_action (send a separate Profit conversion). Google Ads.
  • conversion_action_id: numeric Google conversion action ID or its resource name (customers/123/conversionActions/456). Required when turning profit values on for Google Ads.
  • match_by_order_id (boolean): also match orders by order ID when no click ID is captured.
  • pixel_id: numeric Meta pixel (dataset) ID, 5-25 digits. Required when turning profit values on for Meta Ads.
  • meta_value_mode: replace_value (profit replaces revenue as the value) or profit_value_field (revenue stays as value, profit sent in profit_value). Meta Ads.
  • consent (boolean): must be true when turning either signal on; the consenting user, time and fields are recorded.

Turning a signal off returns a notice that values already sent cannot be retracted. Returns 422 when the platform takes no conversion values (Amazon, eBay, Walmart, TikTok), consent is missing, or the conversion action / pixel is missing. Every change is logged.

Requires the advertising.approve permission.

Request​

Responses​

OK

Response Headers
    Content-Type