beehiiv Developer Documentation

import requests
url = "https://api.beehiiv.com/v2/publications/publicationId/subscriptions/subscriptionId/tags"
payload = { "tags": ["Premium", "Basic"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

1	{
2	"data": {
3	"id": "sub_00000000-0000-0000-0000-000000000000",
4	"email": "[email protected]",
5	"status": "validating",
6	"created": 1666800076,
7	"subscription_tier": "free",
8	"subscription_premium_tier_names": [
9	"Premium",
10	"Gold"
11	],
12	"utm_source": "Twitter",
13	"utm_medium": "organic",
14	"utm_channel": "website",
15	"utm_campaign": "utm_campaign",
16	"utm_term": "",
17	"utm_content": "",
18	"referring_site": "https://www.blog.com",
19	"referral_code": "referral_code",
20	"tags": [
21	"Premium",
22	"Basic",
23	"Active",
24	"Engaged"
25	]
26	}
27	}

Adds tags to a subscription. If the tag does not exist on the publication, it will be created automatically.

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.

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

The prefixed ID of the subscription.

Request

This endpoint expects an object.

tagslist of stringsOptional

Tags that can be used to group subscribers

Response

dataobject or null

The subscription object

Add subscription tag

Authentication

Path parameters

Request

Response

Errors