Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.whop.com/llms.txt

Use this file to discover all available pages before exploring further.

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.