Skip to main content
POST
Create a conversion value rule

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Idempotency-Key
string

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

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-09-15"

Body

application/json
account_id
string
required

Business that owns the rule.

Example:

"biz_xxxxxxxxxxxxxx"

adjustment_type
enum<string>
required
Available options:
fixed,
percentage
Example:

"fixed"

events
object[]
required

Events adjusted on every selected target. Every platform must support every selected event.

Required array length: 1 - 100 elements
targets
object[]
required

Targets sharing one scope. Every selected event applies to every target. At most 500 target and event combinations.

Required array length: 1 - 100 elements
fixed_value
object | null
metadata
object
percentage_change
number | null

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

Required range: -100 <= x <= 10000Must be a multiple of 0.01
replace_rule_ids
string[]

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.

Maximum array length: 1000
status
enum<string>

Initial rule status. Defaults to active.

Available options:
active,
paused
Example:

"active"

Response

Created

account_id
string
required

Business that owns this shared, editable rule.

Example:

"biz_xxxxxxxxxxxxxx"

adjustment_type
enum<string>
required

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

Available options:
fixed,
percentage
Example:

"fixed"

created_at
string
required

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

Example:

"2026-01-01T12:00:00.000Z"

events
object[]
required
fixed_value
object | null
required

Amount sent for a fixed rule. Null for a percentage rule.

id
string
required

Conversion value rule ID, prefixed adcvr_.

Example:

"adcvr_xxxxxxxxxxxxxx"

metadata
object
required

Free-form string keys and values for the caller.

Example:
percentage_change
number | null
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
enum<string>
required

Whether this rule is active or paused.

Available options:
active,
paused
Example:

"active"

targets
object[]
required
updated_at
string
required

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

Example:

"2026-01-01T12:00:00.000Z"