Create a draft changelog entry

POST

/product/sites/{siteId}/releases

Authorizations

BearerAuth

JWT token from login

Type

HTTP (bearer)

or

AccessToken

Personal access token. Value: Token <your-token>

Type

API Key (header: Authorization)

Parameters

Path Parameters

siteId*

Type

string

Required

Request Body

application/json

{

  

"title": "string",

  

"excerpt": "string",

  

"description": "string",

  

"version": "string",

  

"ai_draft": "string",

  

"release_date": "string",

  

"comments_enabled": true,

  

"roadmap_item_ids": [

  

  

"string"

  

],

  

"notification_recipients": [

  

  

"string"

  

],

  

"cover_attachment": "string",

  

"cover_url": "string",

  

"automation_key": "string",

  

"source": "string"

}

Responses

Existing draft returned for an identical automation retry

Content-Type

application/json

{

  

"release": "string",

  

"created": true

}

POST

/product/sites/{siteId}/releases

Playground

Authorization

BearerAuth

Variables

Key

Value

siteId*

Body

Samples

Powered by VitePress OpenAPI