Send private feed email OAuth Scope: podcasts:write

POST

https://api.beehiiv.com/v2/publications/:publicationId/podcasts/:podcastShowId/private_feeds/:subscriptionId/emails

POST

/v2/publications/:publicationId/podcasts/:podcastShowId/private_feeds/:subscriptionId/emails

$ curl -X POST https://api.beehiiv.com/v2/publications/publicationId/podcasts/podcastShowId/private_feeds/subscriptionId/emails \
>      -H "Authorization: Bearer <token>"

1 {
2   "data": {
3     "id": "id",
4     "url": "url",
5     "protocol_links": {
6       "protocol_links": "protocol_links"
7     },
8     "created": 1,
9     "subscription": {
10       "id": "id",
11       "email": "email",
12       "status": "validating",
13       "created": 1,
14       "subscription_tier": "free",
15       "subscription_premium_tier_names": [
16         "subscription_premium_tier_names",
17         "subscription_premium_tier_names"
18       ],
19       "utm_source": "utm_source",
20       "utm_medium": "utm_medium",
21       "utm_channel": "",
22       "utm_campaign": "utm_campaign",
23       "utm_term": "utm_term",
24       "utm_content": "utm_content",
25       "referring_site": "referring_site",
26       "referral_code": "referral_code",
27       "subscription_premium_tiers": [
28         {
29           "id": "id",
30           "name": "name",
31           "status": "active"
32         },
33         {
34           "id": "id",
35           "name": "name",
36           "status": "active"
37         }
38       ],
39       "custom_fields": [
40         {
41           "name": "name",
42           "kind": "string",
43           "value": "value"
44         },
45         {
46           "name": "name",
47           "kind": "string",
48           "value": "value"
49         }
50       ],
51       "tags": [
52         "tags",
53         "tags"
54       ],
55       "stats": {
56         "emails_received": 1,
57         "open_rate": 100,
58         "click_through_rate": 100
59       },
60       "newsletter_list_ids": [
61         "newsletter_list_ids",
62         "newsletter_list_ids"
63       ]
64     },
65     "show": {
66       "id": "id",
67       "created": 1,
68       "slug": "slug",
69       "description": "description",
70       "categories": [
71         "categories",
72         "categories"
73       ],
74       "artwork_url": "artwork_url",
75       "status": "draft",
76       "language": "language",
77       "title": "title",
78       "author": "author",
79       "type": "episodic",
80       "imported": true,
81       "copyright": "copyright",
82       "explicit": true,
83       "publishing_frequency": 1,
84       "website_url": "website_url",
85       "platform_links": {
86         "platform_links": "platform_links"
87       }
88     },
89     "activated": 1,
90     "revoked": 1,
91     "expires": 1
92   }
93 }

Send the private RSS feed transactional email to a subscription for a podcast. The payload matches GET private feed. Returns 422 when the podcast is fully public or the private feed token is inactive.

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

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

The prefixed ID of the podcast

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

The prefixed ID of the subscription

Response

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error