> ## 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.

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Overview: https://docs.whop.com/cli/overview.md Agent mode: https://docs.whop.com/cli/agent-mode.md
> Hosting: Whop serves a site or app from the build `whop apps deploy` uploads, with rollbacks, secrets, and server logs. Guide: https://docs.whop.com/developer/websites/hosting.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Guide: https://docs.whop.com/developer/guides/plugins/claude-code.md Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Sandbox guide: https://docs.whop.com/developer/guides/sandbox.md Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# API Ad Campaigns

> Une Ad Campaign est le conteneur de premier niveau des publicités payantes. Elle définit l'objectif et la stratégie budgétaire partagés par ses groupes d'annonces et ses annonces.

Une Ad Campaign est le conteneur de premier niveau des publicités payantes. Elle définit l'objectif et la stratégie budgétaire partagés par ses [groupes d'annonces](https://docs.whop.com/fr/api-reference/ad-groups/ad-group) et ses annonces.

Utilisez l'API Ad Campaigns pour créer des campagnes, lister les campagnes d'un compte, récupérer ou mettre à jour les paramètres d'une campagne, et mettre en pause ou reprendre la diffusion d'une campagne.

La facturation publicitaire regroupe les dépenses éligibles de toutes les campagnes du compte. Un paiement échoué bloque la diffusion avec `delivery_status: payment_failed` tout en conservant le `status` actif/en pause configuré. Corrigez le moyen de paiement du compte et [relancez son paiement publicitaire](https://docs.whop.com/fr/api-reference/accounts/retry-failed-ads-payments.md) une seule fois pour le compte. La relance est asynchrone : son acceptation ne confirme pas le paiement. Un règlement réussi lève le blocage ; les campagnes actives peuvent reprendre si elles sont par ailleurs éligibles, tandis que les campagnes en pause restent en pause. Consultez [facturation et relances](https://docs.whop.com/fr/developer/ads/overview.md#paying-for-ads).

## Endpoints

| Endpoint | Requête |
| - | - |
| [List Ad Campaigns](https://docs.whop.com/fr/api-reference/ad-campaigns/list-ad-campaigns.md) | GET `/ad_campaigns` |
| [Retrieve an Ad Campaign](https://docs.whop.com/fr/api-reference/ad-campaigns/retrieve-an-ad-campaign.md) | GET `/ad_campaigns/{id}` |
| [Create an Ad Campaign](https://docs.whop.com/fr/api-reference/ad-campaigns/create-an-ad-campaign.md) | POST `/ad_campaigns` |
| [Duplicate an Ad Campaign](https://docs.whop.com/fr/api-reference/ad-campaigns/duplicate-an-ad-campaign.md) | POST `/ad_campaigns/{id}/duplicate` |
| [Pause an Ad Campaign](https://docs.whop.com/fr/api-reference/ad-campaigns/pause-an-ad-campaign.md) | POST `/ad_campaigns/{id}/pause` |
| [Retry a Failed Ad Campaign Payment](https://docs.whop.com/fr/api-reference/ad-campaigns/retry-a-failed-ad-campaign-payment.md) | POST `/ad_campaigns/{id}/retry_payment` |
| [Unpause an Ad Campaign](https://docs.whop.com/fr/api-reference/ad-campaigns/unpause-an-ad-campaign.md) | POST `/ad_campaigns/{id}/unpause` |
| [Update an Ad Campaign](https://docs.whop.com/fr/api-reference/ad-campaigns/update-an-ad-campaign.md) | PATCH `/ad_campaigns/{id}` |
| [Delete an Ad Campaign](https://docs.whop.com/fr/api-reference/ad-campaigns/delete-an-ad-campaign.md) | DELETE `/ad_campaigns/{id}` |

## Attributs

**id** `string` *required*

Identifiant unique de la campagne publicitaire, préfixé par `adcamp_`.

**account** `object | null` *required*

L'entreprise qui gère cette campagne, avec le nom et le logo affichés par ses annonces.

> [accordion] Propriétés
>
> **id** `string` *required*
>
> ID du compte, préfixé par `biz_`.
>
> **logo\_url** `string | null` *required*
>
> URL de l'image du logo du compte. `null` lorsque le compte n'en a pas défini.
>
> **route** `string` *required*
>
> Identifiant de route public du compte, utilisé dans le chemin de la vitrine `whop.com/\{route}`.
>
> **title** `string` *required*
>
> Nom d'affichage du compte.

**added\_to\_cart\_value** `number` *required*

Valeur en USD attribuée aux événements d'ajout au panier. Additionne la valeur envoyée avec chaque événement, normalisée en USD ; les événements sans valeur comptent pour 0.

**added\_to\_carts** `number` *required*

Événements d'ajout au panier attribués par le pixel Whop, au dernier clic.

**budget\_amount** `number | null` *required*

Le budget de la campagne en USD, devise dans laquelle il est stocké et facturé. `null` lorsque chaque groupe d'annonces définit plutôt son propre budget.

**budget\_amount\_local** `number | null` *required*

Le même budget exprimé en `budget_currency` au taux de change du jour, pour l'affichage dans la devise de reporting publicitaire du compte. `null` lorsque `budget_amount` l'est.

**budget\_currency** `string` *required*

Le code ISO 4217 dans lequel est exprimé `budget_amount_local` : la préférence `ads_reporting_currency` du compte. `usd` sauf si le compte l'a modifiée.

**budget\_optimization** `string | null` *required*

Le niveau qui détient le budget : la campagne entière (`ad_campaign`) ou chaque groupe d'annonces individuellement (`ad_group`).

Options disponibles : `ad_campaign`, `ad_group`

**budget\_type** `string | null` *required*

Indique si `budget_amount` est dépensé par jour (`daily`) ou sur toute la durée de la campagne (`lifetime`).

Options disponibles : `daily`, `lifetime`

**campaign\_type** `string` *required*

Le type de campagne, fixé à la création. `standard` diffuse des annonces image et vidéo ; `search` affiche des annonces textuelles dans les résultats de recherche pour les mots-clés des groupes d'annonces.

Options disponibles : `standard`, `search`

**click\_through\_rate** `number` *required*

Clics divisés par les impressions, entre 0 et 1.

**clicks** `number` *required*

Le nombre de clics.

**completed\_registration\_value** `number` *required*

Valeur en USD attribuée aux événements d'inscription terminée. Additionne la valeur envoyée avec chaque événement, normalisée en USD ; les événements sans valeur comptent pour 0.

**completed\_registrations** `number` *required*

Événements d'inscription terminée attribués par le pixel Whop, au dernier clic.

**contact\_value** `number` *required*

Valeur en USD attribuée aux événements de contact. Additionne la valeur envoyée avec chaque événement, normalisée en USD ; les événements sans valeur comptent pour 0.

**contacts** `number` *required*

Événements de contact attribués par le pixel Whop, au dernier clic.

**cost\_per\_added\_to\_cart** `number | null` *required*

Dépenses divisées par les événements d'ajout au panier attribués ; null lorsqu'ils ne sont pas l'objectif et qu'aucun n'est attribué.

**cost\_per\_click** `number` *required*

Dépenses divisées par les clics ; 0 en l'absence de clics.

**cost\_per\_completed\_registration** `number | null` *required*

Dépenses divisées par les événements d'inscription terminée attribués ; null lorsqu'ils ne sont pas l'objectif et qu'aucun n'est attribué.

**cost\_per\_contact** `number | null` *required*

Dépenses divisées par les événements de contact attribués ; null lorsque les contacts ne sont pas l'objectif et qu'aucun n'est attribué.

**cost\_per\_lead** `number | null` *required*

Dépenses divisées par les leads attribués ; null lorsque les leads ne sont pas un objectif et qu'aucun n'est attribué.

**cost\_per\_mille** `number` *required*

Dépenses pour 1 000 impressions ; 0 en l'absence d'impressions.

**cost\_per\_purchase** `number | null` *required*

Dépenses divisées par les achats attribués ; null lorsque les achats ne sont pas un objectif et qu'aucun n'est attribué.

**cost\_per\_result** `number | null` *required*

Dépenses divisées par les résultats attribués par le pixel Whop ; null lorsque rien d'attribuable par Whop n'est optimisé.

**cost\_per\_schedule** `number | null` *required*

Dépenses divisées par les événements de prise de rendez-vous attribués ; null lorsque les rendez-vous ne sont pas l'objectif et qu'aucun n'est attribué.

**cost\_per\_submitted\_application** `number | null` *required*

Dépenses divisées par les événements de soumission de candidature attribués ; null lorsqu'ils ne sont pas l'objectif et qu'aucun n'est attribué.

**cost\_per\_unique\_click** `number | null` *required*

Dépenses divisées par les clics uniques ; null en l'absence de clics uniques.

**cost\_per\_viewed\_content** `number | null` *required*

Dépenses divisées par les événements de consultation de contenu attribués ; null lorsqu'ils ne sont pas l'objectif et qu'aucun n'est attribué.

**created\_at** `string` *required*

Date de création de la campagne, sous forme d'horodatage ISO 8601.

**custom\_conversions** `number` *required*

Événements de conversion personnalisés (définis par le marchand) attribués par le pixel Whop, au dernier clic, tous noms d'événements personnalisés confondus.

**custom\_event\_counts** `object` *required*

Conversions personnalisées attribuées par le pixel Whop, indexées par le nom de votre événement, avec leur nombre au dernier clic comme valeur. Vide lorsqu'aucun événement personnalisé nommé n'est attribué. Les événements personnalisés déclenchés sans nom sont comptés dans custom\_conversions mais omis ici, de sorte que la somme de ces valeurs est au plus égale à custom\_conversions.

**custom\_event\_values** `object` *required*

Valeur de conversion attribuée à chaque événement personnalisé, indexée par nom d'événement comme custom\_event\_counts. Additionne la valeur transmise à whop.track, normalisée en USD ; les événements déclenchés sans valeur comptent pour 0.

**delivery\_status** `string` *required*

Indique si les annonces de la campagne sont actuellement diffusées et, sinon, pourquoi. La vérification du contenu correspond à in\_review ; une campagne en attente de démarrage est en processing. Les échecs de facturation du compte définissent payment\_failed sans modifier le statut configuré. Une relance de paiement réussie lève ce blocage et recalcule la diffusion. Lorsque plusieurs états s'appliquent simultanément, celui ayant la priorité la plus élevée est renvoyé.

Options disponibles : `payment_failed`, `all_ads_rejected`, `draft`, `paused`, `in_review`, `learning`, `processing`, `revise_content`, `issues`, `scheduled`, `completed`, `active`

**desired\_cost\_per\_result** `number | null`

Le coût par résultat, en USD, que l'annonceur souhaite atteindre pour cette campagne. Il s'agit uniquement d'une cible : ce n'est ni une enchère, ni un plafond de coût, ni un plafond d'enchère, et cela ne modifie pas la façon dont les annonces de la campagne enchérissent. `null` lorsqu'aucune cible n'est définie.

**ends\_at** `string | null` *required*

Date à laquelle la campagne cesse d'être diffusée, sous forme d'horodatage ISO 8601. `null` lorsqu'elle est diffusée jusqu'à sa mise en pause, ou lorsque ses groupes d'annonces définissent leur propre calendrier.

**frequency** `number | null` *required*

Impressions divisées par la couverture.

**impressions** `number` *required*

Le nombre d'impressions.

**issues** `object[]` *required*

Problèmes ouverts affectant la campagne ainsi que ses groupes d'annonces et annonces descendants.

> [accordion] Propriétés
>
> **id** `string` *required*
>
> Identifiant unique du problème.
>
> **category** `string` *required*
>
> Le type de problème : une information sur la diffusion, un avertissement ou une erreur nécessitant une action.
>
> Options disponibles : `information`, `warning`, `error`
>
> **message** `string` *required*
>
> Une description du problème et de la manière de le résoudre.
>
> **resource\_id** `string | null` *required*
>
> L'ID de la campagne, du groupe d'annonces ou de l'annonce auquel le problème est rattaché.
>
> **resource\_type** `string` *required*
>
> Le type de ressource auquel le problème est rattaché.
>
> Options disponibles : `ad_campaign`, `ad_group`, `ad`
>
> **title** `string` *required*
>
> Un titre court du problème, destiné au créateur : la règle citée par un rejet lors de la vérification du contenu, ou un libellé générique.

**lead\_value** `number` *required*

Valeur en USD attribuée aux événements de lead. Additionne la valeur envoyée avec chaque événement, normalisée en USD ; les événements sans valeur comptent pour 0.

**leads** `number` *required*

Leads attribués par le pixel Whop, au dernier clic.

**link\_clicks** `number` *required*

Pages vues sur votre destination par les personnes ayant cliqué sur l'annonce, enregistrées par le pixel Whop. Comptabilisées de la même manière sur toutes les plateformes publicitaires.

**objective** `string | null` *required*

L'objectif vers lequel la campagne optimise. `awareness` n'apparaît que sur les campagnes créées avant son retrait ; ces campagnes ne peuvent pas être lancées.

Options disponibles : `awareness`, `traffic`, `engagement`, `leads`, `sales`

**purchase\_value** `number` *required*

Valeur en USD des achats attribués par le pixel.

**purchases** `number` *required*

Achats attribués par le pixel Whop, au dernier clic.

**reach** `number` *required*

Le nombre de personnes uniques ayant vu ceci.

**result\_event** `string | null` *required*

L'événement de conversion du pixel Whop dont le nombre attribué représente les résultats : l'objectif d'optimisation, ou l'événement attribué au volume le plus élevé pour les campagnes budgétées par groupe d'annonces. Null lorsque l'objectif n'est pas un événement attribué par Whop.

Options disponibles : `purchase`, `lead`, `schedule`, `submit_application`, `contact`, `complete_registration`, `view_content`, `add_to_cart`, `custom`, `messaging_conversation`

**result\_event\_name** `string | null` *required*

Le nom d'événement défini par le marchand lorsque result\_event vaut custom ; null pour les événements standard.

**results** `number | null` *required*

Le nombre attribué par le pixel Whop derrière result\_event. Lorsque les groupes d'annonces d'une campagne optimisent des objectifs différents, il n'y a pas de result\_event unique (il vaut null), et cette valeur correspond alors à la somme des résultats attribués propres à chaque groupe d'annonces. Null lorsque rien d'attribuable par Whop n'est optimisé.

**return\_on\_ad\_spend** `number` *required*

Valeur des achats divisée par les dépenses, toutes deux en USD (un ratio indépendant de la devise) ; 0 en l'absence de dépenses.

**schedule\_value** `number` *required*

Valeur en USD attribuée aux événements de prise de rendez-vous. Additionne la valeur envoyée avec chaque événement, normalisée en USD ; les événements sans valeur comptent pour 0.

**schedules** `number` *required*

Événements de prise de rendez-vous attribués par le pixel Whop, au dernier clic.

**special\_ad\_categories** `string[]` *required*

Catégories réglementées sous lesquelles la campagne est déclarée. Les annonces de ces catégories sont soumises à des restrictions de ciblage supplémentaires. Vide lorsqu'aucune ne s'applique.

Options disponibles : `housing`, `employment`, `financial_products`, `politics`

**spend** `number` *required*

Le montant facturé, en spend\_currency.

**spend\_currency** `string | null` *required*

Le code de devise ISO 4217 de toutes les métriques monétaires.

**starts\_at** `string | null` *required*

Date à laquelle la campagne commence à être diffusée, sous forme d'horodatage ISO 8601. `null` lorsqu'elle démarre dès son lancement, ou lorsque ses groupes d'annonces définissent leur propre calendrier.

**status** `string` *required*

Le statut de cycle de vie configuré de la campagne publicitaire. Les échecs de facturation conservent ici active ou paused et définissent delivery\_status sur payment\_failed.

Options disponibles : `active`, `paused`, `inactive`, `payment_failed`, `draft`, `duplicating`

**submitted\_application\_value** `number` *required*

Valeur en USD attribuée aux événements de soumission de candidature. Additionne la valeur envoyée avec chaque événement, normalisée en USD ; les événements sans valeur comptent pour 0.

**submitted\_applications** `number` *required*

Événements de soumission de candidature attribués par le pixel Whop, au dernier clic.

**target\_cost\_per\_result** `number | null` *required*

Le coût par résultat souhaité pour `target_result_event`, en USD. `null` lorsqu'aucun n'est défini.

**target\_result\_event** `string | null` *required*

L'événement sur la base duquel `target_cost_per_result` est calculé, par exemple `purchase` ou `lead`. `null` lorsque la campagne n'a pas d'objectif unique.

**title** `string` *required*

Nom d'affichage de la campagne publicitaire.

**unique\_click\_through\_rate** `number | null` *required*

Clics uniques divisés par les impressions, entre 0 et 1.

**unique\_clicks** `number` *required*

Personnes ayant cliqué, signalées par le pixel Whop, comptées une seule fois par personne.

**updated\_at** `string` *required*

Date de dernière mise à jour de la campagne, sous forme d'horodatage ISO 8601.

**viewed\_content\_value** `number` *required*

Valeur en USD attribuée aux événements de consultation de contenu. Additionne la valeur envoyée avec chaque événement, normalisée en USD ; les événements sans valeur comptent pour 0.

**viewed\_contents** `number` *required*

Événements de consultation de contenu attribués par le pixel Whop, au dernier clic.

```json AdCampaign theme={null}
{
	"id": "adcamp_xxxxxxxxxx",
	"account": {
		"id": "biz_xxxxxxxxxxxxx",
		"title": "Acme Studio",
		"route": "acme-studio",
		"logo_url": "https://img.whop.com/acme-studio-logo.png"
	},
	"added_to_cart_value": 2100,
	"added_to_carts": 42,
	"budget_amount": 250,
	"budget_amount_local": 250,
	"budget_currency": "usd",
	"budget_optimization": "ad_campaign",
	"budget_type": "daily",
	"campaign_type": "standard",
	"click_through_rate": 0.032,
	"clicks": 1200,
	"completed_registration_value": 0,
	"completed_registrations": 28,
	"contact_value": 0,
	"contacts": 18,
	"cost_per_added_to_cart": 17.86,
	"cost_per_click": 0.63,
	"cost_per_completed_registration": 26.79,
	"cost_per_contact": 41.67,
	"cost_per_lead": 30,
	"cost_per_mille": 20,
	"cost_per_purchase": 50,
	"cost_per_result": 50,
	"cost_per_schedule": null,
	"cost_per_submitted_application": null,
	"cost_per_unique_click": 0.74,
	"cost_per_viewed_content": 1.25,
	"created_at": "2026-06-01T12:00:00Z",
	"custom_conversions": 10,
	"custom_event_counts": {
		"QualifiedCall": 7,
		"BookedDemo": 3
	},
	"custom_event_values": {
		"QualifiedCall": 3500,
		"BookedDemo": 0
	},
	"delivery_status": "issues",
	"ends_at": null,
	"frequency": 2.1,
	"impressions": 37500,
	"issues": [
		{
			"id": "adiss_xxxxxxxxxxx",
			"category": "error",
			"title": "Ad issue",
			"message": "The ad's creative violates the ad network's policies. Edit the creative and resubmit for review.",
			"resource_id": "adcamp_xxxxxxxxxx",
			"resource_type": "ad_campaign"
		}
	],
	"lead_value": 1250,
	"leads": 25,
	"link_clicks": 960,
	"objective": "sales",
	"purchase_value": 12600,
	"purchases": 15,
	"reach": 17800,
	"result_event": "purchase",
	"result_event_name": null,
	"results": 15,
	"return_on_ad_spend": 16.8,
	"schedule_value": 0,
	"schedules": 0,
	"special_ad_categories": [],
	"spend": 750,
	"spend_currency": "usd",
	"starts_at": null,
	"status": "active",
	"submitted_application_value": 0,
	"submitted_applications": 0,
	"target_cost_per_result": 12.5,
	"target_result_event": "purchase",
	"title": "Pickaxe Pro launch",
	"unique_click_through_rate": 0.027,
	"unique_clicks": 1010,
	"updated_at": "2026-06-02T12:00:00Z",
	"viewed_content_value": 0,
	"viewed_contents": 600
}
```


## Related topics

- [Delete an Ad Campaign](https://docs.whop.com/fr/api-reference/ad-campaigns/delete-an-ad-campaign.md)
- [Ad campaign updated](https://docs.whop.com/fr/api-reference/ad-campaigns/ad-campaign-updated.md)
- [Create an Ad Campaign](https://docs.whop.com/fr/api-reference/ad-campaigns/create-an-ad-campaign.md)
