Update an Ad

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.ads.update({
    id: "id"
});

curl --request PATCH \
  --url https://api.whop.com/api/v1/ads/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "call_to_action": "learn_more",
  "creatives": [
    {
      "crop": {
        "height": 1920,
        "width": 1080,
        "x": 0,
        "y": 120
      },
      "format": "vertical",
      "id": "file_xxxxxxxxxxxxxx"
    }
  ],
  "descriptions": [
    "Paint correction included"
  ],
  "existing_post_id": "xxxxxxxxxxxxxxxx_98765",
  "headlines": [
    "Austin's mobile detailers"
  ],
  "lead_form": {
    "completion": {
      "button_text": "See our work",
      "description": "We book coatings two days out, so pick a slot when we ring.",
      "headline": "Thanks — we will call you today",
      "url": "https://shinetime.example/gallery"
    },
    "disclaimer": {
      "body": "Ceramic coating requires the vehicle for two days.",
      "checkboxes": [
        {
          "checked_by_default": false,
          "key": "two_days",
          "required": true,
          "text": "I can leave my vehicle for two days"
        }
      ],
      "title": "Before you submit"
    },
    "form_type": "higher_intent",
    "intro": {
      "description": "Tell us about your vehicle and we will send a fixed price.",
      "headline": "Get a ceramic coating quote"
    },
    "name": "Ceramic coating quote requests",
    "phone_verification": true,
    "privacy_policy": {
      "link_text": "Shine Time privacy policy",
      "url": "https://shinetime.example/privacy"
    },
    "questions": [
      {
        "format": "multiple_choice",
        "label": "What vehicle are we detailing?",
        "options": [
          {
            "key": "sedan",
            "logic": {
              "action": "go_to_question",
              "target_end_page_index": 0,
              "target_question_index": 3
            },
            "value": "Sedan or coupe"
          }
        ],
        "type": "phone"
      }
    ]
  },
  "lead_form_id": "1037724182084885",
  "messaging_config": {
    "keyword": "Get a ceramic coating quote",
    "message": "Hi! Which vehicle are we coating?"
  },
  "multi_advertiser_ads": false,
  "music": {
    "id": "<string>"
  },
  "post_source": "facebook",
  "primary_texts": [
    "Book a two-day ceramic coating and keep the shine for three years."
  ],
  "social_accounts": [
    {
      "id": "sacc_xxxxxxxxxxxxxx"
    }
  ],
  "title": "Ceramic coating — spring hook v2",
  "url": "https://shinetime.example/ceramic-coating",
  "url_parameters": {
    "placement": "{{placement}}",
    "ref": "spring"
  }
}
EOF

import requests

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

payload = {
    "call_to_action": "learn_more",
    "creatives": [
        {
            "crop": {
                "height": 1920,
                "width": 1080,
                "x": 0,
                "y": 120
            },
            "format": "vertical",
            "id": "file_xxxxxxxxxxxxxx"
        }
    ],
    "descriptions": ["Paint correction included"],
    "existing_post_id": "xxxxxxxxxxxxxxxx_98765",
    "headlines": ["Austin's mobile detailers"],
    "lead_form": {
        "completion": {
            "button_text": "See our work",
            "description": "We book coatings two days out, so pick a slot when we ring.",
            "headline": "Thanks — we will call you today",
            "url": "https://shinetime.example/gallery"
        },
        "disclaimer": {
            "body": "Ceramic coating requires the vehicle for two days.",
            "checkboxes": [
                {
                    "checked_by_default": False,
                    "key": "two_days",
                    "required": True,
                    "text": "I can leave my vehicle for two days"
                }
            ],
            "title": "Before you submit"
        },
        "form_type": "higher_intent",
        "intro": {
            "description": "Tell us about your vehicle and we will send a fixed price.",
            "headline": "Get a ceramic coating quote"
        },
        "name": "Ceramic coating quote requests",
        "phone_verification": True,
        "privacy_policy": {
            "link_text": "Shine Time privacy policy",
            "url": "https://shinetime.example/privacy"
        },
        "questions": [
            {
                "format": "multiple_choice",
                "label": "What vehicle are we detailing?",
                "options": [
                    {
                        "key": "sedan",
                        "logic": {
                            "action": "go_to_question",
                            "target_end_page_index": 0,
                            "target_question_index": 3
                        },
                        "value": "Sedan or coupe"
                    }
                ],
                "type": "phone"
            }
        ]
    },
    "lead_form_id": "1037724182084885",
    "messaging_config": {
        "keyword": "Get a ceramic coating quote",
        "message": "Hi! Which vehicle are we coating?"
    },
    "multi_advertiser_ads": False,
    "music": { "id": "<string>" },
    "post_source": "facebook",
    "primary_texts": ["Book a two-day ceramic coating and keep the shine for three years."],
    "social_accounts": [{ "id": "sacc_xxxxxxxxxxxxxx" }],
    "title": "Ceramic coating — spring hook v2",
    "url": "https://shinetime.example/ceramic-coating",
    "url_parameters": {
        "placement": "{{placement}}",
        "ref": "spring"
    }
}
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({
    call_to_action: 'learn_more',
    creatives: [
      {
        crop: {height: 1920, width: 1080, x: 0, y: 120},
        format: 'vertical',
        id: 'file_xxxxxxxxxxxxxx'
      }
    ],
    descriptions: ['Paint correction included'],
    existing_post_id: 'xxxxxxxxxxxxxxxx_98765',
    headlines: ['Austin\'s mobile detailers'],
    lead_form: {
      completion: {
        button_text: 'See our work',
        description: 'We book coatings two days out, so pick a slot when we ring.',
        headline: 'Thanks — we will call you today',
        url: 'https://shinetime.example/gallery'
      },
      disclaimer: {
        body: JSON.stringify('Ceramic coating requires the vehicle for two days.'),
        checkboxes: [
          {
            checked_by_default: false,
            key: 'two_days',
            required: true,
            text: 'I can leave my vehicle for two days'
          }
        ],
        title: 'Before you submit'
      },
      form_type: 'higher_intent',
      intro: {
        description: 'Tell us about your vehicle and we will send a fixed price.',
        headline: 'Get a ceramic coating quote'
      },
      name: 'Ceramic coating quote requests',
      phone_verification: true,
      privacy_policy: {
        link_text: 'Shine Time privacy policy',
        url: 'https://shinetime.example/privacy'
      },
      questions: [
        {
          format: 'multiple_choice',
          label: 'What vehicle are we detailing?',
          options: [
            {
              key: 'sedan',
              logic: {action: 'go_to_question', target_end_page_index: 0, target_question_index: 3},
              value: 'Sedan or coupe'
            }
          ],
          type: 'phone'
        }
      ]
    },
    lead_form_id: '1037724182084885',
    messaging_config: {
      keyword: 'Get a ceramic coating quote',
      message: 'Hi! Which vehicle are we coating?'
    },
    multi_advertiser_ads: false,
    music: {id: '<string>'},
    post_source: 'facebook',
    primary_texts: ['Book a two-day ceramic coating and keep the shine for three years.'],
    social_accounts: [{id: 'sacc_xxxxxxxxxxxxxx'}],
    title: 'Ceramic coating — spring hook v2',
    url: 'https://shinetime.example/ceramic-coating',
    url_parameters: {placement: '{{placement}}', ref: 'spring'}
  })
};

fetch('https://api.whop.com/api/v1/ads/{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/ads/{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([
    'call_to_action' => 'learn_more',
    'creatives' => [
        [
                'crop' => [
                                'height' => 1920,
                                'width' => 1080,
                                'x' => 0,
                                'y' => 120
                ],
                'format' => 'vertical',
                'id' => 'file_xxxxxxxxxxxxxx'
        ]
    ],
    'descriptions' => [
        'Paint correction included'
    ],
    'existing_post_id' => 'xxxxxxxxxxxxxxxx_98765',
    'headlines' => [
        'Austin\'s mobile detailers'
    ],
    'lead_form' => [
        'completion' => [
                'button_text' => 'See our work',
                'description' => 'We book coatings two days out, so pick a slot when we ring.',
                'headline' => 'Thanks — we will call you today',
                'url' => 'https://shinetime.example/gallery'
        ],
        'disclaimer' => [
                'body' => 'Ceramic coating requires the vehicle for two days.',
                'checkboxes' => [
                                [
                                                                'checked_by_default' => false,
                                                                'key' => 'two_days',
                                                                'required' => true,
                                                                'text' => 'I can leave my vehicle for two days'
                                ]
                ],
                'title' => 'Before you submit'
        ],
        'form_type' => 'higher_intent',
        'intro' => [
                'description' => 'Tell us about your vehicle and we will send a fixed price.',
                'headline' => 'Get a ceramic coating quote'
        ],
        'name' => 'Ceramic coating quote requests',
        'phone_verification' => true,
        'privacy_policy' => [
                'link_text' => 'Shine Time privacy policy',
                'url' => 'https://shinetime.example/privacy'
        ],
        'questions' => [
                [
                                'format' => 'multiple_choice',
                                'label' => 'What vehicle are we detailing?',
                                'options' => [
                                                                [
                                                                                                                                'key' => 'sedan',
                                                                                                                                'logic' => [
                                                                                                                                                                                                                                                                'action' => 'go_to_question',
                                                                                                                                                                                                                                                                'target_end_page_index' => 0,
                                                                                                                                                                                                                                                                'target_question_index' => 3
                                                                                                                                ],
                                                                                                                                'value' => 'Sedan or coupe'
                                                                ]
                                ],
                                'type' => 'phone'
                ]
        ]
    ],
    'lead_form_id' => '1037724182084885',
    'messaging_config' => [
        'keyword' => 'Get a ceramic coating quote',
        'message' => 'Hi! Which vehicle are we coating?'
    ],
    'multi_advertiser_ads' => false,
    'music' => [
        'id' => '<string>'
    ],
    'post_source' => 'facebook',
    'primary_texts' => [
        'Book a two-day ceramic coating and keep the shine for three years.'
    ],
    'social_accounts' => [
        [
                'id' => 'sacc_xxxxxxxxxxxxxx'
        ]
    ],
    'title' => 'Ceramic coating — spring hook v2',
    'url' => 'https://shinetime.example/ceramic-coating',
    'url_parameters' => [
        'placement' => '{{placement}}',
        'ref' => 'spring'
    ]
  ]),
  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/ads/{id}"

	payload := strings.NewReader("{\n  \"call_to_action\": \"learn_more\",\n  \"creatives\": [\n    {\n      \"crop\": {\n        \"height\": 1920,\n        \"width\": 1080,\n        \"x\": 0,\n        \"y\": 120\n      },\n      \"format\": \"vertical\",\n      \"id\": \"file_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"descriptions\": [\n    \"Paint correction included\"\n  ],\n  \"existing_post_id\": \"xxxxxxxxxxxxxxxx_98765\",\n  \"headlines\": [\n    \"Austin's mobile detailers\"\n  ],\n  \"lead_form\": {\n    \"completion\": {\n      \"button_text\": \"See our work\",\n      \"description\": \"We book coatings two days out, so pick a slot when we ring.\",\n      \"headline\": \"Thanks — we will call you today\",\n      \"url\": \"https://shinetime.example/gallery\"\n    },\n    \"disclaimer\": {\n      \"body\": \"Ceramic coating requires the vehicle for two days.\",\n      \"checkboxes\": [\n        {\n          \"checked_by_default\": false,\n          \"key\": \"two_days\",\n          \"required\": true,\n          \"text\": \"I can leave my vehicle for two days\"\n        }\n      ],\n      \"title\": \"Before you submit\"\n    },\n    \"form_type\": \"higher_intent\",\n    \"intro\": {\n      \"description\": \"Tell us about your vehicle and we will send a fixed price.\",\n      \"headline\": \"Get a ceramic coating quote\"\n    },\n    \"name\": \"Ceramic coating quote requests\",\n    \"phone_verification\": true,\n    \"privacy_policy\": {\n      \"link_text\": \"Shine Time privacy policy\",\n      \"url\": \"https://shinetime.example/privacy\"\n    },\n    \"questions\": [\n      {\n        \"format\": \"multiple_choice\",\n        \"label\": \"What vehicle are we detailing?\",\n        \"options\": [\n          {\n            \"key\": \"sedan\",\n            \"logic\": {\n              \"action\": \"go_to_question\",\n              \"target_end_page_index\": 0,\n              \"target_question_index\": 3\n            },\n            \"value\": \"Sedan or coupe\"\n          }\n        ],\n        \"type\": \"phone\"\n      }\n    ]\n  },\n  \"lead_form_id\": \"1037724182084885\",\n  \"messaging_config\": {\n    \"keyword\": \"Get a ceramic coating quote\",\n    \"message\": \"Hi! Which vehicle are we coating?\"\n  },\n  \"multi_advertiser_ads\": false,\n  \"music\": {\n    \"id\": \"<string>\"\n  },\n  \"post_source\": \"facebook\",\n  \"primary_texts\": [\n    \"Book a two-day ceramic coating and keep the shine for three years.\"\n  ],\n  \"social_accounts\": [\n    {\n      \"id\": \"sacc_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"title\": \"Ceramic coating — spring hook v2\",\n  \"url\": \"https://shinetime.example/ceramic-coating\",\n  \"url_parameters\": {\n    \"placement\": \"{{placement}}\",\n    \"ref\": \"spring\"\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/ads/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"call_to_action\": \"learn_more\",\n  \"creatives\": [\n    {\n      \"crop\": {\n        \"height\": 1920,\n        \"width\": 1080,\n        \"x\": 0,\n        \"y\": 120\n      },\n      \"format\": \"vertical\",\n      \"id\": \"file_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"descriptions\": [\n    \"Paint correction included\"\n  ],\n  \"existing_post_id\": \"xxxxxxxxxxxxxxxx_98765\",\n  \"headlines\": [\n    \"Austin's mobile detailers\"\n  ],\n  \"lead_form\": {\n    \"completion\": {\n      \"button_text\": \"See our work\",\n      \"description\": \"We book coatings two days out, so pick a slot when we ring.\",\n      \"headline\": \"Thanks — we will call you today\",\n      \"url\": \"https://shinetime.example/gallery\"\n    },\n    \"disclaimer\": {\n      \"body\": \"Ceramic coating requires the vehicle for two days.\",\n      \"checkboxes\": [\n        {\n          \"checked_by_default\": false,\n          \"key\": \"two_days\",\n          \"required\": true,\n          \"text\": \"I can leave my vehicle for two days\"\n        }\n      ],\n      \"title\": \"Before you submit\"\n    },\n    \"form_type\": \"higher_intent\",\n    \"intro\": {\n      \"description\": \"Tell us about your vehicle and we will send a fixed price.\",\n      \"headline\": \"Get a ceramic coating quote\"\n    },\n    \"name\": \"Ceramic coating quote requests\",\n    \"phone_verification\": true,\n    \"privacy_policy\": {\n      \"link_text\": \"Shine Time privacy policy\",\n      \"url\": \"https://shinetime.example/privacy\"\n    },\n    \"questions\": [\n      {\n        \"format\": \"multiple_choice\",\n        \"label\": \"What vehicle are we detailing?\",\n        \"options\": [\n          {\n            \"key\": \"sedan\",\n            \"logic\": {\n              \"action\": \"go_to_question\",\n              \"target_end_page_index\": 0,\n              \"target_question_index\": 3\n            },\n            \"value\": \"Sedan or coupe\"\n          }\n        ],\n        \"type\": \"phone\"\n      }\n    ]\n  },\n  \"lead_form_id\": \"1037724182084885\",\n  \"messaging_config\": {\n    \"keyword\": \"Get a ceramic coating quote\",\n    \"message\": \"Hi! Which vehicle are we coating?\"\n  },\n  \"multi_advertiser_ads\": false,\n  \"music\": {\n    \"id\": \"<string>\"\n  },\n  \"post_source\": \"facebook\",\n  \"primary_texts\": [\n    \"Book a two-day ceramic coating and keep the shine for three years.\"\n  ],\n  \"social_accounts\": [\n    {\n      \"id\": \"sacc_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"title\": \"Ceramic coating — spring hook v2\",\n  \"url\": \"https://shinetime.example/ceramic-coating\",\n  \"url_parameters\": {\n    \"placement\": \"{{placement}}\",\n    \"ref\": \"spring\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/ads/{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  \"call_to_action\": \"learn_more\",\n  \"creatives\": [\n    {\n      \"crop\": {\n        \"height\": 1920,\n        \"width\": 1080,\n        \"x\": 0,\n        \"y\": 120\n      },\n      \"format\": \"vertical\",\n      \"id\": \"file_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"descriptions\": [\n    \"Paint correction included\"\n  ],\n  \"existing_post_id\": \"xxxxxxxxxxxxxxxx_98765\",\n  \"headlines\": [\n    \"Austin's mobile detailers\"\n  ],\n  \"lead_form\": {\n    \"completion\": {\n      \"button_text\": \"See our work\",\n      \"description\": \"We book coatings two days out, so pick a slot when we ring.\",\n      \"headline\": \"Thanks — we will call you today\",\n      \"url\": \"https://shinetime.example/gallery\"\n    },\n    \"disclaimer\": {\n      \"body\": \"Ceramic coating requires the vehicle for two days.\",\n      \"checkboxes\": [\n        {\n          \"checked_by_default\": false,\n          \"key\": \"two_days\",\n          \"required\": true,\n          \"text\": \"I can leave my vehicle for two days\"\n        }\n      ],\n      \"title\": \"Before you submit\"\n    },\n    \"form_type\": \"higher_intent\",\n    \"intro\": {\n      \"description\": \"Tell us about your vehicle and we will send a fixed price.\",\n      \"headline\": \"Get a ceramic coating quote\"\n    },\n    \"name\": \"Ceramic coating quote requests\",\n    \"phone_verification\": true,\n    \"privacy_policy\": {\n      \"link_text\": \"Shine Time privacy policy\",\n      \"url\": \"https://shinetime.example/privacy\"\n    },\n    \"questions\": [\n      {\n        \"format\": \"multiple_choice\",\n        \"label\": \"What vehicle are we detailing?\",\n        \"options\": [\n          {\n            \"key\": \"sedan\",\n            \"logic\": {\n              \"action\": \"go_to_question\",\n              \"target_end_page_index\": 0,\n              \"target_question_index\": 3\n            },\n            \"value\": \"Sedan or coupe\"\n          }\n        ],\n        \"type\": \"phone\"\n      }\n    ]\n  },\n  \"lead_form_id\": \"1037724182084885\",\n  \"messaging_config\": {\n    \"keyword\": \"Get a ceramic coating quote\",\n    \"message\": \"Hi! Which vehicle are we coating?\"\n  },\n  \"multi_advertiser_ads\": false,\n  \"music\": {\n    \"id\": \"<string>\"\n  },\n  \"post_source\": \"facebook\",\n  \"primary_texts\": [\n    \"Book a two-day ceramic coating and keep the shine for three years.\"\n  ],\n  \"social_accounts\": [\n    {\n      \"id\": \"sacc_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"title\": \"Ceramic coating — spring hook v2\",\n  \"url\": \"https://shinetime.example/ceramic-coating\",\n  \"url_parameters\": {\n    \"placement\": \"{{placement}}\",\n    \"ref\": \"spring\"\n  }\n}"

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

{
  "ad_campaign": {
    "id": "adcamp_xxxxxxxxxxxxxx"
  },
  "ad_group": {
    "id": "adcamp_xxxxxxxxxxxxxx"
  },
  "added_to_cart_value": 1850,
  "added_to_carts": 74,
  "call_to_action": "learn_more",
  "click_through_rate": 0.0261,
  "clicks": 1337,
  "completed_registration_value": 95,
  "completed_registrations": 19,
  "contact_value": 175,
  "contacts": 27,
  "cost_per_added_to_cart": 6.515675675675676,
  "cost_per_click": 0.36,
  "cost_per_completed_registration": 25.37684210526316,
  "cost_per_contact": 17.85777777777778,
  "cost_per_lead": 3.984793388429752,
  "cost_per_mille": 9.42,
  "cost_per_purchase": 12.68842105263158,
  "cost_per_result": 7.653333333333333,
  "cost_per_schedule": 10.48173913043478,
  "cost_per_submitted_application": 40.18,
  "cost_per_unique_click": 0.48,
  "cost_per_viewed_content": 0.2253084112149533,
  "created_at": "2026-01-01T12:00:00.000Z",
  "creatives": [
    {
      "crop": {
        "height": 1000,
        "width": 1000,
        "x": 40,
        "y": 0
      },
      "format": "vertical",
      "id": "file_xxxxxxxxxxxxxx",
      "media_type": "image",
      "url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
  ],
  "custom_conversions": 63,
  "custom_event_counts": {
    "booked_detail": 63
  },
  "custom_event_values": {
    "booked_detail": 4820
  },
  "delivery_status": "paused",
  "descriptions": [
    "Paint correction included"
  ],
  "existing_post_id": "xxxxxxxxxxxxxxxx_98765",
  "frequency": 123,
  "headlines": [
    "Austin's mobile detailers"
  ],
  "id": "ad_xxxxxxxxxxxxxx",
  "impressions": 51204,
  "issues": [
    {
      "id": "adiss_xxxxxxxxxxxxxx",
      "message": "Your ad was rejected for unacceptable business practices. Edit the ad's content and resubmit.",
      "resource_id": "ad_xxxxxxxxxxxxxx",
      "resource_type": "ad"
    }
  ],
  "lead_value": 1180,
  "leads": 121,
  "link_clicks": 1071,
  "post_id": "xxxxxxxxxxxxxxxx_98765",
  "post_source": "facebook",
  "post_thumbnail_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "primary_texts": [
    "Book a two-day ceramic coating and keep the shine for three years."
  ],
  "purchase_value": 9462,
  "purchases": 38,
  "reach": 0,
  "result_event": "custom",
  "result_event_name": "booked_detail",
  "results": 63,
  "return_on_ad_spend": 19.62419113987058,
  "schedule_value": 640,
  "schedules": 46,
  "social_accounts": [
    {
      "id": "adcamp_xxxxxxxxxxxxxx"
    }
  ],
  "spend": 482.16,
  "spend_currency": "usd",
  "status": "paused",
  "submitted_application_value": 300,
  "submitted_applications": 12,
  "title": "Ceramic coating — new ad group",
  "unique_click_through_rate": 123,
  "unique_clicks": 1012,
  "updated_at": "2026-01-01T12:00:00.000Z",
  "url": "https://shinetime.example/ceramic-coating",
  "url_parameters": {},
  "viewed_content_value": 0,
  "viewed_contents": 2140,
  "lead_form": {
    "completion": {
      "button_text": "See our work",
      "description": "We book coatings two days out, so pick a slot when we ring.",
      "headline": "Thanks — we will call you today",
      "url": "https://shinetime.example/gallery"
    },
    "disclaimer": {
      "body": "Ceramic coating requires the vehicle for two days.",
      "checkboxes": [
        {
          "checked_by_default": false,
          "key": "consent_1",
          "required": true,
          "text": "I agree"
        }
      ],
      "title": "Before you submit"
    },
    "form_type": "higher_intent",
    "intro": {
      "description": "Tell us about your vehicle and we will send a fixed price.",
      "headline": "Get a ceramic coating quote"
    },
    "name": "Ceramic coating quote requests",
    "phone_verification": true,
    "privacy_policy": {
      "link_text": "Shine Time privacy policy",
      "url": "https://shinetime.example/privacy"
    },
    "questions": [
      {
        "type": "custom",
        "format": "multiple_choice",
        "label": "What vehicle are we detailing?",
        "options": [
          {
            "value": "Ceramic coating",
            "key": "ceramic_coating",
            "logic": {
              "action": "go_to_question",
              "target_end_page_index": 0,
              "target_question_index": 3
            }
          }
        ]
      }
    ]
  },
  "lead_form_id": "1037724182084885",
  "messaging_config": {
    "keyword": "Book an interior deep clean",
    "message": "Hi! Tell us your vehicle and ZIP and we will send an interior deep clean quote."
  },
  "multi_advertiser_ads": true,
  "music": {
    "id": "<string>",
    "name": "<string>",
    "url": "<string>"
  }
}

PATCH

ads

{id}

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.ads.update({
    id: "id"
});

curl --request PATCH \
  --url https://api.whop.com/api/v1/ads/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "call_to_action": "learn_more",
  "creatives": [
    {
      "crop": {
        "height": 1920,
        "width": 1080,
        "x": 0,
        "y": 120
      },
      "format": "vertical",
      "id": "file_xxxxxxxxxxxxxx"
    }
  ],
  "descriptions": [
    "Paint correction included"
  ],
  "existing_post_id": "xxxxxxxxxxxxxxxx_98765",
  "headlines": [
    "Austin's mobile detailers"
  ],
  "lead_form": {
    "completion": {
      "button_text": "See our work",
      "description": "We book coatings two days out, so pick a slot when we ring.",
      "headline": "Thanks — we will call you today",
      "url": "https://shinetime.example/gallery"
    },
    "disclaimer": {
      "body": "Ceramic coating requires the vehicle for two days.",
      "checkboxes": [
        {
          "checked_by_default": false,
          "key": "two_days",
          "required": true,
          "text": "I can leave my vehicle for two days"
        }
      ],
      "title": "Before you submit"
    },
    "form_type": "higher_intent",
    "intro": {
      "description": "Tell us about your vehicle and we will send a fixed price.",
      "headline": "Get a ceramic coating quote"
    },
    "name": "Ceramic coating quote requests",
    "phone_verification": true,
    "privacy_policy": {
      "link_text": "Shine Time privacy policy",
      "url": "https://shinetime.example/privacy"
    },
    "questions": [
      {
        "format": "multiple_choice",
        "label": "What vehicle are we detailing?",
        "options": [
          {
            "key": "sedan",
            "logic": {
              "action": "go_to_question",
              "target_end_page_index": 0,
              "target_question_index": 3
            },
            "value": "Sedan or coupe"
          }
        ],
        "type": "phone"
      }
    ]
  },
  "lead_form_id": "1037724182084885",
  "messaging_config": {
    "keyword": "Get a ceramic coating quote",
    "message": "Hi! Which vehicle are we coating?"
  },
  "multi_advertiser_ads": false,
  "music": {
    "id": "<string>"
  },
  "post_source": "facebook",
  "primary_texts": [
    "Book a two-day ceramic coating and keep the shine for three years."
  ],
  "social_accounts": [
    {
      "id": "sacc_xxxxxxxxxxxxxx"
    }
  ],
  "title": "Ceramic coating — spring hook v2",
  "url": "https://shinetime.example/ceramic-coating",
  "url_parameters": {
    "placement": "{{placement}}",
    "ref": "spring"
  }
}
EOF

import requests

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

payload = {
    "call_to_action": "learn_more",
    "creatives": [
        {
            "crop": {
                "height": 1920,
                "width": 1080,
                "x": 0,
                "y": 120
            },
            "format": "vertical",
            "id": "file_xxxxxxxxxxxxxx"
        }
    ],
    "descriptions": ["Paint correction included"],
    "existing_post_id": "xxxxxxxxxxxxxxxx_98765",
    "headlines": ["Austin's mobile detailers"],
    "lead_form": {
        "completion": {
            "button_text": "See our work",
            "description": "We book coatings two days out, so pick a slot when we ring.",
            "headline": "Thanks — we will call you today",
            "url": "https://shinetime.example/gallery"
        },
        "disclaimer": {
            "body": "Ceramic coating requires the vehicle for two days.",
            "checkboxes": [
                {
                    "checked_by_default": False,
                    "key": "two_days",
                    "required": True,
                    "text": "I can leave my vehicle for two days"
                }
            ],
            "title": "Before you submit"
        },
        "form_type": "higher_intent",
        "intro": {
            "description": "Tell us about your vehicle and we will send a fixed price.",
            "headline": "Get a ceramic coating quote"
        },
        "name": "Ceramic coating quote requests",
        "phone_verification": True,
        "privacy_policy": {
            "link_text": "Shine Time privacy policy",
            "url": "https://shinetime.example/privacy"
        },
        "questions": [
            {
                "format": "multiple_choice",
                "label": "What vehicle are we detailing?",
                "options": [
                    {
                        "key": "sedan",
                        "logic": {
                            "action": "go_to_question",
                            "target_end_page_index": 0,
                            "target_question_index": 3
                        },
                        "value": "Sedan or coupe"
                    }
                ],
                "type": "phone"
            }
        ]
    },
    "lead_form_id": "1037724182084885",
    "messaging_config": {
        "keyword": "Get a ceramic coating quote",
        "message": "Hi! Which vehicle are we coating?"
    },
    "multi_advertiser_ads": False,
    "music": { "id": "<string>" },
    "post_source": "facebook",
    "primary_texts": ["Book a two-day ceramic coating and keep the shine for three years."],
    "social_accounts": [{ "id": "sacc_xxxxxxxxxxxxxx" }],
    "title": "Ceramic coating — spring hook v2",
    "url": "https://shinetime.example/ceramic-coating",
    "url_parameters": {
        "placement": "{{placement}}",
        "ref": "spring"
    }
}
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({
    call_to_action: 'learn_more',
    creatives: [
      {
        crop: {height: 1920, width: 1080, x: 0, y: 120},
        format: 'vertical',
        id: 'file_xxxxxxxxxxxxxx'
      }
    ],
    descriptions: ['Paint correction included'],
    existing_post_id: 'xxxxxxxxxxxxxxxx_98765',
    headlines: ['Austin\'s mobile detailers'],
    lead_form: {
      completion: {
        button_text: 'See our work',
        description: 'We book coatings two days out, so pick a slot when we ring.',
        headline: 'Thanks — we will call you today',
        url: 'https://shinetime.example/gallery'
      },
      disclaimer: {
        body: JSON.stringify('Ceramic coating requires the vehicle for two days.'),
        checkboxes: [
          {
            checked_by_default: false,
            key: 'two_days',
            required: true,
            text: 'I can leave my vehicle for two days'
          }
        ],
        title: 'Before you submit'
      },
      form_type: 'higher_intent',
      intro: {
        description: 'Tell us about your vehicle and we will send a fixed price.',
        headline: 'Get a ceramic coating quote'
      },
      name: 'Ceramic coating quote requests',
      phone_verification: true,
      privacy_policy: {
        link_text: 'Shine Time privacy policy',
        url: 'https://shinetime.example/privacy'
      },
      questions: [
        {
          format: 'multiple_choice',
          label: 'What vehicle are we detailing?',
          options: [
            {
              key: 'sedan',
              logic: {action: 'go_to_question', target_end_page_index: 0, target_question_index: 3},
              value: 'Sedan or coupe'
            }
          ],
          type: 'phone'
        }
      ]
    },
    lead_form_id: '1037724182084885',
    messaging_config: {
      keyword: 'Get a ceramic coating quote',
      message: 'Hi! Which vehicle are we coating?'
    },
    multi_advertiser_ads: false,
    music: {id: '<string>'},
    post_source: 'facebook',
    primary_texts: ['Book a two-day ceramic coating and keep the shine for three years.'],
    social_accounts: [{id: 'sacc_xxxxxxxxxxxxxx'}],
    title: 'Ceramic coating — spring hook v2',
    url: 'https://shinetime.example/ceramic-coating',
    url_parameters: {placement: '{{placement}}', ref: 'spring'}
  })
};

fetch('https://api.whop.com/api/v1/ads/{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/ads/{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([
    'call_to_action' => 'learn_more',
    'creatives' => [
        [
                'crop' => [
                                'height' => 1920,
                                'width' => 1080,
                                'x' => 0,
                                'y' => 120
                ],
                'format' => 'vertical',
                'id' => 'file_xxxxxxxxxxxxxx'
        ]
    ],
    'descriptions' => [
        'Paint correction included'
    ],
    'existing_post_id' => 'xxxxxxxxxxxxxxxx_98765',
    'headlines' => [
        'Austin\'s mobile detailers'
    ],
    'lead_form' => [
        'completion' => [
                'button_text' => 'See our work',
                'description' => 'We book coatings two days out, so pick a slot when we ring.',
                'headline' => 'Thanks — we will call you today',
                'url' => 'https://shinetime.example/gallery'
        ],
        'disclaimer' => [
                'body' => 'Ceramic coating requires the vehicle for two days.',
                'checkboxes' => [
                                [
                                                                'checked_by_default' => false,
                                                                'key' => 'two_days',
                                                                'required' => true,
                                                                'text' => 'I can leave my vehicle for two days'
                                ]
                ],
                'title' => 'Before you submit'
        ],
        'form_type' => 'higher_intent',
        'intro' => [
                'description' => 'Tell us about your vehicle and we will send a fixed price.',
                'headline' => 'Get a ceramic coating quote'
        ],
        'name' => 'Ceramic coating quote requests',
        'phone_verification' => true,
        'privacy_policy' => [
                'link_text' => 'Shine Time privacy policy',
                'url' => 'https://shinetime.example/privacy'
        ],
        'questions' => [
                [
                                'format' => 'multiple_choice',
                                'label' => 'What vehicle are we detailing?',
                                'options' => [
                                                                [
                                                                                                                                'key' => 'sedan',
                                                                                                                                'logic' => [
                                                                                                                                                                                                                                                                'action' => 'go_to_question',
                                                                                                                                                                                                                                                                'target_end_page_index' => 0,
                                                                                                                                                                                                                                                                'target_question_index' => 3
                                                                                                                                ],
                                                                                                                                'value' => 'Sedan or coupe'
                                                                ]
                                ],
                                'type' => 'phone'
                ]
        ]
    ],
    'lead_form_id' => '1037724182084885',
    'messaging_config' => [
        'keyword' => 'Get a ceramic coating quote',
        'message' => 'Hi! Which vehicle are we coating?'
    ],
    'multi_advertiser_ads' => false,
    'music' => [
        'id' => '<string>'
    ],
    'post_source' => 'facebook',
    'primary_texts' => [
        'Book a two-day ceramic coating and keep the shine for three years.'
    ],
    'social_accounts' => [
        [
                'id' => 'sacc_xxxxxxxxxxxxxx'
        ]
    ],
    'title' => 'Ceramic coating — spring hook v2',
    'url' => 'https://shinetime.example/ceramic-coating',
    'url_parameters' => [
        'placement' => '{{placement}}',
        'ref' => 'spring'
    ]
  ]),
  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/ads/{id}"

	payload := strings.NewReader("{\n  \"call_to_action\": \"learn_more\",\n  \"creatives\": [\n    {\n      \"crop\": {\n        \"height\": 1920,\n        \"width\": 1080,\n        \"x\": 0,\n        \"y\": 120\n      },\n      \"format\": \"vertical\",\n      \"id\": \"file_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"descriptions\": [\n    \"Paint correction included\"\n  ],\n  \"existing_post_id\": \"xxxxxxxxxxxxxxxx_98765\",\n  \"headlines\": [\n    \"Austin's mobile detailers\"\n  ],\n  \"lead_form\": {\n    \"completion\": {\n      \"button_text\": \"See our work\",\n      \"description\": \"We book coatings two days out, so pick a slot when we ring.\",\n      \"headline\": \"Thanks — we will call you today\",\n      \"url\": \"https://shinetime.example/gallery\"\n    },\n    \"disclaimer\": {\n      \"body\": \"Ceramic coating requires the vehicle for two days.\",\n      \"checkboxes\": [\n        {\n          \"checked_by_default\": false,\n          \"key\": \"two_days\",\n          \"required\": true,\n          \"text\": \"I can leave my vehicle for two days\"\n        }\n      ],\n      \"title\": \"Before you submit\"\n    },\n    \"form_type\": \"higher_intent\",\n    \"intro\": {\n      \"description\": \"Tell us about your vehicle and we will send a fixed price.\",\n      \"headline\": \"Get a ceramic coating quote\"\n    },\n    \"name\": \"Ceramic coating quote requests\",\n    \"phone_verification\": true,\n    \"privacy_policy\": {\n      \"link_text\": \"Shine Time privacy policy\",\n      \"url\": \"https://shinetime.example/privacy\"\n    },\n    \"questions\": [\n      {\n        \"format\": \"multiple_choice\",\n        \"label\": \"What vehicle are we detailing?\",\n        \"options\": [\n          {\n            \"key\": \"sedan\",\n            \"logic\": {\n              \"action\": \"go_to_question\",\n              \"target_end_page_index\": 0,\n              \"target_question_index\": 3\n            },\n            \"value\": \"Sedan or coupe\"\n          }\n        ],\n        \"type\": \"phone\"\n      }\n    ]\n  },\n  \"lead_form_id\": \"1037724182084885\",\n  \"messaging_config\": {\n    \"keyword\": \"Get a ceramic coating quote\",\n    \"message\": \"Hi! Which vehicle are we coating?\"\n  },\n  \"multi_advertiser_ads\": false,\n  \"music\": {\n    \"id\": \"<string>\"\n  },\n  \"post_source\": \"facebook\",\n  \"primary_texts\": [\n    \"Book a two-day ceramic coating and keep the shine for three years.\"\n  ],\n  \"social_accounts\": [\n    {\n      \"id\": \"sacc_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"title\": \"Ceramic coating — spring hook v2\",\n  \"url\": \"https://shinetime.example/ceramic-coating\",\n  \"url_parameters\": {\n    \"placement\": \"{{placement}}\",\n    \"ref\": \"spring\"\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/ads/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"call_to_action\": \"learn_more\",\n  \"creatives\": [\n    {\n      \"crop\": {\n        \"height\": 1920,\n        \"width\": 1080,\n        \"x\": 0,\n        \"y\": 120\n      },\n      \"format\": \"vertical\",\n      \"id\": \"file_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"descriptions\": [\n    \"Paint correction included\"\n  ],\n  \"existing_post_id\": \"xxxxxxxxxxxxxxxx_98765\",\n  \"headlines\": [\n    \"Austin's mobile detailers\"\n  ],\n  \"lead_form\": {\n    \"completion\": {\n      \"button_text\": \"See our work\",\n      \"description\": \"We book coatings two days out, so pick a slot when we ring.\",\n      \"headline\": \"Thanks — we will call you today\",\n      \"url\": \"https://shinetime.example/gallery\"\n    },\n    \"disclaimer\": {\n      \"body\": \"Ceramic coating requires the vehicle for two days.\",\n      \"checkboxes\": [\n        {\n          \"checked_by_default\": false,\n          \"key\": \"two_days\",\n          \"required\": true,\n          \"text\": \"I can leave my vehicle for two days\"\n        }\n      ],\n      \"title\": \"Before you submit\"\n    },\n    \"form_type\": \"higher_intent\",\n    \"intro\": {\n      \"description\": \"Tell us about your vehicle and we will send a fixed price.\",\n      \"headline\": \"Get a ceramic coating quote\"\n    },\n    \"name\": \"Ceramic coating quote requests\",\n    \"phone_verification\": true,\n    \"privacy_policy\": {\n      \"link_text\": \"Shine Time privacy policy\",\n      \"url\": \"https://shinetime.example/privacy\"\n    },\n    \"questions\": [\n      {\n        \"format\": \"multiple_choice\",\n        \"label\": \"What vehicle are we detailing?\",\n        \"options\": [\n          {\n            \"key\": \"sedan\",\n            \"logic\": {\n              \"action\": \"go_to_question\",\n              \"target_end_page_index\": 0,\n              \"target_question_index\": 3\n            },\n            \"value\": \"Sedan or coupe\"\n          }\n        ],\n        \"type\": \"phone\"\n      }\n    ]\n  },\n  \"lead_form_id\": \"1037724182084885\",\n  \"messaging_config\": {\n    \"keyword\": \"Get a ceramic coating quote\",\n    \"message\": \"Hi! Which vehicle are we coating?\"\n  },\n  \"multi_advertiser_ads\": false,\n  \"music\": {\n    \"id\": \"<string>\"\n  },\n  \"post_source\": \"facebook\",\n  \"primary_texts\": [\n    \"Book a two-day ceramic coating and keep the shine for three years.\"\n  ],\n  \"social_accounts\": [\n    {\n      \"id\": \"sacc_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"title\": \"Ceramic coating — spring hook v2\",\n  \"url\": \"https://shinetime.example/ceramic-coating\",\n  \"url_parameters\": {\n    \"placement\": \"{{placement}}\",\n    \"ref\": \"spring\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/ads/{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  \"call_to_action\": \"learn_more\",\n  \"creatives\": [\n    {\n      \"crop\": {\n        \"height\": 1920,\n        \"width\": 1080,\n        \"x\": 0,\n        \"y\": 120\n      },\n      \"format\": \"vertical\",\n      \"id\": \"file_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"descriptions\": [\n    \"Paint correction included\"\n  ],\n  \"existing_post_id\": \"xxxxxxxxxxxxxxxx_98765\",\n  \"headlines\": [\n    \"Austin's mobile detailers\"\n  ],\n  \"lead_form\": {\n    \"completion\": {\n      \"button_text\": \"See our work\",\n      \"description\": \"We book coatings two days out, so pick a slot when we ring.\",\n      \"headline\": \"Thanks — we will call you today\",\n      \"url\": \"https://shinetime.example/gallery\"\n    },\n    \"disclaimer\": {\n      \"body\": \"Ceramic coating requires the vehicle for two days.\",\n      \"checkboxes\": [\n        {\n          \"checked_by_default\": false,\n          \"key\": \"two_days\",\n          \"required\": true,\n          \"text\": \"I can leave my vehicle for two days\"\n        }\n      ],\n      \"title\": \"Before you submit\"\n    },\n    \"form_type\": \"higher_intent\",\n    \"intro\": {\n      \"description\": \"Tell us about your vehicle and we will send a fixed price.\",\n      \"headline\": \"Get a ceramic coating quote\"\n    },\n    \"name\": \"Ceramic coating quote requests\",\n    \"phone_verification\": true,\n    \"privacy_policy\": {\n      \"link_text\": \"Shine Time privacy policy\",\n      \"url\": \"https://shinetime.example/privacy\"\n    },\n    \"questions\": [\n      {\n        \"format\": \"multiple_choice\",\n        \"label\": \"What vehicle are we detailing?\",\n        \"options\": [\n          {\n            \"key\": \"sedan\",\n            \"logic\": {\n              \"action\": \"go_to_question\",\n              \"target_end_page_index\": 0,\n              \"target_question_index\": 3\n            },\n            \"value\": \"Sedan or coupe\"\n          }\n        ],\n        \"type\": \"phone\"\n      }\n    ]\n  },\n  \"lead_form_id\": \"1037724182084885\",\n  \"messaging_config\": {\n    \"keyword\": \"Get a ceramic coating quote\",\n    \"message\": \"Hi! Which vehicle are we coating?\"\n  },\n  \"multi_advertiser_ads\": false,\n  \"music\": {\n    \"id\": \"<string>\"\n  },\n  \"post_source\": \"facebook\",\n  \"primary_texts\": [\n    \"Book a two-day ceramic coating and keep the shine for three years.\"\n  ],\n  \"social_accounts\": [\n    {\n      \"id\": \"sacc_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"title\": \"Ceramic coating — spring hook v2\",\n  \"url\": \"https://shinetime.example/ceramic-coating\",\n  \"url_parameters\": {\n    \"placement\": \"{{placement}}\",\n    \"ref\": \"spring\"\n  }\n}"

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

{
  "ad_campaign": {
    "id": "adcamp_xxxxxxxxxxxxxx"
  },
  "ad_group": {
    "id": "adcamp_xxxxxxxxxxxxxx"
  },
  "added_to_cart_value": 1850,
  "added_to_carts": 74,
  "call_to_action": "learn_more",
  "click_through_rate": 0.0261,
  "clicks": 1337,
  "completed_registration_value": 95,
  "completed_registrations": 19,
  "contact_value": 175,
  "contacts": 27,
  "cost_per_added_to_cart": 6.515675675675676,
  "cost_per_click": 0.36,
  "cost_per_completed_registration": 25.37684210526316,
  "cost_per_contact": 17.85777777777778,
  "cost_per_lead": 3.984793388429752,
  "cost_per_mille": 9.42,
  "cost_per_purchase": 12.68842105263158,
  "cost_per_result": 7.653333333333333,
  "cost_per_schedule": 10.48173913043478,
  "cost_per_submitted_application": 40.18,
  "cost_per_unique_click": 0.48,
  "cost_per_viewed_content": 0.2253084112149533,
  "created_at": "2026-01-01T12:00:00.000Z",
  "creatives": [
    {
      "crop": {
        "height": 1000,
        "width": 1000,
        "x": 40,
        "y": 0
      },
      "format": "vertical",
      "id": "file_xxxxxxxxxxxxxx",
      "media_type": "image",
      "url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
  ],
  "custom_conversions": 63,
  "custom_event_counts": {
    "booked_detail": 63
  },
  "custom_event_values": {
    "booked_detail": 4820
  },
  "delivery_status": "paused",
  "descriptions": [
    "Paint correction included"
  ],
  "existing_post_id": "xxxxxxxxxxxxxxxx_98765",
  "frequency": 123,
  "headlines": [
    "Austin's mobile detailers"
  ],
  "id": "ad_xxxxxxxxxxxxxx",
  "impressions": 51204,
  "issues": [
    {
      "id": "adiss_xxxxxxxxxxxxxx",
      "message": "Your ad was rejected for unacceptable business practices. Edit the ad's content and resubmit.",
      "resource_id": "ad_xxxxxxxxxxxxxx",
      "resource_type": "ad"
    }
  ],
  "lead_value": 1180,
  "leads": 121,
  "link_clicks": 1071,
  "post_id": "xxxxxxxxxxxxxxxx_98765",
  "post_source": "facebook",
  "post_thumbnail_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "primary_texts": [
    "Book a two-day ceramic coating and keep the shine for three years."
  ],
  "purchase_value": 9462,
  "purchases": 38,
  "reach": 0,
  "result_event": "custom",
  "result_event_name": "booked_detail",
  "results": 63,
  "return_on_ad_spend": 19.62419113987058,
  "schedule_value": 640,
  "schedules": 46,
  "social_accounts": [
    {
      "id": "adcamp_xxxxxxxxxxxxxx"
    }
  ],
  "spend": 482.16,
  "spend_currency": "usd",
  "status": "paused",
  "submitted_application_value": 300,
  "submitted_applications": 12,
  "title": "Ceramic coating — new ad group",
  "unique_click_through_rate": 123,
  "unique_clicks": 1012,
  "updated_at": "2026-01-01T12:00:00.000Z",
  "url": "https://shinetime.example/ceramic-coating",
  "url_parameters": {},
  "viewed_content_value": 0,
  "viewed_contents": 2140,
  "lead_form": {
    "completion": {
      "button_text": "See our work",
      "description": "We book coatings two days out, so pick a slot when we ring.",
      "headline": "Thanks — we will call you today",
      "url": "https://shinetime.example/gallery"
    },
    "disclaimer": {
      "body": "Ceramic coating requires the vehicle for two days.",
      "checkboxes": [
        {
          "checked_by_default": false,
          "key": "consent_1",
          "required": true,
          "text": "I agree"
        }
      ],
      "title": "Before you submit"
    },
    "form_type": "higher_intent",
    "intro": {
      "description": "Tell us about your vehicle and we will send a fixed price.",
      "headline": "Get a ceramic coating quote"
    },
    "name": "Ceramic coating quote requests",
    "phone_verification": true,
    "privacy_policy": {
      "link_text": "Shine Time privacy policy",
      "url": "https://shinetime.example/privacy"
    },
    "questions": [
      {
        "type": "custom",
        "format": "multiple_choice",
        "label": "What vehicle are we detailing?",
        "options": [
          {
            "value": "Ceramic coating",
            "key": "ceramic_coating",
            "logic": {
              "action": "go_to_question",
              "target_end_page_index": 0,
              "target_question_index": 3
            }
          }
        ]
      }
    ]
  },
  "lead_form_id": "1037724182084885",
  "messaging_config": {
    "keyword": "Book an interior deep clean",
    "message": "Hi! Tell us your vehicle and ZIP and we will send an interior deep clean quote."
  },
  "multi_advertiser_ads": true,
  "music": {
    "id": "<string>",
    "name": "<string>",
    "url": "<string>"
  }
}

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-11-1"

Path Parameters

string

required

The ad ID.

Body

application/json

call_to_action

enum<string>

The call-to-action button shown on the ad.

Available options:

apply_now,

book_now,

call_now,

contact_us,

download,

get_directions,

get_offer,

get_quote,

learn_more,

listen_now,

message_page,

no_button,

open_link,

order_now,

request_time,

see_details,

see_menu,

send_updates,

shop_now,

sign_up,

subscribe,

watch_more

Example:

"learn_more"

creatives

object[]

The ad's creative assets. Each entry is an uploaded file id with an optional format; omit format for the original asset. Replaces a live ad's creative on the platform. Entries with no format replace it with a carousel's ordered cards — 2-10 of them on Meta, while TikTok runs even a single image as a one-card carousel.

Show child attributes

descriptions

string[]

The description variants shown on the ad.

existing_post_id

string

Promote a post you already published instead of uploading creatives — a Facebook post or Instagram media id. Mutually exclusive with creatives. Pair with post_source.

Example:

"xxxxxxxxxxxxxxxx_98765"

headlines

string[]

The headline variants shown on the ad.

lead_form

object

Instant lead form for the ad. Only allowed when the ad group's conversion_location is an instant-form destination (instant_forms, instant_forms_and_messenger, website_and_instant_forms). Mutually exclusive with lead_form_id.

Show child attributes

lead_form_id

string

Use an existing instant form instead of creating one — the form's platform ID, from a form already on the ad's Facebook page. Only allowed when the ad group's conversion_location is an instant-form destination. Mutually exclusive with lead_form. Replaces a stored lead_form.

Example:

"1037724182084885"

messaging_config

object

Click-to-message welcome copy: the greeting (message) and the ice-breaker prompt (keyword).

Show child attributes

multi_advertiser_ads

boolean

Whether the ad can appear alongside other advertisers' ads in the same unit. Defaults to true.

Example:

false

music

object | null

The looping track a TikTok carousel ad plays — an MP3 you uploaded, no larger than 10MB. Omitted leaves the ad's music untouched. Null removes it before launch; a submitted carousel takes a replacement track instead. TikTok-only.

Show child attributes

post_source

enum<string>

Identifies the network that owns existing_post_id. The source is inferred from the ID shape when omitted.

Available options:

facebook,

instagram

Example:

"facebook"

primary_texts

string[]

The primary text variants shown in the ad body.

The social accounts the ad runs under — a connected Facebook page and, optionally, an Instagram profile.

Show child attributes

title

string

The display name of the ad.

Example:

"Ceramic coating — spring hook v2"

url

string

The URL the ad links to. Query parameters are merged into url_parameters, so the stored URL is always bare.

Example:

"https://shinetime.example/ceramic-coating"

url_parameters

object

Query parameters to append to the destination URL, keyed by parameter name. Merged with any query string on url. Whop adds its own click-attribution parameters; those are reserved and rejected if you set them. Which keys are reserved depends on the ad's network — Meta: utm_meta_ad_id, utm_meta_adset_id, utm_meta_campaign_id, utm_source, utm_placement, utm_medium, utm_content, utm_adset, utm_whop, wacid, wasid, waid, tw_source, tw_adid; TikTok: waid, wasid, wacid, ad_id, adset_id, campaign_id, utm_source, utm_medium, utm_placement, utm_whop, tw_source, tw_adid.

Example:

{
  "placement": "{{placement}}",
  "ref": "spring"
}

Response

200 - application/json

ad switched to an existing post

ad_campaign

object

required

The ad campaign this ad belongs to.

Show child attributes

ad_group

object

required

The ad group this ad belongs to.

Show child attributes

added_to_cart_value

number

required

USD value attributed to add-to-cart events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

Example:

1850

added_to_carts

number

required

Whop pixel-attributed add-to-cart events, last-click.

Example:

74

call_to_action

enum<string> | null

required

The call-to-action button shown on the ad.

Available options:

learn_more,

shop_now,

sign_up,

subscribe,

get_started,

book_now,

apply_now,

contact_us,

download,

order_now,

buy_now,

get_quote,

message_page,

whatsapp_message,

instagram_message,

call_now,

get_directions,

send_updates,

get_offer,

watch_more,

listen_now,

play_game,

open_link,

no_button,

get_offer_view,

get_event_tickets,

see_menu,

request_time,

event_rsvp,

see_details,

view_instagram_profile,

null

Example:

"learn_more"

click_through_rate

number

required

Clicks divided by impressions, between 0 and 1.

Example:

0.0261

clicks

number

required

The number of clicks.

Example:

1337

completed_registration_value

number

required

USD value attributed to complete-registration events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

Example:

95

completed_registrations

number

required

Whop pixel-attributed complete-registration events, last-click.

Example:

19

contact_value

number

required

USD value attributed to contact events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

Example:

175

contacts

number

required

Whop pixel-attributed contact events, last-click.

Example:

27

cost_per_added_to_cart

number | null

required

Spend divided by attributed add-to-cart events; null when they are not the goal and none are attributed.

Example:

6.515675675675676

cost_per_click

number

required

Spend divided by clicks; 0 when there are no clicks.

Example:

0.36

cost_per_completed_registration

number | null

required

Spend divided by attributed complete-registration events; null when they are not the goal and none are attributed.

Example:

25.37684210526316

cost_per_contact

number | null

required

Spend divided by attributed contact events; null when contacts are not the goal and none are attributed.

Example:

17.85777777777778

cost_per_lead

number | null

required

Spend divided by attributed leads; null when leads are not a goal and none are attributed.

Example:

3.984793388429752

cost_per_mille

number

required

Spend per 1,000 impressions; 0 when there are no impressions.

Example:

9.42

cost_per_purchase

number | null

required

Spend divided by attributed purchases; null when purchases are not a goal and none are attributed.

Example:

12.68842105263158

cost_per_result

number | null

required

Spend divided by Whop pixel-attributed results; null when nothing Whop-attributable is being optimized for.

Example:

7.653333333333333

cost_per_schedule

number | null

required

Spend divided by attributed schedule events; null when schedules are not the goal and none are attributed.

Example:

10.48173913043478

cost_per_submitted_application

number | null

required

Spend divided by attributed submit-application events; null when they are not the goal and none are attributed.

Example:

40.18

cost_per_unique_click

number | null

required

Spend divided by unique clicks; null when there are no unique clicks.

Example:

0.48

cost_per_viewed_content

number | null

required

Spend divided by attributed view-content events; null when they are not the goal and none are attributed.

Example:

0.2253084112149533

created_at

string

required

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

Example:

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

creatives

object[]

required

Show child attributes

custom_conversions

number

required

Whop pixel-attributed custom (merchant-defined) conversion events, last-click, across all custom event names.

Example:

63

custom_event_counts

object

required

Whop pixel-attributed custom conversions, keyed by your event name with its last-click count as the value. Empty when no named custom events are attributed. Custom events fired without a name are counted in custom_conversions but omitted here, so these values sum to at most custom_conversions.

Example:

{ "booked_detail": 63 }

custom_event_values

object

required

Conversion value attributed to each custom event, keyed by event name like custom_event_counts. Sums the value passed to whop.track, normalized to USD; events fired without a value contribute 0.

Example:

{ "booked_detail": 4820 }

delivery_status

enum<string>

required

Whether the ad is delivering right now, and if not, why. When several states apply at once, the highest-precedence one is returned.

Available options:

rejected,

in_review,

draft,

campaign_paused,

ad_group_paused,

paused,

processing,

issues,

scheduled,

learning_limited,

learning,

active

Example:

"paused"

descriptions

string[]

required

The description variants shown on the ad.

existing_post_id

string | null

required

The post you pointed this ad at, when it promotes one you already published — a Facebook post, Instagram media, or TikTok video ID. null when the ad uses uploaded creatives.

Example:

"xxxxxxxxxxxxxxxx_98765"

frequency

number | null

required

Platform-reported impressions divided by reach.

headlines

string[]

required

The headline variants shown on the ad.

string

required

Unique identifier for the ad, prefixed ad_.

Example:

"ad_xxxxxxxxxxxxxx"

impressions

number

required

The number of impressions.

Example:

51204

issues

object[]

required

Show child attributes

lead_value

number

required

USD value attributed to lead events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

Example:

1180

leads

number

required

Whop pixel-attributed leads, last-click.

Example:

121

link_clicks

number

required

Clicks on links in the ad that lead to your destination, as reported by the ad platform. A subset of clicks, which also counts likes, comments, and other interactions with the ad.

Example:

1071

post_id

string | null

required

The post the ad network serves for this ad, as pageID_postID on Meta — the post Meta created for an uploaded creative, or the post being promoted. Use it to open the live post, or to promote the same post from another ad. null until the network has created the post.

Example:

"xxxxxxxxxxxxxxxx_98765"

post_source

enum<string> | null

required

Identifies the network that owns existing_post_id; null when the ad uses uploaded creatives.

Available options:

facebook,

instagram,

null

Example:

"facebook"

post_thumbnail_url

string | null

required

Preview image of the post named by existing_post_id. null for ads that use uploaded creatives, or until the post's media has been fetched from the network.

Example:

"https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

primary_texts

string[]

required

The primary text variants shown in the ad body.

purchase_value

number

required

USD value of pixel-attributed purchases.

Example:

9462

purchases

number

required

Whop pixel-attributed purchases, last-click.

Example:

38

reach

number

required

The number of unique people who saw this.

Example:

0

result_event

enum<string> | null

required

The Whop pixel conversion event whose attributed count represents results — the optimization goal, or the highest-volume attributed event for campaigns that budget per ad group. Null when the goal isn't a Whop-attributed event.

Available options:

purchase,

lead,

schedule,

submit_application,

contact,

complete_registration,

view_content,

add_to_cart,

custom,

messaging_conversation,

null

Example:

"custom"

result_event_name

string | null

required

The merchant-defined event name when result_event is custom; null for the standard events.

Example:

"booked_detail"

results

number | null

required

The Whop pixel-attributed count behind result_event. When a campaign's ad groups optimize different goals there is no single result_event (it is null), and this is instead the sum of each ad group's own attributed results. Null when nothing Whop-attributable is being optimized for.

Example:

63

return_on_ad_spend

number

required

Purchase value divided by spend, both in USD (a currency-neutral ratio); 0 when there is no spend.

Example:

19.62419113987058

schedule_value

number

required

USD value attributed to schedule events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

Example:

640

schedules

number

required

Whop pixel-attributed schedule events, last-click.

Example:

46

Show child attributes

spend

number

required

The amount charged, in spend_currency.

Example:

482.16

spend_currency

string | null

required

The ISO 4217 currency code of all monetary metrics.

Example:

"usd"

status

enum<string>

required

Whether the ad is enabled. active and paused are set by you; in_review and rejected come from ad review.

Available options:

active,

paused,

in_review,

rejected

Example:

"paused"

submitted_application_value

number

required

USD value attributed to submit-application events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

Example:

300

submitted_applications

number

required

Whop pixel-attributed submit-application events, last-click.

Example:

12

title

string | null

required

Display title of the ad.

Example:

"Ceramic coating — new ad group"

unique_click_through_rate

number | null

required

Unique clicks divided by impressions, between 0 and 1.

unique_clicks

number

required

People who clicked, reported by the Whop pixel, counted once per person.

Example:

1012

updated_at

string

required

When the ad was last updated, as an ISO 8601 timestamp.

Example:

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

url

string | null

required

The URL the ad links to, without its query string. Parameters belong in url_parameters; any you send on url are moved there.

Example:

"https://shinetime.example/ceramic-coating"

url_parameters

object

required

Every query parameter appended to the URL, keyed by parameter name — including any you sent on url itself. Whop adds its own click-attribution parameters on top; those are reserved and rejected if you set them. Which keys are reserved depends on the ad's network — Meta: utm_meta_ad_id, utm_meta_adset_id, utm_meta_campaign_id, utm_source, utm_placement, utm_medium, utm_content, utm_adset, utm_whop, wacid, wasid, waid, tw_source, tw_adid; TikTok: waid, wasid, wacid, ad_id, adset_id, campaign_id, utm_source, utm_medium, utm_placement, utm_whop, tw_source, tw_adid.

Example:

{}

viewed_content_value

number

required

USD value attributed to view-content events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

Example:

0

viewed_contents

number

required

Whop pixel-attributed view-content events, last-click.

Example:

2140

lead_form

object | null

The instant lead form shown when someone taps this ad. null when the ad group's conversion_location is not an instant-form destination.

Show child attributes

lead_form_id

string | null

The ad platform's ID for the instant form the ad uses. Set when the ad references an existing form via lead_form_id, or once a form built from lead_form has been created on the platform.

Example:

"1037724182084885"

messaging_config

object | null

Welcome message for click-to-message ads, shown when the conversation opens. null when the ad has none.

Show child attributes

multi_advertiser_ads

boolean

Whether the ad can appear alongside other advertisers' ads in the same unit. Defaults to true.

Example:

true

music

object | null

The advertiser-uploaded MP3 a TikTok carousel ad plays. TikTok-only; null elsewhere and for non-carousel ads.

Show child attributes

Introduction

Reference

Webhooks & Events

Core Resources

Notifications

Payments

Money

Commerce

Partners

Workforce

Tracking

Ads

Media

Identity

Developer

Authorizations

Headers

Path Parameters

Body

Response