Update ad group

Updates an existing ad group.

Required permissions:

• ad_campaign:update
• ad_campaign:basic:read

PATCH /ad_groups/{id}

JavaScript

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('adgrp_xxxxxxxxxxxx');

console.log(adGroup.id);

200

{
  "id": "adgrp_xxxxxxxxxxxx",
  "title": "<string>",
  "created_at": "2023-12-01T05:00:00.401Z",
  "updated_at": "2023-12-01T05:00:00.401Z",
  "budget": 6.9,
  "ad_campaign": {
    "id": "adcamp_xxxxxxxxxxx"
  }
}

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 ***************************

Path Parameters

id · string · required

The unique identifier of the ad group to update.

Example:

"adgrp_xxxxxxxxxxxx"

Body

application/json

Parameters for UpdateAdGroupV2

budget · number | null

Budget amount in dollars.

Example:

6.9

budget_type · enum<string> | null

Whether the budget is daily or lifetime.

Available options: daily, lifetime

config · object

Unified ad group configuration (bidding, optimization, targeting).

Show child attributes

daily_budget · number | null

Daily budget in dollars.

Example:

6.9

name · string | null

Human-readable ad group name.

platform_config · object

Platform-specific ad group configuration.

Show child attributes

status · enum<string> | null

Status of the ad group.

Available options: active, paused, inactive, in_review, rejected, flagged

Response

200

application/json

A successful response

An ad group (ad set) belonging to an ad campaign.

id · string · required

The unique identifier for this ad group.

Example:

"adgrp_xxxxxxxxxxxx"

title · string | null · required

Human-readable name shown on the external platform.

status · enum<string> · required

Current operational status of the ad group.

Available options: active, paused, inactive, in_review, rejected, flagged

platform · enum<string> · required

The external ad platform this ad group is running on (e.g., meta, tiktok).

Available options: meta, tiktok

created_at · string<date-time> · required

When the ad group was created.

Example:

"2023-12-01T05:00:00.401Z"

updated_at · string<date-time> · required

When the ad group was last updated.

Example:

"2023-12-01T05:00:00.401Z"

budget · number | null · required

Budget amount in dollars.

Example:

6.9

budget_type · enum<string> | null · required

How the budget is allocated (daily or lifetime).

Available options: daily, lifetime

ad_campaign · object · required

The ad campaign this ad group belongs to.

Show child attributes