beehiiv Developer Documentation

Bulk update subscriptions' status.

AuthorizationBearer

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

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

The prefixed ID of the publication object

This endpoint expects an object.

subscription_idslist of stringsRequired

An array of subscription IDs to be updated

new_statusstringRequired

The new status to set for the subscriptions

1	import requests
2
3	url = "https://api.beehiiv.com/v2/publications/publicationId/subscriptions"
4
5	payload = {
6	"subscription_ids": ["sub_1234-5678-9012-3456-7890", "sub_9876-5432-1098-7654-3210"],
7	"new_status": "active"
8	}
9	headers = {
10	"Authorization": "Bearer <token>",
11	"Content-Type": "application/json"
12	}
13
14	response = requests.put(url, json=payload, headers=headers)
15
16	print(response.json())