beehiiv Developer Documentation

curl -X POST https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/paid_recommendations/partnerships/rec_agr_00000000-0000-0000-0000-000000000000/pause \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "accepted_subscribers": 100,
    "auto_accepted": false,
    "created_at": 1767225600,
    "id": "rec_agr_00000000-0000-0000-0000-000000000000",
    "offer": {
      "id": "rec_offer_00000000-0000-0000-0000-000000000000",
      "name": "Spring growth offer"
    },
    "pending_spend_cents": 3750,
    "pending_subscribers": 15,
    "recommending_publication": {
      "id": "pub_00000000-0000-0000-0000-000000000001",
      "name": "The Morning Brief",
      "url": "https://morningbrief.beehiiv.com/"
    },
    "status": "paused",
    "total_spend_cents": 25000,
    "total_subscribers": 120,
    "updated_at": 1767312000,
    "rejected_reason": null
  }
}

Currently in beta

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

Pause an active partnership. The publication stops recommending you until you resume it.

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

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

The prefixed ID of the partnership object

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