beehiiv Developer Documentation

Currently in beta

This feature is currently in beta and the API is subject to change.

Draft and accept an ad offer, then insert the resulting advertisement opportunity into a post.

<Note title="Currently in beta" icon="b"> This feature is currently in beta and the API is subject to change.<br/> </Note> Draft and accept an ad offer, then insert the resulting advertisement opportunity into a post.

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.

offer_idstringRequired

The ID of the ad offer to accept.

advertisement_idstringRequired

The ID of the advertisement creative to use.

post_idstringRequired

The ID of the post where the advertisement should be inserted.

Response

Created

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

$	curl -X POST https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/ad_network/offers \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"offer_id": "1",
>	"advertisement_id": "00000000-0000-0000-0000-000000000000",
>	"post_id": "post_11111111-1111-1111-1111-111111111111"
>	}'

1	{
2	"data": {
3	"offer_id": "1",
4	"opportunity_id": "22222222-2222-2222-2222-222222222222",
5	"advertisement_id": "00000000-0000-0000-0000-000000000000",
6	"post_id": "post_11111111-1111-1111-1111-111111111111"
7	}
8	}