Order a press release

POST

/api/v1/releases

Docs menu

Orders a paid press release from your balance. The release is a paid press release, labeled as one, and the owner reviews every release before it goes out. Closed unless every publishing gate is met: see Publishing. Idempotency-Key is required.

Key
Bearer key, test or live
Scope
releases:write
Idempotency
Header required

Headers

Idempotency-Keystringrequired

Makes a retry safe: the same key with the same request returns the first answer. See Idempotency.

Request body

JSON. A field this endpoint does not know is refused with unknown_parameter.

packagestringrequired

basicstandardpremium

companystringrequired
websitestringrequired

A public https address on your own domain.

headlinestringoptional
release_textstringoptional

basic and standard: 250 to 400 words, written by you.

briefstringoptional

premium: what we should write from. The owner screens the draft.

screenobjectrequired
Show child fields
refused_categories_absentbooleanrequired

true

links_controlledbooleanrequired

true

metadataobjectoptional

Your own notes: up to 20 keys, each key up to 40 characters, each value up to 500.

Response

201. The release, in review.

idstring

rel_...

objectstring

release

livemodeboolean
order_refstring or null
packagestring

basicstandardpremium

statusstring

in_reviewdraft_readychanges_requestedapprovedsentlivereport_readycompletedrejectedrefunded

status_wordsstring
companystring
websitestring
headlinestring or null
draftobject or null
can_approveboolean
can_request_changesboolean
live_pagesarray of string
proof_reportsarray of object
Show child fields
dayinteger

0730

urlstring or null
statusstring

pendingready

credits_chargedinteger
refunded_to_balanceboolean
created_atstring
updated_atstring

Errors

CodeStatusMeaning
missing_scope403The API key does not have the scope this endpoint needs.
body_not_json400The request body must be a JSON object.
unknown_parameter400The request has a parameter this endpoint does not accept.
parameter_missing400A required parameter is missing.
parameter_invalid400A parameter has a value this endpoint does not accept.
website_invalid400The website must be a public https address on your own domain.
release_text_missing400This package needs the release text.
release_text_too_long400The release is longer than the package allows.
brief_missing400This package needs a brief for us to write from.
screen_statement_missing400Confirm that the release has none of the refused content and that every link is yours.
idempotency_key_invalid400The Idempotency-Key header must be 1 to 255 printable characters.
idempotency_key_reused422This Idempotency-Key was used with a different request.
package_not_available403This package cannot be ordered through the API.
country_blocked403We cannot serve this country.
new_account_spend_limit429A new account may spend a limited number of credits in 24 hours. The limit lifts as the account ages.
releases_closed403Publishing by API is not open.
identity_level_insufficient403Publishing needs the account to pass our business identity checks first.
insufficient_balance402The balance is too low for this request.
business_details_required403Add your business details in the console before the first top-up.
account_not_onboarded403Finish the account details in the console first.

Any request can also fail with missing_api_key, invalid_api_key, api_key_revoked, rate_limited or internal_error. See Errors.

In test mode