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

> Une Automation est une chaîne d'étapes que les membres parcourent une par une.

Un membre est inscrit lorsque le `trigger_event` de l'automatisation se produit pour lui, comme `payment.succeeded`. Vous pouvez aussi inscrire un membre avec `POST /automations/{id}/trigger`. Une étape `wait` le met en attente pendant une durée définie. Une étape `email` ou `message` exécute son `source_code`, un module TSX qui lit les données du membre via l'API. Le module décide s'il faut envoyer et quoi dire.

Les étapes sont versionnées. Vous modifiez la version brouillon. `POST /automations/{id}/publish` en fait la version sur laquelle démarrent les nouveaux membres, puis la copie dans le brouillon suivant. Chaque publication fait passer les membres déjà présents dans l'automatisation à la nouvelle version. Utilisez l'API Automations pour créer, publier et déclencher des automatisations, et pour les mettre à jour, y compris leur statut. Utilisez les API Automation steps et Automation enrollments pour leurs étapes et leurs membres.

## Endpoints

| Endpoint | Requête |
| - | - |
| [List Automations](https://docs.whop.com/fr/api-reference/automations/list-automations.md) | GET `/automations` |
| [Retrieve Automation](https://docs.whop.com/fr/api-reference/automations/retrieve-automation.md) | GET `/automations/{id}` |
| [Create Automation](https://docs.whop.com/fr/api-reference/automations/create-automation.md) | POST `/automations` |
| [Publish Automation](https://docs.whop.com/fr/api-reference/automations/publish-automation.md) | POST `/automations/{id}/publish` |
| [Trigger Automation](https://docs.whop.com/fr/api-reference/automations/trigger-automation.md) | POST `/automations/{id}/trigger` |
| [Update Automation](https://docs.whop.com/fr/api-reference/automations/update-automation.md) | PATCH `/automations/{id}` |
| [Delete Automation](https://docs.whop.com/fr/api-reference/automations/delete-automation.md) | DELETE `/automations/{id}` |

## Attributs

**id** `string` *required*

ID de l'automatisation, préfixé par `ato_`.

**account\_id** `string` *required*

ID du compte auquel appartient l'automatisation, préfixé par `biz_`.

**active\_enrollments\_count** `integer` *required*

Membres actuellement dans l'automatisation.

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

Date de création de l'automatisation, sous forme d'horodatage ISO 8601.

**created\_by\_actor** `object` *required*

Qui a créé l'automatisation.

> [accordion] Propriétés
>
> **id** `string` *required*
>
> ID de l'utilisateur, du compte ou de l'app, préfixé par `user_`, `biz_` ou `app_`.
>
> **object** `string` *required*
>
> Ce qui a agi : un `user`, un `account` via l'une de ses clés API, ou une `app`.
>
> Options disponibles : `user`, `account`, `app`

**draft\_version** `integer` *required*

La version modifiée par les modifications d'étapes. Toujours égale à `published_version` plus un, ou `1` avant la première publication.

**has\_unpublished\_changes** `boolean` *required*

Indique si le brouillon comporte des modifications que `POST /automations/\{id}/publish` publierait. Toujours `true` avant la première publication.

**name** `string` *required*

Le nom de l'automatisation, affiché dans le tableau de bord. Jusqu'à 255 caractères.

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

Date de dernière publication de l'automatisation, sous forme d'horodatage ISO 8601. `null` jusqu'à sa première publication.

**published\_by\_actor** `object | null` *required*

Qui a publié l'automatisation en dernier. `null` jusqu'à sa première publication.

> [accordion] Propriétés
>
> **id** `string` *required*
>
> ID de l'utilisateur, du compte ou de l'app, préfixé par `user_`, `biz_` ou `app_`.
>
> **object** `string` *required*
>
> Ce qui a agi : un `user`, un `account` via l'une de ses clés API, ou une `app`.
>
> Options disponibles : `user`, `account`, `app`

**published\_version** `integer | null` *required*

La version sur laquelle démarrent les nouveaux membres. `null` jusqu'à la première publication de l'automatisation.

**secret\_names** `string[]` *required*

Noms des secrets de l'automatisation, que le code de ses étapes lit comme variables d'environnement. Leurs valeurs ne sont jamais renvoyées.

**status** `string` *required*

`active` inscrit les membres et exécute leurs étapes. `closed` n'inscrit plus personne, et les membres déjà présents terminent. `stopped` n'inscrit personne, et les inscriptions de ses membres sont terminées. Une nouvelle automatisation est `stopped` jusqu'à ce que sa première publication la rende `active`.

Options disponibles : `active`, `closed`, `stopped`

**total\_enrollments\_count** `integer` *required*

Nombre de fois où des membres se sont inscrits à l'automatisation, y compris les inscriptions terminées.

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

L'événement webhook qui inscrit le membre concerné, comme `payment.succeeded`. `null` pour une automatisation dans laquelle seul `POST /automations/\{id}/trigger` inscrit. Fixé une fois l'automatisation publiée.

Options disponibles : `payment.succeeded`, `payment.failed`, `membership.activated`, `membership.trial_ending_soon`, `member.created`, `invoice.created`, `invoice.paid`, `invoice.past_due`, `refund.created`, `dispute.created`, `resolution_center_case.created`, `resolution_center_case.decided`, `course_lesson_interaction.completed`

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

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

```json Automation theme={null}
{
	"id": "ato_xxxxxxxxxxxxxx",
	"account_id": "biz_xxxxxxxxxxxxxx",
	"name": "Welcome new customers",
	"status": "active",
	"trigger_event": "payment.succeeded",
	"published_version": 2,
	"draft_version": 3,
	"has_unpublished_changes": false,
	"published_at": "2026-10-01T15:30:00.000Z",
	"published_by_actor": {
		"id": "user_yyyyyyyyyyyyyy",
		"object": "user"
	},
	"created_by_actor": {
		"id": "user_yyyyyyyyyyyyyy",
		"object": "user"
	},
	"secret_names": ["SHOPIFY_TOKEN"],
	"active_enrollments_count": 42,
	"total_enrollments_count": 318,
	"created_at": "2026-09-12T10:00:00.000Z",
	"updated_at": "2026-10-01T15:30:00.000Z"
}
```


## Related topics

- [API Automation Steps](https://docs.whop.com/fr/api-reference/automation-steps/automation-step.md)
- [API Automation Enrollments](https://docs.whop.com/fr/api-reference/automation-enrollments/automation-enrollment.md)
- [Delete Automation](https://docs.whop.com/fr/api-reference/automations/delete-automation.md)
