Bulk create subscription OAuth Scope: subscriptions:write

POST

https://api.beehiiv.com/v2/publications/:publicationId/bulk_subscriptions

POST

/v2/publications/:publicationId/bulk_subscriptions

1 import requests
2 
3 url = "https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/bulk_subscriptions"
4 
5 payload = { "subscriptions": [
6         {
7             "email": "[email protected]",
8             "reactivate_existing": False,
9             "send_welcome_email": False,
10             "custom_fields": [
11                 {
12                     "name": "Favorite Color",
13                     "value": "Red"
14                 }
15             ]
16         },
17         {
18             "email": "[email protected]",
19             "reactivate_existing": False,
20             "send_welcome_email": False,
21             "custom_fields": [
22                 {
23                     "name": "Favorite Color",
24                     "value": "Blue"
25                 }
26             ]
27         }
28     ] }
29 headers = {
30     "Authorization": "Bearer <token>",
31     "Content-Type": "application/json"
32 }
33 
34 response = requests.post(url, json=payload, headers=headers)
35 
36 print(response.json())

1 {
2   "message": "Bulk Subscription Create Request Sent.",
3   "import_id": "00000000-0000-0000-0000-000000000000"
4 }

Create new subscriptions for a publication.

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

Request

This endpoint expects an object.

subscriptionslist of objectsRequired

Response

Subscriptions created

messagestring

The result of the create request

import_idstring

The database ID of the import object created from the Bulk Subscription Create request

Authentication

Path parameters

Request

Response

Errors