beehiiv Developer Documentation

Add an existing subscription to an automation flow. Requires the automation to have an active Add by API trigger. The specified email or subscription_id will be matched against your existing subscribers. If an existing subscriber is found, they will be enrolled immediately. Looking to enroll new subscribers? Use the Create Subscription endpoint instead and specify the automation_ids param.

Add an existing subscription to an automation flow. Requires the automation to have an active *Add by API* trigger. The specified `email` or `subscription_id` will be matched against your existing subscribers. If an existing subscriber is found, they will be enrolled immediately. Looking to enroll new subscribers? Use the **[Create Subscription](/api-reference/subscriptions/create)** endpoint instead and specify the `automation_ids` param.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

publicationIdstringRequiredformat: "^(pub_[0-9a-fA-F\-]+)$"

The prefixed ID of the publication object

automationIdstringRequiredformat: "^(aut_[0-9a-fA-F\-]+)$"

The prefixed ID of the automation object

Request

This endpoint expects an object.

emailstringOptional

The email address associated with the subscription.

subscription_idstringOptionalformat: "^(sub_[0-9a-fA-F\-]+)$"

The prefixed ID of the subscription.

double_opt_overridestringOptional

Override the publication’s default double opt-in settings for this subscription. Possible values are:

“on” — The subscriber will receive a double opt-in confirmation email and will need to confirm their subscription prior to being marked as active.
“off” — The subscriber will be marked as active immediately and will not receive a double opt-in confirmation email.
“not_set” — The publication’s default double opt-in settings will be applied to this subscription.

Override the publication's default double opt-in settings for this subscription. Possible values are: - "on" — The subscriber will receive a double opt-in confirmation email and will need to confirm their subscription prior to being marked as active. - "off" — The subscriber will be marked as active immediately and will not receive a double opt-in confirmation email. - "not_set" — The publication's default double opt-in settings will be applied to this subscription.

Response

Created

dataobject

A subscribers' journey through an automation flow.

1	import requests
2
3	url = "https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/automations/aut_00000000-0000-0000-0000-000000000000/journeys"
4
5	payload = {
6	"email": "[email protected]",
7	"double_opt_override": "on"
8	}
9	headers = {
10	"Authorization": "Bearer <token>",
11	"Content-Type": "application/json"
12	}
13
14	response = requests.post(url, json=payload, headers=headers)
15
16	print(response.json())

1	{
2	"data": {
3	"id": "aj_00000000-0000-0000-0000-000000000000",
4	"automation_id": "aut_00000000-0000-0000-0000-000000000000",
5	"status": "in_progress",
6	"subscription_id": "sub_00000000-0000-0000-0000-000000000000",
7	"email": "[email protected]",
8	"started_at": 1714857600,
9	"completed_at": 1714861200
10	}
11	}

Add subscription to an automation OAuth Scope: automations:write

Authentication

Path parameters

Request

Response

Errors