Skip to navigation
API ReferencePublications

Update publication OAuth Scope: publications:write

Update the settings of a publication. Only the fields you send are changed.

Reply-to address: sending reply_to_address replaces the address that emails reply to. An address that belongs to a user with access to the publication is used straight away. Any other address is returned as pending_reply_to_address, and a verification email is sent to it. The current address keeps being used until the new one is verified. The reply-to address can be changed 3 times in 24 hours. Further changes respond with 429 and the code REPLY_TO_ADDRESS_RATE_LIMITED, and nothing in the request is saved.

Tags: tags replaces all of the publication’s category tags. Use the names from the List publication tags endpoint, with up to 3 tags. A name that is not in that list is rejected.

Logo: logo_url must be a publicly reachable JPG, PNG, GIF, or WebP image. It is downloaded and stored, so later changes at that URL do not affect the logo.

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.
namestringOptional2-100 characters
The name of the publication.
descriptionstringOptional<=1000 characters
The description of the publication.
copyright_textstringOptional
The copyright text shown in the email footer.
time_zonestringOptional

The time zone of the publication, as one of the time zone names offered in the publication settings, such as Eastern Time (US & Canada) or London.

opt_in_redirect_urlstringOptional

An HTTPS URL that subscribers are sent to after confirming a double opt-in. Send an empty string to clear it.

double_opt_inbooleanOptional
Whether new subscribers must confirm their email address before they are subscribed.
private_brandingbooleanOptional
Whether to hide beehiiv branding from the publication. Turning it on requires a plan that includes private branding.
unsubscribe_when_all_lists_offbooleanOptional
Whether a subscriber is unsubscribed from the publication when they turn off all of its lists.
tagslist of stringsOptional
The category tags of the publication, up to 3. Replaces the current tags.
logo_urlstringOptional
The URL of an image to upload as the publication's logo.
reply_to_addressstringOptional
The email address that replies to the publication's emails go to.

Response

OK
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error