Update an Ad Group

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const adGroup = await client.adGroups.update('id');

console.log(adGroup.id);

curl --request PATCH \
  --url https://api.whop.com/api/v1/ad_groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "audiences": {
    "exclude": [
      "<string>"
    ],
    "include": [
      "<string>"
    ]
  },
  "budget_amount": 123,
  "demographics": {
    "automatic": true,
    "maximum_age": 123,
    "minimum_age": 123
  },
  "desired_cost_per_result": 123,
  "detailed_targeting": {
    "behaviors": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "demographics": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "interests": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ]
  },
  "devices": {
    "operating_systems": [
      {
        "minimum_version": "<string>"
      }
    ],
    "platforms": []
  },
  "ends_at": "<string>",
  "frequency_cap": {
    "maximum_impressions": 123,
    "per_days": 123
  },
  "languages": [
    "<string>"
  ],
  "message_apps": [],
  "minimum_daily_spend": 123,
  "placements": "automatic",
  "regions": {
    "exclude": {
      "cities": [
        {
          "key": "<string>",
          "name": "<string>"
        }
      ],
      "countries": [
        "<string>"
      ],
      "country_groups": [
        "<string>"
      ],
      "custom_locations": [
        {
          "latitude": 123,
          "longitude": 123,
          "radius": 123,
          "name": "<string>"
        }
      ],
      "regions": [
        "<string>"
      ],
      "zips": [
        "<string>"
      ]
    },
    "include": {
      "cities": [
        {
          "key": "<string>",
          "name": "<string>"
        }
      ],
      "countries": [
        "<string>"
      ],
      "country_groups": [
        "<string>"
      ],
      "custom_locations": [
        {
          "latitude": 123,
          "longitude": 123,
          "radius": 123,
          "name": "<string>"
        }
      ],
      "regions": [
        "<string>"
      ],
      "zips": [
        "<string>"
      ]
    }
  },
  "starts_at": "<string>",
  "title": "<string>"
}
'

import requests

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

payload = {
    "audiences": {
        "exclude": ["<string>"],
        "include": ["<string>"]
    },
    "budget_amount": 123,
    "demographics": {
        "automatic": True,
        "maximum_age": 123,
        "minimum_age": 123
    },
    "desired_cost_per_result": 123,
    "detailed_targeting": {
        "behaviors": [
            {
                "id": "<string>",
                "name": "<string>"
            }
        ],
        "demographics": [
            {
                "id": "<string>",
                "name": "<string>"
            }
        ],
        "interests": [
            {
                "id": "<string>",
                "name": "<string>"
            }
        ]
    },
    "devices": {
        "operating_systems": [{ "minimum_version": "<string>" }],
        "platforms": []
    },
    "ends_at": "<string>",
    "frequency_cap": {
        "maximum_impressions": 123,
        "per_days": 123
    },
    "languages": ["<string>"],
    "message_apps": [],
    "minimum_daily_spend": 123,
    "placements": "automatic",
    "regions": {
        "exclude": {
            "cities": [
                {
                    "key": "<string>",
                    "name": "<string>"
                }
            ],
            "countries": ["<string>"],
            "country_groups": ["<string>"],
            "custom_locations": [
                {
                    "latitude": 123,
                    "longitude": 123,
                    "radius": 123,
                    "name": "<string>"
                }
            ],
            "regions": ["<string>"],
            "zips": ["<string>"]
        },
        "include": {
            "cities": [
                {
                    "key": "<string>",
                    "name": "<string>"
                }
            ],
            "countries": ["<string>"],
            "country_groups": ["<string>"],
            "custom_locations": [
                {
                    "latitude": 123,
                    "longitude": 123,
                    "radius": 123,
                    "name": "<string>"
                }
            ],
            "regions": ["<string>"],
            "zips": ["<string>"]
        }
    },
    "starts_at": "<string>",
    "title": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/ad_groups/{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([
    'audiences' => [
        'exclude' => [
                '<string>'
        ],
        'include' => [
                '<string>'
        ]
    ],
    'budget_amount' => 123,
    'demographics' => [
        'automatic' => true,
        'maximum_age' => 123,
        'minimum_age' => 123
    ],
    'desired_cost_per_result' => 123,
    'detailed_targeting' => [
        'behaviors' => [
                [
                                'id' => '<string>',
                                'name' => '<string>'
                ]
        ],
        'demographics' => [
                [
                                'id' => '<string>',
                                'name' => '<string>'
                ]
        ],
        'interests' => [
                [
                                'id' => '<string>',
                                'name' => '<string>'
                ]
        ]
    ],
    'devices' => [
        'operating_systems' => [
                [
                                'minimum_version' => '<string>'
                ]
        ],
        'platforms' => [
                
        ]
    ],
    'ends_at' => '<string>',
    'frequency_cap' => [
        'maximum_impressions' => 123,
        'per_days' => 123
    ],
    'languages' => [
        '<string>'
    ],
    'message_apps' => [
        
    ],
    'minimum_daily_spend' => 123,
    'placements' => 'automatic',
    'regions' => [
        'exclude' => [
                'cities' => [
                                [
                                                                'key' => '<string>',
                                                                'name' => '<string>'
                                ]
                ],
                'countries' => [
                                '<string>'
                ],
                'country_groups' => [
                                '<string>'
                ],
                'custom_locations' => [
                                [
                                                                'latitude' => 123,
                                                                'longitude' => 123,
                                                                'radius' => 123,
                                                                'name' => '<string>'
                                ]
                ],
                'regions' => [
                                '<string>'
                ],
                'zips' => [
                                '<string>'
                ]
        ],
        'include' => [
                'cities' => [
                                [
                                                                'key' => '<string>',
                                                                'name' => '<string>'
                                ]
                ],
                'countries' => [
                                '<string>'
                ],
                'country_groups' => [
                                '<string>'
                ],
                'custom_locations' => [
                                [
                                                                'latitude' => 123,
                                                                'longitude' => 123,
                                                                'radius' => 123,
                                                                'name' => '<string>'
                                ]
                ],
                'regions' => [
                                '<string>'
                ],
                'zips' => [
                                '<string>'
                ]
        ]
    ],
    'starts_at' => '<string>',
    'title' => '<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_groups/{id}"

	payload := strings.NewReader("{\n  \"audiences\": {\n    \"exclude\": [\n      \"<string>\"\n    ],\n    \"include\": [\n      \"<string>\"\n    ]\n  },\n  \"budget_amount\": 123,\n  \"demographics\": {\n    \"automatic\": true,\n    \"maximum_age\": 123,\n    \"minimum_age\": 123\n  },\n  \"desired_cost_per_result\": 123,\n  \"detailed_targeting\": {\n    \"behaviors\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"demographics\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"interests\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ]\n  },\n  \"devices\": {\n    \"operating_systems\": [\n      {\n        \"minimum_version\": \"<string>\"\n      }\n    ],\n    \"platforms\": []\n  },\n  \"ends_at\": \"<string>\",\n  \"frequency_cap\": {\n    \"maximum_impressions\": 123,\n    \"per_days\": 123\n  },\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"message_apps\": [],\n  \"minimum_daily_spend\": 123,\n  \"placements\": \"automatic\",\n  \"regions\": {\n    \"exclude\": {\n      \"cities\": [\n        {\n          \"key\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"country_groups\": [\n        \"<string>\"\n      ],\n      \"custom_locations\": [\n        {\n          \"latitude\": 123,\n          \"longitude\": 123,\n          \"radius\": 123,\n          \"name\": \"<string>\"\n        }\n      ],\n      \"regions\": [\n        \"<string>\"\n      ],\n      \"zips\": [\n        \"<string>\"\n      ]\n    },\n    \"include\": {\n      \"cities\": [\n        {\n          \"key\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"country_groups\": [\n        \"<string>\"\n      ],\n      \"custom_locations\": [\n        {\n          \"latitude\": 123,\n          \"longitude\": 123,\n          \"radius\": 123,\n          \"name\": \"<string>\"\n        }\n      ],\n      \"regions\": [\n        \"<string>\"\n      ],\n      \"zips\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"starts_at\": \"<string>\",\n  \"title\": \"<string>\"\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_groups/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"audiences\": {\n    \"exclude\": [\n      \"<string>\"\n    ],\n    \"include\": [\n      \"<string>\"\n    ]\n  },\n  \"budget_amount\": 123,\n  \"demographics\": {\n    \"automatic\": true,\n    \"maximum_age\": 123,\n    \"minimum_age\": 123\n  },\n  \"desired_cost_per_result\": 123,\n  \"detailed_targeting\": {\n    \"behaviors\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"demographics\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"interests\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ]\n  },\n  \"devices\": {\n    \"operating_systems\": [\n      {\n        \"minimum_version\": \"<string>\"\n      }\n    ],\n    \"platforms\": []\n  },\n  \"ends_at\": \"<string>\",\n  \"frequency_cap\": {\n    \"maximum_impressions\": 123,\n    \"per_days\": 123\n  },\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"message_apps\": [],\n  \"minimum_daily_spend\": 123,\n  \"placements\": \"automatic\",\n  \"regions\": {\n    \"exclude\": {\n      \"cities\": [\n        {\n          \"key\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"country_groups\": [\n        \"<string>\"\n      ],\n      \"custom_locations\": [\n        {\n          \"latitude\": 123,\n          \"longitude\": 123,\n          \"radius\": 123,\n          \"name\": \"<string>\"\n        }\n      ],\n      \"regions\": [\n        \"<string>\"\n      ],\n      \"zips\": [\n        \"<string>\"\n      ]\n    },\n    \"include\": {\n      \"cities\": [\n        {\n          \"key\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"country_groups\": [\n        \"<string>\"\n      ],\n      \"custom_locations\": [\n        {\n          \"latitude\": 123,\n          \"longitude\": 123,\n          \"radius\": 123,\n          \"name\": \"<string>\"\n        }\n      ],\n      \"regions\": [\n        \"<string>\"\n      ],\n      \"zips\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"starts_at\": \"<string>\",\n  \"title\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/ad_groups/{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  \"audiences\": {\n    \"exclude\": [\n      \"<string>\"\n    ],\n    \"include\": [\n      \"<string>\"\n    ]\n  },\n  \"budget_amount\": 123,\n  \"demographics\": {\n    \"automatic\": true,\n    \"maximum_age\": 123,\n    \"minimum_age\": 123\n  },\n  \"desired_cost_per_result\": 123,\n  \"detailed_targeting\": {\n    \"behaviors\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"demographics\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"interests\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ]\n  },\n  \"devices\": {\n    \"operating_systems\": [\n      {\n        \"minimum_version\": \"<string>\"\n      }\n    ],\n    \"platforms\": []\n  },\n  \"ends_at\": \"<string>\",\n  \"frequency_cap\": {\n    \"maximum_impressions\": 123,\n    \"per_days\": 123\n  },\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"message_apps\": [],\n  \"minimum_daily_spend\": 123,\n  \"placements\": \"automatic\",\n  \"regions\": {\n    \"exclude\": {\n      \"cities\": [\n        {\n          \"key\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"country_groups\": [\n        \"<string>\"\n      ],\n      \"custom_locations\": [\n        {\n          \"latitude\": 123,\n          \"longitude\": 123,\n          \"radius\": 123,\n          \"name\": \"<string>\"\n        }\n      ],\n      \"regions\": [\n        \"<string>\"\n      ],\n      \"zips\": [\n        \"<string>\"\n      ]\n    },\n    \"include\": {\n      \"cities\": [\n        {\n          \"key\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"country_groups\": [\n        \"<string>\"\n      ],\n      \"custom_locations\": [\n        {\n          \"latitude\": 123,\n          \"longitude\": 123,\n          \"radius\": 123,\n          \"name\": \"<string>\"\n        }\n      ],\n      \"regions\": [\n        \"<string>\"\n      ],\n      \"zips\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"starts_at\": \"<string>\",\n  \"title\": \"<string>\"\n}"

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

{
  "ad_campaign": {
    "id": "<string>"
  },
  "added_to_cart_value": 123,
  "added_to_carts": 123,
  "audiences": {
    "exclude": [
      "<string>"
    ],
    "include": [
      "<string>"
    ]
  },
  "bid_type": "minimum_cost",
  "budget_amount": 123,
  "budget_type": "daily",
  "click_through_rate": 123,
  "clicks": 123,
  "completed_registration_value": 123,
  "completed_registrations": 123,
  "contact_value": 123,
  "contacts": 123,
  "conversion_location": "website",
  "cost_per_added_to_cart": 123,
  "cost_per_click": 123,
  "cost_per_completed_registration": 123,
  "cost_per_contact": 123,
  "cost_per_lead": 123,
  "cost_per_mille": 123,
  "cost_per_purchase": 123,
  "cost_per_result": 123,
  "cost_per_schedule": 123,
  "cost_per_submitted_application": 123,
  "cost_per_viewed_content": 123,
  "created_at": "<string>",
  "custom_conversions": 123,
  "custom_event_counts": {},
  "custom_event_values": {},
  "delivery_status": "all_ads_rejected",
  "demographics": {
    "automatic": true,
    "gender": "all",
    "maximum_age": 123,
    "minimum_age": 123
  },
  "desired_cost_per_result": 123,
  "detailed_targeting": {
    "behaviors": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "demographics": [
      {
        "id": "<string>",
        "type": "life_events",
        "name": "<string>"
      }
    ],
    "interests": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ]
  },
  "devices": {
    "operating_systems": [
      {
        "os": "ios",
        "minimum_version": "<string>"
      }
    ],
    "platforms": [
      "mobile"
    ]
  },
  "dynamic_creative": true,
  "ends_at": "<string>",
  "frequency": 123,
  "frequency_cap": {
    "maximum_impressions": 123,
    "per_days": 123
  },
  "id": "<string>",
  "impressions": 123,
  "issues": [
    {
      "id": "<string>",
      "message": "<string>",
      "resource_id": "<string>",
      "resource_type": "ad_campaign"
    }
  ],
  "languages": [
    "<string>"
  ],
  "lead_value": 123,
  "leads": 123,
  "message_apps": [
    "messenger"
  ],
  "minimum_daily_spend": 123,
  "optimization_goal": "conversions",
  "placements": [
    {
      "platform": "<string>",
      "positions": [
        "<string>"
      ]
    }
  ],
  "purchase_value": 123,
  "purchases": 123,
  "reach": 123,
  "regions": {
    "exclude": {
      "cities": [
        {
          "key": "<string>",
          "name": "<string>"
        }
      ],
      "countries": [
        "<string>"
      ],
      "country_groups": [
        "<string>"
      ],
      "custom_locations": [
        {
          "distance_unit": "mile",
          "latitude": 123,
          "longitude": 123,
          "radius": 123,
          "name": "<string>"
        }
      ],
      "regions": [
        "<string>"
      ],
      "zips": [
        "<string>"
      ]
    },
    "include": {
      "cities": [
        {
          "key": "<string>",
          "name": "<string>"
        }
      ],
      "countries": [
        "<string>"
      ],
      "country_groups": [
        "<string>"
      ],
      "custom_locations": [
        {
          "distance_unit": "mile",
          "latitude": 123,
          "longitude": 123,
          "radius": 123,
          "name": "<string>"
        }
      ],
      "regions": [
        "<string>"
      ],
      "zips": [
        "<string>"
      ]
    }
  },
  "result_event": "purchase",
  "result_event_name": "<string>",
  "results": 123,
  "return_on_ad_spend": 123,
  "schedule_value": 123,
  "schedules": 123,
  "spend": 123,
  "spend_currency": "<string>",
  "starts_at": "<string>",
  "status": "active",
  "submitted_application_value": 123,
  "submitted_applications": 123,
  "title": "<string>",
  "unique_click_through_rate": 123,
  "unique_clicks": 123,
  "updated_at": "<string>",
  "viewed_content_value": 123,
  "viewed_contents": 123
}

PATCH

ad_groups

{id}

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const adGroup = await client.adGroups.update('id');

console.log(adGroup.id);

curl --request PATCH \
  --url https://api.whop.com/api/v1/ad_groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "audiences": {
    "exclude": [
      "<string>"
    ],
    "include": [
      "<string>"
    ]
  },
  "budget_amount": 123,
  "demographics": {
    "automatic": true,
    "maximum_age": 123,
    "minimum_age": 123
  },
  "desired_cost_per_result": 123,
  "detailed_targeting": {
    "behaviors": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "demographics": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "interests": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ]
  },
  "devices": {
    "operating_systems": [
      {
        "minimum_version": "<string>"
      }
    ],
    "platforms": []
  },
  "ends_at": "<string>",
  "frequency_cap": {
    "maximum_impressions": 123,
    "per_days": 123
  },
  "languages": [
    "<string>"
  ],
  "message_apps": [],
  "minimum_daily_spend": 123,
  "placements": "automatic",
  "regions": {
    "exclude": {
      "cities": [
        {
          "key": "<string>",
          "name": "<string>"
        }
      ],
      "countries": [
        "<string>"
      ],
      "country_groups": [
        "<string>"
      ],
      "custom_locations": [
        {
          "latitude": 123,
          "longitude": 123,
          "radius": 123,
          "name": "<string>"
        }
      ],
      "regions": [
        "<string>"
      ],
      "zips": [
        "<string>"
      ]
    },
    "include": {
      "cities": [
        {
          "key": "<string>",
          "name": "<string>"
        }
      ],
      "countries": [
        "<string>"
      ],
      "country_groups": [
        "<string>"
      ],
      "custom_locations": [
        {
          "latitude": 123,
          "longitude": 123,
          "radius": 123,
          "name": "<string>"
        }
      ],
      "regions": [
        "<string>"
      ],
      "zips": [
        "<string>"
      ]
    }
  },
  "starts_at": "<string>",
  "title": "<string>"
}
'

import requests

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

payload = {
    "audiences": {
        "exclude": ["<string>"],
        "include": ["<string>"]
    },
    "budget_amount": 123,
    "demographics": {
        "automatic": True,
        "maximum_age": 123,
        "minimum_age": 123
    },
    "desired_cost_per_result": 123,
    "detailed_targeting": {
        "behaviors": [
            {
                "id": "<string>",
                "name": "<string>"
            }
        ],
        "demographics": [
            {
                "id": "<string>",
                "name": "<string>"
            }
        ],
        "interests": [
            {
                "id": "<string>",
                "name": "<string>"
            }
        ]
    },
    "devices": {
        "operating_systems": [{ "minimum_version": "<string>" }],
        "platforms": []
    },
    "ends_at": "<string>",
    "frequency_cap": {
        "maximum_impressions": 123,
        "per_days": 123
    },
    "languages": ["<string>"],
    "message_apps": [],
    "minimum_daily_spend": 123,
    "placements": "automatic",
    "regions": {
        "exclude": {
            "cities": [
                {
                    "key": "<string>",
                    "name": "<string>"
                }
            ],
            "countries": ["<string>"],
            "country_groups": ["<string>"],
            "custom_locations": [
                {
                    "latitude": 123,
                    "longitude": 123,
                    "radius": 123,
                    "name": "<string>"
                }
            ],
            "regions": ["<string>"],
            "zips": ["<string>"]
        },
        "include": {
            "cities": [
                {
                    "key": "<string>",
                    "name": "<string>"
                }
            ],
            "countries": ["<string>"],
            "country_groups": ["<string>"],
            "custom_locations": [
                {
                    "latitude": 123,
                    "longitude": 123,
                    "radius": 123,
                    "name": "<string>"
                }
            ],
            "regions": ["<string>"],
            "zips": ["<string>"]
        }
    },
    "starts_at": "<string>",
    "title": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/ad_groups/{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([
    'audiences' => [
        'exclude' => [
                '<string>'
        ],
        'include' => [
                '<string>'
        ]
    ],
    'budget_amount' => 123,
    'demographics' => [
        'automatic' => true,
        'maximum_age' => 123,
        'minimum_age' => 123
    ],
    'desired_cost_per_result' => 123,
    'detailed_targeting' => [
        'behaviors' => [
                [
                                'id' => '<string>',
                                'name' => '<string>'
                ]
        ],
        'demographics' => [
                [
                                'id' => '<string>',
                                'name' => '<string>'
                ]
        ],
        'interests' => [
                [
                                'id' => '<string>',
                                'name' => '<string>'
                ]
        ]
    ],
    'devices' => [
        'operating_systems' => [
                [
                                'minimum_version' => '<string>'
                ]
        ],
        'platforms' => [
                
        ]
    ],
    'ends_at' => '<string>',
    'frequency_cap' => [
        'maximum_impressions' => 123,
        'per_days' => 123
    ],
    'languages' => [
        '<string>'
    ],
    'message_apps' => [
        
    ],
    'minimum_daily_spend' => 123,
    'placements' => 'automatic',
    'regions' => [
        'exclude' => [
                'cities' => [
                                [
                                                                'key' => '<string>',
                                                                'name' => '<string>'
                                ]
                ],
                'countries' => [
                                '<string>'
                ],
                'country_groups' => [
                                '<string>'
                ],
                'custom_locations' => [
                                [
                                                                'latitude' => 123,
                                                                'longitude' => 123,
                                                                'radius' => 123,
                                                                'name' => '<string>'
                                ]
                ],
                'regions' => [
                                '<string>'
                ],
                'zips' => [
                                '<string>'
                ]
        ],
        'include' => [
                'cities' => [
                                [
                                                                'key' => '<string>',
                                                                'name' => '<string>'
                                ]
                ],
                'countries' => [
                                '<string>'
                ],
                'country_groups' => [
                                '<string>'
                ],
                'custom_locations' => [
                                [
                                                                'latitude' => 123,
                                                                'longitude' => 123,
                                                                'radius' => 123,
                                                                'name' => '<string>'
                                ]
                ],
                'regions' => [
                                '<string>'
                ],
                'zips' => [
                                '<string>'
                ]
        ]
    ],
    'starts_at' => '<string>',
    'title' => '<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_groups/{id}"

	payload := strings.NewReader("{\n  \"audiences\": {\n    \"exclude\": [\n      \"<string>\"\n    ],\n    \"include\": [\n      \"<string>\"\n    ]\n  },\n  \"budget_amount\": 123,\n  \"demographics\": {\n    \"automatic\": true,\n    \"maximum_age\": 123,\n    \"minimum_age\": 123\n  },\n  \"desired_cost_per_result\": 123,\n  \"detailed_targeting\": {\n    \"behaviors\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"demographics\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"interests\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ]\n  },\n  \"devices\": {\n    \"operating_systems\": [\n      {\n        \"minimum_version\": \"<string>\"\n      }\n    ],\n    \"platforms\": []\n  },\n  \"ends_at\": \"<string>\",\n  \"frequency_cap\": {\n    \"maximum_impressions\": 123,\n    \"per_days\": 123\n  },\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"message_apps\": [],\n  \"minimum_daily_spend\": 123,\n  \"placements\": \"automatic\",\n  \"regions\": {\n    \"exclude\": {\n      \"cities\": [\n        {\n          \"key\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"country_groups\": [\n        \"<string>\"\n      ],\n      \"custom_locations\": [\n        {\n          \"latitude\": 123,\n          \"longitude\": 123,\n          \"radius\": 123,\n          \"name\": \"<string>\"\n        }\n      ],\n      \"regions\": [\n        \"<string>\"\n      ],\n      \"zips\": [\n        \"<string>\"\n      ]\n    },\n    \"include\": {\n      \"cities\": [\n        {\n          \"key\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"country_groups\": [\n        \"<string>\"\n      ],\n      \"custom_locations\": [\n        {\n          \"latitude\": 123,\n          \"longitude\": 123,\n          \"radius\": 123,\n          \"name\": \"<string>\"\n        }\n      ],\n      \"regions\": [\n        \"<string>\"\n      ],\n      \"zips\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"starts_at\": \"<string>\",\n  \"title\": \"<string>\"\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_groups/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"audiences\": {\n    \"exclude\": [\n      \"<string>\"\n    ],\n    \"include\": [\n      \"<string>\"\n    ]\n  },\n  \"budget_amount\": 123,\n  \"demographics\": {\n    \"automatic\": true,\n    \"maximum_age\": 123,\n    \"minimum_age\": 123\n  },\n  \"desired_cost_per_result\": 123,\n  \"detailed_targeting\": {\n    \"behaviors\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"demographics\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"interests\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ]\n  },\n  \"devices\": {\n    \"operating_systems\": [\n      {\n        \"minimum_version\": \"<string>\"\n      }\n    ],\n    \"platforms\": []\n  },\n  \"ends_at\": \"<string>\",\n  \"frequency_cap\": {\n    \"maximum_impressions\": 123,\n    \"per_days\": 123\n  },\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"message_apps\": [],\n  \"minimum_daily_spend\": 123,\n  \"placements\": \"automatic\",\n  \"regions\": {\n    \"exclude\": {\n      \"cities\": [\n        {\n          \"key\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"country_groups\": [\n        \"<string>\"\n      ],\n      \"custom_locations\": [\n        {\n          \"latitude\": 123,\n          \"longitude\": 123,\n          \"radius\": 123,\n          \"name\": \"<string>\"\n        }\n      ],\n      \"regions\": [\n        \"<string>\"\n      ],\n      \"zips\": [\n        \"<string>\"\n      ]\n    },\n    \"include\": {\n      \"cities\": [\n        {\n          \"key\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"country_groups\": [\n        \"<string>\"\n      ],\n      \"custom_locations\": [\n        {\n          \"latitude\": 123,\n          \"longitude\": 123,\n          \"radius\": 123,\n          \"name\": \"<string>\"\n        }\n      ],\n      \"regions\": [\n        \"<string>\"\n      ],\n      \"zips\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"starts_at\": \"<string>\",\n  \"title\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/ad_groups/{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  \"audiences\": {\n    \"exclude\": [\n      \"<string>\"\n    ],\n    \"include\": [\n      \"<string>\"\n    ]\n  },\n  \"budget_amount\": 123,\n  \"demographics\": {\n    \"automatic\": true,\n    \"maximum_age\": 123,\n    \"minimum_age\": 123\n  },\n  \"desired_cost_per_result\": 123,\n  \"detailed_targeting\": {\n    \"behaviors\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"demographics\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"interests\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ]\n  },\n  \"devices\": {\n    \"operating_systems\": [\n      {\n        \"minimum_version\": \"<string>\"\n      }\n    ],\n    \"platforms\": []\n  },\n  \"ends_at\": \"<string>\",\n  \"frequency_cap\": {\n    \"maximum_impressions\": 123,\n    \"per_days\": 123\n  },\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"message_apps\": [],\n  \"minimum_daily_spend\": 123,\n  \"placements\": \"automatic\",\n  \"regions\": {\n    \"exclude\": {\n      \"cities\": [\n        {\n          \"key\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"country_groups\": [\n        \"<string>\"\n      ],\n      \"custom_locations\": [\n        {\n          \"latitude\": 123,\n          \"longitude\": 123,\n          \"radius\": 123,\n          \"name\": \"<string>\"\n        }\n      ],\n      \"regions\": [\n        \"<string>\"\n      ],\n      \"zips\": [\n        \"<string>\"\n      ]\n    },\n    \"include\": {\n      \"cities\": [\n        {\n          \"key\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"country_groups\": [\n        \"<string>\"\n      ],\n      \"custom_locations\": [\n        {\n          \"latitude\": 123,\n          \"longitude\": 123,\n          \"radius\": 123,\n          \"name\": \"<string>\"\n        }\n      ],\n      \"regions\": [\n        \"<string>\"\n      ],\n      \"zips\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"starts_at\": \"<string>\",\n  \"title\": \"<string>\"\n}"

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

{
  "ad_campaign": {
    "id": "<string>"
  },
  "added_to_cart_value": 123,
  "added_to_carts": 123,
  "audiences": {
    "exclude": [
      "<string>"
    ],
    "include": [
      "<string>"
    ]
  },
  "bid_type": "minimum_cost",
  "budget_amount": 123,
  "budget_type": "daily",
  "click_through_rate": 123,
  "clicks": 123,
  "completed_registration_value": 123,
  "completed_registrations": 123,
  "contact_value": 123,
  "contacts": 123,
  "conversion_location": "website",
  "cost_per_added_to_cart": 123,
  "cost_per_click": 123,
  "cost_per_completed_registration": 123,
  "cost_per_contact": 123,
  "cost_per_lead": 123,
  "cost_per_mille": 123,
  "cost_per_purchase": 123,
  "cost_per_result": 123,
  "cost_per_schedule": 123,
  "cost_per_submitted_application": 123,
  "cost_per_viewed_content": 123,
  "created_at": "<string>",
  "custom_conversions": 123,
  "custom_event_counts": {},
  "custom_event_values": {},
  "delivery_status": "all_ads_rejected",
  "demographics": {
    "automatic": true,
    "gender": "all",
    "maximum_age": 123,
    "minimum_age": 123
  },
  "desired_cost_per_result": 123,
  "detailed_targeting": {
    "behaviors": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "demographics": [
      {
        "id": "<string>",
        "type": "life_events",
        "name": "<string>"
      }
    ],
    "interests": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ]
  },
  "devices": {
    "operating_systems": [
      {
        "os": "ios",
        "minimum_version": "<string>"
      }
    ],
    "platforms": [
      "mobile"
    ]
  },
  "dynamic_creative": true,
  "ends_at": "<string>",
  "frequency": 123,
  "frequency_cap": {
    "maximum_impressions": 123,
    "per_days": 123
  },
  "id": "<string>",
  "impressions": 123,
  "issues": [
    {
      "id": "<string>",
      "message": "<string>",
      "resource_id": "<string>",
      "resource_type": "ad_campaign"
    }
  ],
  "languages": [
    "<string>"
  ],
  "lead_value": 123,
  "leads": 123,
  "message_apps": [
    "messenger"
  ],
  "minimum_daily_spend": 123,
  "optimization_goal": "conversions",
  "placements": [
    {
      "platform": "<string>",
      "positions": [
        "<string>"
      ]
    }
  ],
  "purchase_value": 123,
  "purchases": 123,
  "reach": 123,
  "regions": {
    "exclude": {
      "cities": [
        {
          "key": "<string>",
          "name": "<string>"
        }
      ],
      "countries": [
        "<string>"
      ],
      "country_groups": [
        "<string>"
      ],
      "custom_locations": [
        {
          "distance_unit": "mile",
          "latitude": 123,
          "longitude": 123,
          "radius": 123,
          "name": "<string>"
        }
      ],
      "regions": [
        "<string>"
      ],
      "zips": [
        "<string>"
      ]
    },
    "include": {
      "cities": [
        {
          "key": "<string>",
          "name": "<string>"
        }
      ],
      "countries": [
        "<string>"
      ],
      "country_groups": [
        "<string>"
      ],
      "custom_locations": [
        {
          "distance_unit": "mile",
          "latitude": 123,
          "longitude": 123,
          "radius": 123,
          "name": "<string>"
        }
      ],
      "regions": [
        "<string>"
      ],
      "zips": [
        "<string>"
      ]
    }
  },
  "result_event": "purchase",
  "result_event_name": "<string>",
  "results": 123,
  "return_on_ad_spend": 123,
  "schedule_value": 123,
  "schedules": 123,
  "spend": 123,
  "spend_currency": "<string>",
  "starts_at": "<string>",
  "status": "active",
  "submitted_application_value": 123,
  "submitted_applications": 123,
  "title": "<string>",
  "unique_click_through_rate": 123,
  "unique_clicks": 123,
  "updated_at": "<string>",
  "viewed_content_value": 123,
  "viewed_contents": 123
}

Authorizations

Authorization

string

header

required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-07-18"

Path Parameters

string

required

The ad group ID.

Body

application/json

audiences

object

Saved audiences to deliver to or exclude. Can't be combined with demographics.automatic.

Show child attributes

bid_type

enum<string>

How delivery bids in the ad auction: minimum_cost gets the most results for the budget, average_target keeps the average cost per result near desired_cost_per_result, and maximum_target never bids above it.

Available options:

minimum_cost,

average_target,

maximum_target

budget_amount

number

This ad group's budget, in the ad account's currency. Omit when the budget is set on the campaign instead.

budget_type

enum<string>

Whether budget_amount is spent per day (daily) or over the ad group's full run (lifetime).

Available options:

daily,

lifetime

conversion_event

The pixel event optimized for. A standard event, or any custom pixel event name.

Available options:

purchase,

add_to_cart,

initiated_checkout,

add_payment_info,

complete_registration,

lead,

content_view,

search,

contact,

customize_product,

donate,

find_location,

schedule,

start_trial,

submit_application,

subscribe

conversion_location

enum<string>

Where the result you're optimizing for happens: website (your site), profile (your social media profile), messaging (a direct-message conversation), on_ad (engagement with the ad itself), or a lead form (instant_forms, instant_forms_and_messenger, website_and_instant_forms). The lead form itself is set on the ad.

Available options:

website,

profile,

messaging,

on_ad,

instant_forms,

instant_forms_and_messenger,

website_and_instant_forms

demographics

object

Age, gender, and automatic-audience targeting.

Show child attributes

desired_cost_per_result

number

Cost per result to aim for (average_target) or never exceed (maximum_target).

detailed_targeting

object

Interest, behavior, and demographic targeting, using categories from the ad platform's targeting taxonomy. At most 100 entries per section. Can't be combined with demographics.automatic, and unavailable to campaigns with special_ad_categories. Send the complete intended state — a section you omit is cleared.

Show child attributes

devices

object

Device platforms and operating systems to target.

Show child attributes

ends_at

string

When the ad group stops delivering, as an ISO 8601 timestamp. Omit to run until paused.

frequency_cap

object

Cap on how often one person sees ads from this ad group. Only available with reach optimization.

Show child attributes

languages

string[]

Languages to target, as ISO 639 codes such as en or es. Empty or omitted targets all languages.

message_apps

enum<string>[]

Apps the conversation opens in. Required when conversion_location is messaging.

Available options:

messenger,

instagram,

whatsapp

minimum_daily_spend

number

Minimum the ad group tries to spend each day.

optimization_goal

enum<string>

The result the ad group's delivery is optimized to get the most of.

Available options:

conversions,

link_clicks,

landing_page_views,

reach,

impressions,

engagement,

conversations,

video_views,

thruplay,

two_second_views,

page_likes,

social_profile,

ad_recall_lift,

event_responses,

reminders_set,

lead_generation,

quality_lead,

value,

profile_and_page_engagement

placements

automatic to let the ad platform choose placements, or the list of platforms and positions to target. Omit a platform's positions to target all of them.

Valid positions per platform:

facebook: feed, right_hand_column, marketplace, search, profile_feed, notification, story, instream_video, facebook_reels, facebook_reels_overlay, biz_disco_feed
instagram: stream, story, explore, explore_home, reels, profile_feed, profile_reels, ig_search
messenger: story
audience_network: classic, rewarded_video
threads: threads_stream
whatsapp: status

Available options:

automatic

regions

object

Locations to target and exclude.

Show child attributes

starts_at

string

When the ad group starts delivering, as an ISO 8601 timestamp. Omit to start as soon as it's active.

status

enum<string>

Initial status (default: active).

Available options:

active,

paused

title

string

The display name of the ad group.

Response

200 - application/json

ad group updated

ad_campaign

object

required

The ad campaign this ad group 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.

added_to_carts

number

required

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

audiences

object

required

Saved audiences this ad group delivers to or excludes.

Show child attributes

bid_type

enum<string> | null

required

How delivery bids in the ad auction: minimum_cost gets the most results for the budget, average_target keeps the average cost per result near desired_cost_per_result, and maximum_target never bids above it.

Available options:

minimum_cost,

average_target,

maximum_target,

null

Example:

"minimum_cost"

budget_amount

number | null

required

This ad group's budget, in the ad account's currency. null when the budget is set on the campaign instead.

budget_type

enum<string> | null

required

Whether budget_amount is spent per day (daily) or over the ad group's full run (lifetime).

Available options:

daily,

lifetime,

null

Example:

"daily"

click_through_rate

number

required

Clicks divided by impressions, between 0 and 1.

clicks

number

required

The number of clicks.

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.

completed_registrations

number

required

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

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.

contacts

number

required

Whop pixel-attributed contact events, last-click.

conversion_event

required

The pixel event optimized for. A standard event, or any custom pixel event name.

Available options:

purchase,

add_to_cart,

initiated_checkout,

add_payment_info,

complete_registration,

lead,

content_view,

search,

contact,

customize_product,

donate,

find_location,

schedule,

start_trial,

submit_application,

subscribe

conversion_location

enum<string> | null

required

Available options:

website,

profile,

messaging,

on_ad,

instant_forms,

instant_forms_and_messenger,

website_and_instant_forms,

null

Example:

"website"

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.

cost_per_click

number

required

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

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.

cost_per_contact

number | null

required

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

cost_per_lead

number | null

required

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

cost_per_mille

number

required

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

cost_per_purchase

number | null

required

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

cost_per_result

number | null

required

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

cost_per_schedule

number | null

required

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

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.

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.

created_at

string

required

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

custom_conversions

number

required

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

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.

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.

delivery_status

enum<string>

required

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

Available options:

all_ads_rejected,

rejected,

draft,

no_ads,

campaign_paused,

paused,

processing,

issues,

scheduled,

completed,

ads_off,

learning_limited,

learning,

active

Example:

"all_ads_rejected"

demographics

object

required

Age, gender, and automatic-audience targeting.

Show child attributes

desired_cost_per_result

number | null

required

Cost per result to aim for (average_target) or never exceed (maximum_target). null for minimum_cost bidding.

detailed_targeting

object

required

Interest, behavior, and demographic targeting, using categories from the ad platform's targeting taxonomy. Can't be combined with automatic audience targeting, and unavailable to campaigns with special_ad_categories.

Show child attributes

devices

object

required

Device platforms and operating systems targeted.

Show child attributes

dynamic_creative

boolean

required

Whether the ad platform automatically mixes and matches this ad group's creatives and copy to find the best-performing combinations.

ends_at

string | null

required

When the ad group stops delivering, as an ISO 8601 timestamp. null when it runs until paused.

frequency

number | null

required

Platform-reported impressions divided by reach.

frequency_cap

object | null

required

Cap on how often one person sees ads from this ad group. Only available with reach optimization; null when uncapped.

Show child attributes

string

required

Unique identifier for the ad group, prefixed adgrp_.

impressions

number

required

The number of impressions.

issues

object[]

required

Show child attributes

languages

string[]

required

Languages targeted, as ISO 639 codes such as en or es. A region-specific locale with no ISO code appears as its numeric platform locale key. Empty targets all languages.

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.

leads

number

required

Whop pixel-attributed leads, last-click.

message_apps

enum<string>[]

required

Apps the conversation opens in when conversion_location is messaging. Empty for other conversion locations.

Available options:

messenger,

instagram,

whatsapp

minimum_daily_spend

number | null

required

Minimum the ad group tries to spend each day. null when no floor is set.

optimization_goal

enum<string> | null

required

The result the ad group's delivery is optimized to get the most of.

Available options:

conversions,

link_clicks,

landing_page_views,

reach,

impressions,

engagement,

conversations,

video_views,

two_second_views,

page_likes,

social_profile,

ad_recall_lift,

event_responses,

reminders_set,

lead_generation,

quality_lead,

value,

profile_and_page_engagement,

null

Example:

"conversions"

placements

object[]

required

Show child attributes

purchase_value

number

required

USD value of pixel-attributed purchases.

purchases

number

required

Whop pixel-attributed purchases, last-click.

reach

number

required

The number of unique people who saw this.

regions

object

required

Locations targeted and excluded.

Show child attributes

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,

null

Example:

"purchase"

result_event_name

string | null

required

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

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.

return_on_ad_spend

number

required

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

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.

schedules

number

required

Whop pixel-attributed schedule events, last-click.

spend

number

required

The amount charged, in spend_currency.

spend_currency

string | null

required

The ISO 4217 currency code of all monetary metrics.

starts_at

string | null

required

When the ad group starts delivering, as an ISO 8601 timestamp. null when it starts as soon as it's active.

status

enum<string>

required

Whether the ad group is enabled. active and paused are set by you; rejected means it failed ad review.

Available options:

active,

paused,

rejected

Example:

"active"

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.

submitted_applications

number

required

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

title

string | null

required

Display name of the ad group.

unique_click_through_rate

number | null

required

Unique clicks divided by impressions, between 0 and 1.

unique_clicks

number

required

The number of unique clicks.

updated_at

string

required

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

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.

viewed_contents

number

required

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

Retrieve an Ad Group

Delete an Ad Group

⌘I

Introduction

Reference

Core Resources

Money

Commerce

Partners

Workforce

Tracking

Ads

Media

Identity

Developer

Update an Ad Group

Authorizations

Headers

Path Parameters

Body

Response