Bulk create subscription OAuth Scope: subscriptions:write

POST

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

POST

/v2/publications/:publicationId/bulk_subscriptions

1 curl -X POST https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/bulk_subscriptions \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "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 }'

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