Sign in
Ad Conversion Value Rules

Create a conversion value rule

Create one rule covering every selected target and event combination. Active rules cannot overlap for the same platform and event. Customer prices and Whop revenue stay unchanged.

post/ad_conversion_value_rules

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

account_idstring required

Business that owns the rule.

adjustment_type'fixed' | 'percentage' required
metadataobject
percentage_changenumber nullable

Signed percent change from negative 100 to 10000. The sent value cannot go below zero.

replace_rule_idsstring[]

Exact IDs of active rules whose overlapping selections will be replaced. Other selections keep their values; remaining selections may split into separate rules. Broader rules remain as fallbacks for other items. Stale or incomplete conflict selections fail.

status'active' | 'paused'

Initial rule status. Defaults to active.

Example request

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "adjustment_type": "fixed",
  "events": [
    {
      "event_name": "lead"
    }
  ],
  "fixed_value": {
    "amount": "60.00",
    "currency": "usd"
  },
  "status": "active",
  "targets": [
    {
      "platform": "meta",
      "scope": "business"
    }
  ]
}

Response

Created

account_idstring required

Business that owns this shared, editable rule.

adjustment_type'fixed' | 'percentage' required

Set a fixed amount or change the original value by a signed percentage.

created_atstring required

When the rule was created, as an ISO 8601 timestamp.

idstring required

Conversion value rule ID, prefixed adcvr_.

metadataobject required

Free-form string keys and values for the caller.

percentage_changenumber nullable required

Signed percent change: 20 increases by 20%, negative 20 decreases by 20%. The sent value cannot go below zero. Null for a fixed rule.

status'active' | 'paused' required

Whether this rule is active or paused.

updated_atstring required

When the rule was edited, as an ISO 8601 timestamp.

Example response

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "adjustment_type": "fixed",
  "created_at": "2026-01-01T12:00:00.000Z",
  "events": [
    {
      "event_name": "lead"
    }
  ],
  "fixed_value": {
    "amount": "-2.50",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "id": "adcvr_xxxxxxxxxxxxxx",
  "metadata": {},
  "status": "active",
  "targets": [
    {
      "platform": "meta",
      "resource_title": "Shine Time Auto Detailing",
      "scope": "business"
    }
  ],
  "updated_at": "2026-01-01T12:00:00.000Z"
}

Changes

Changed in 1 of the 74 revisions of this API.1

Of the 74 revisions, 1 has no diff computed.