Publish Automation

curl --request POST \
  --url https://api.whop.com/api/v1/automations/{id}/publish \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/automations/{id}/publish', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/automations/{id}/publish",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/automations/{id}/publish")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "active_enrollments_count": 0,
  "created_at": "2026-01-01T12:00:00.000Z",
  "created_by_actor": {
    "id": "biz_xxxxxxxxxxxxxx",
    "object": "account"
  },
  "draft_version": 2,
  "has_unpublished_changes": false,
  "id": "ato_xxxxxxxxxxxxxx",
  "name": "After an order",
  "published_at": "2026-01-01T12:00:00.000Z",
  "published_by_actor": {
    "id": "biz_xxxxxxxxxxxxxx",
    "object": "account"
  },
  "published_version": 1,
  "secret_names": [
    "SHOP_TOKEN"
  ],
  "status": "active",
  "total_enrollments_count": 0,
  "trigger_event": "payment.succeeded",
  "updated_at": "2026-01-01T12:00:00.000Z"
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Automations

Publish Automation

Publishes the draft version: new members start on it, and the automation becomes active. Members already in the automation move onto it: onto the same step when it’s still there, or, when the draft removed it, onto the step that now follows the nearest earlier step the draft kept. The draft is then copied into the next draft version, whose steps get new IDs and keep their key. Every draft step’s issues must be empty. When the draft has no edits since the last publish, no new version is made, and this only makes a closed or stopped automation active again.

POST

automations

{id}

publish

Publish Automation

curl --request POST \
  --url https://api.whop.com/api/v1/automations/{id}/publish \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/automations/{id}/publish', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/automations/{id}/publish",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/automations/{id}/publish")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "active_enrollments_count": 0,
  "created_at": "2026-01-01T12:00:00.000Z",
  "created_by_actor": {
    "id": "biz_xxxxxxxxxxxxxx",
    "object": "account"
  },
  "draft_version": 2,
  "has_unpublished_changes": false,
  "id": "ato_xxxxxxxxxxxxxx",
  "name": "After an order",
  "published_at": "2026-01-01T12:00:00.000Z",
  "published_by_actor": {
    "id": "biz_xxxxxxxxxxxxxx",
    "object": "account"
  },
  "published_version": 1,
  "secret_names": [
    "SHOP_TOKEN"
  ],
  "status": "active",
  "total_enrollments_count": 0,
  "trigger_event": "payment.succeeded",
  "updated_at": "2026-01-01T12:00:00.000Z"
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Idempotency-Key

string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255

Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-11-05-1"

Path Parameters

string

required

Automation ID, prefixed ato_.

Response

Automation published

account_id

string

required

ID of the account the automation belongs to, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

active_enrollments_count

integer

required

Members currently in the automation.

Example:

0

created_at

string

required

When the automation was created, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

created_by_actor

object

required

Who created the automation.

Show child attributes

draft_version

integer

required

The version that step edits change. Always published_version plus one, or 1 before the first publish.

Example:

2

has_unpublished_changes

boolean

required

Whether the draft has edits that POST /automations/{id}/publish would publish. Always true before the first publish.

Example:

false

string

required

Automation ID, prefixed ato_.

Example:

"ato_xxxxxxxxxxxxxx"

name

string

required

The automation's name, shown on the dashboard. Up to 255 characters.

Example:

"After an order"

published_at

string | null

required

When the automation was last published, as an ISO 8601 timestamp. null until its first publish.

Example:

"2026-01-01T12:00:00.000Z"

published_by_actor

object | null

required

Who last published the automation. null until its first publish.

Show child attributes

published_version

integer | null

required

The version new members start on. null until the automation is first published.

Example:

1

secret_names

string[]

required

Names of the automation's secrets, which its steps' code reads as environment variables. Their values are never returned.

status

enum<string>

required

active enrolls members and runs their steps. closed enrolls no one new, and members already in it finish. stopped enrolls no one, and its members' enrollments have ended. A new automation is stopped until its first publish makes it active.

Available options:

active,

closed,

stopped

Example:

"active"

total_enrollments_count

integer

required

How many times members have enrolled in the automation, including enrollments that have ended.

Example:

0

trigger_event

enum<string> | null

required

The webhook event that enrolls the member it's about, such as payment.succeeded. null for an automation that only POST /automations/{id}/trigger enrolls into. Fixed once the automation has been published.

Available options:

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,

null

Example:

"payment.succeeded"

updated_at

string

required

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

Example:

"2026-01-01T12:00:00.000Z"

Introduction

Reference

Core Resources

Payments

Money

Commerce

Websites

Ads

Analytics

Communication

Partners

Workforce

Media

Developer

Publish Automation

Authorizations

Headers

Path Parameters

Response