Skip to main content
POST
/
changelogs
/
{id}
/
broadcast
Send a changelog broadcast
curl --request POST \
  --url https://productlane.com/api/v2/changelogs/{id}/broadcast \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": true,
  "slack": true,
  "message": "<string>",
  "subject": "<string>",
  "sender_name": "<string>",
  "from_email": "jsmith@example.com"
}
'
{
  "id": "<string>",
  "email": {
    "dispatched": true,
    "reason": "<string>"
  },
  "slack": {
    "dispatched": true,
    "reason": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
email
boolean

Send the changelog as an email broadcast to subscribed contacts. The workspace's email integration must be enabled. Requires the Pro plan or higher.

​
slack
boolean

Post the changelog to the configured Slack channels (slack connect). Requires the Pro plan or higher and Slack connected.

​
message
string

Optional intro message prepended to the broadcast (HTML or plain text). Mirrors the dashboard's compose field.

​
subject
string

Email subject. Defaults to the changelog title prefixed with New:.

​
sender_name
string

Display name used in the From header. Defaults to the workspace's configured sender name.

​
from_email
string<email>

Override the From email. Must use the workspace's verified sending domain.

Response

Successful response

​
id
string
required
​
email
object
required
​
slack
object
required