Update a Conversion Value Rule

Update a conversion value rule

curl --request PATCH \
  --url https://api.whop.com/api/v1/ad_conversion_value_rules/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "adjustment_type": "fixed",
  "events": [
    {
      "event_name": "lead",
      "custom_name": "<string>"
    }
  ],
  "fixed_value": {
    "amount": "60.00",
    "currency": "usd"
  },
  "metadata": {},
  "percentage_change": 4950,
  "replace_rule_ids": [
    "<string>"
  ],
  "targets": [
    {
      "platform": "meta",
      "scope": "business",
      "resource_id": "<string>"
    }
  ]
}
'

import requests

url = "https://api.whop.com/api/v1/ad_conversion_value_rules/{id}"

payload = {
    "adjustment_type": "fixed",
    "events": [
        {
            "event_name": "lead",
            "custom_name": "<string>"
        }
    ],
    "fixed_value": {
        "amount": "60.00",
        "currency": "usd"
    },
    "metadata": {},
    "percentage_change": 4950,
    "replace_rule_ids": ["<string>"],
    "targets": [
        {
            "platform": "meta",
            "scope": "business",
            "resource_id": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    adjustment_type: 'fixed',
    events: [{event_name: 'lead', custom_name: '<string>'}],
    fixed_value: {amount: '60.00', currency: 'usd'},
    metadata: {},
    percentage_change: 4950,
    replace_rule_ids: ['<string>'],
    targets: [{platform: 'meta', scope: 'business', resource_id: '<string>'}]
  })
};

fetch('https://api.whop.com/api/v1/ad_conversion_value_rules/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/ad_conversion_value_rules/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'adjustment_type' => 'fixed',
    'events' => [
        [
                'event_name' => 'lead',
                'custom_name' => '<string>'
        ]
    ],
    'fixed_value' => [
        'amount' => '60.00',
        'currency' => 'usd'
    ],
    'metadata' => [
        
    ],
    'percentage_change' => 4950,
    'replace_rule_ids' => [
        '<string>'
    ],
    'targets' => [
        [
                'platform' => 'meta',
                'scope' => 'business',
                'resource_id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/ad_conversion_value_rules/{id}"

	payload := strings.NewReader("{\n  \"adjustment_type\": \"fixed\",\n  \"events\": [\n    {\n      \"event_name\": \"lead\",\n      \"custom_name\": \"<string>\"\n    }\n  ],\n  \"fixed_value\": {\n    \"amount\": \"60.00\",\n    \"currency\": \"usd\"\n  },\n  \"metadata\": {},\n  \"percentage_change\": 4950,\n  \"replace_rule_ids\": [\n    \"<string>\"\n  ],\n  \"targets\": [\n    {\n      \"platform\": \"meta\",\n      \"scope\": \"business\",\n      \"resource_id\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.whop.com/api/v1/ad_conversion_value_rules/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"adjustment_type\": \"fixed\",\n  \"events\": [\n    {\n      \"event_name\": \"lead\",\n      \"custom_name\": \"<string>\"\n    }\n  ],\n  \"fixed_value\": {\n    \"amount\": \"60.00\",\n    \"currency\": \"usd\"\n  },\n  \"metadata\": {},\n  \"percentage_change\": 4950,\n  \"replace_rule_ids\": [\n    \"<string>\"\n  ],\n  \"targets\": [\n    {\n      \"platform\": \"meta\",\n      \"scope\": \"business\",\n      \"resource_id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/ad_conversion_value_rules/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"adjustment_type\": \"fixed\",\n  \"events\": [\n    {\n      \"event_name\": \"lead\",\n      \"custom_name\": \"<string>\"\n    }\n  ],\n  \"fixed_value\": {\n    \"amount\": \"60.00\",\n    \"currency\": \"usd\"\n  },\n  \"metadata\": {},\n  \"percentage_change\": 4950,\n  \"replace_rule_ids\": [\n    \"<string>\"\n  ],\n  \"targets\": [\n    {\n      \"platform\": \"meta\",\n      \"scope\": \"business\",\n      \"resource_id\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

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

PATCH

ad_conversion_value_rules

{id}

Update a conversion value rule

curl --request PATCH \
  --url https://api.whop.com/api/v1/ad_conversion_value_rules/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "adjustment_type": "fixed",
  "events": [
    {
      "event_name": "lead",
      "custom_name": "<string>"
    }
  ],
  "fixed_value": {
    "amount": "60.00",
    "currency": "usd"
  },
  "metadata": {},
  "percentage_change": 4950,
  "replace_rule_ids": [
    "<string>"
  ],
  "targets": [
    {
      "platform": "meta",
      "scope": "business",
      "resource_id": "<string>"
    }
  ]
}
'

import requests

url = "https://api.whop.com/api/v1/ad_conversion_value_rules/{id}"

payload = {
    "adjustment_type": "fixed",
    "events": [
        {
            "event_name": "lead",
            "custom_name": "<string>"
        }
    ],
    "fixed_value": {
        "amount": "60.00",
        "currency": "usd"
    },
    "metadata": {},
    "percentage_change": 4950,
    "replace_rule_ids": ["<string>"],
    "targets": [
        {
            "platform": "meta",
            "scope": "business",
            "resource_id": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    adjustment_type: 'fixed',
    events: [{event_name: 'lead', custom_name: '<string>'}],
    fixed_value: {amount: '60.00', currency: 'usd'},
    metadata: {},
    percentage_change: 4950,
    replace_rule_ids: ['<string>'],
    targets: [{platform: 'meta', scope: 'business', resource_id: '<string>'}]
  })
};

fetch('https://api.whop.com/api/v1/ad_conversion_value_rules/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/ad_conversion_value_rules/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'adjustment_type' => 'fixed',
    'events' => [
        [
                'event_name' => 'lead',
                'custom_name' => '<string>'
        ]
    ],
    'fixed_value' => [
        'amount' => '60.00',
        'currency' => 'usd'
    ],
    'metadata' => [
        
    ],
    'percentage_change' => 4950,
    'replace_rule_ids' => [
        '<string>'
    ],
    'targets' => [
        [
                'platform' => 'meta',
                'scope' => 'business',
                'resource_id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/ad_conversion_value_rules/{id}"

	payload := strings.NewReader("{\n  \"adjustment_type\": \"fixed\",\n  \"events\": [\n    {\n      \"event_name\": \"lead\",\n      \"custom_name\": \"<string>\"\n    }\n  ],\n  \"fixed_value\": {\n    \"amount\": \"60.00\",\n    \"currency\": \"usd\"\n  },\n  \"metadata\": {},\n  \"percentage_change\": 4950,\n  \"replace_rule_ids\": [\n    \"<string>\"\n  ],\n  \"targets\": [\n    {\n      \"platform\": \"meta\",\n      \"scope\": \"business\",\n      \"resource_id\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.whop.com/api/v1/ad_conversion_value_rules/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"adjustment_type\": \"fixed\",\n  \"events\": [\n    {\n      \"event_name\": \"lead\",\n      \"custom_name\": \"<string>\"\n    }\n  ],\n  \"fixed_value\": {\n    \"amount\": \"60.00\",\n    \"currency\": \"usd\"\n  },\n  \"metadata\": {},\n  \"percentage_change\": 4950,\n  \"replace_rule_ids\": [\n    \"<string>\"\n  ],\n  \"targets\": [\n    {\n      \"platform\": \"meta\",\n      \"scope\": \"business\",\n      \"resource_id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/ad_conversion_value_rules/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"adjustment_type\": \"fixed\",\n  \"events\": [\n    {\n      \"event_name\": \"lead\",\n      \"custom_name\": \"<string>\"\n    }\n  ],\n  \"fixed_value\": {\n    \"amount\": \"60.00\",\n    \"currency\": \"usd\"\n  },\n  \"metadata\": {},\n  \"percentage_change\": 4950,\n  \"replace_rule_ids\": [\n    \"<string>\"\n  ],\n  \"targets\": [\n    {\n      \"platform\": \"meta\",\n      \"scope\": \"business\",\n      \"resource_id\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

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

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

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-09-15"

Path Parameters

string

required

Conversion value rule ID.

Body

application/json

adjustment_type

enum<string>

Available options:

fixed,

percentage

Example:

"fixed"

events

object[]

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

Required array length: 1 - 100 elements

Show child attributes

fixed_value

object | null

Show child attributes

metadata

object

Show child attributes

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

targets

object[]

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

Required array length: 1 - 100 elements

Show child attributes

Response

200 - application/json

Updated

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

Show child attributes

fixed_value

object | null

required

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

Show child attributes

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

Show child attributes

updated_at

string

required

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

Example:

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

Introduction

Reference

Webhooks & Events

Core Resources

Notifications

Payments

Money

Commerce

Partners

Workforce

Tracking

Ads

Media

Identity

Developer

Update a Conversion Value Rule

Authorizations

Headers

Path Parameters

Body

Response