Skip to main content
Changelogs

Delete a changelog

Deletes a changelog by its unique identifier.

DELETE
/v2/outbound/changelogs/{id}

Deletion Behavior

The Changelog and all associated comments are permanently deleted. This action cannot be undone.

Response

Returns a deletion confirmation:

{
  "object": "changelog",
  "id": "6457e3ff70afca5d8c27dccc",
  "deleted": true
}

Errors

  • 400 - Invalid Changelog ID format
  • 404 - Changelog not found or doesn't belong to your organization

Compatibility

Changelogs appear as Updates in the dashboard. Keep using /v2/outbound/changelogs, client.outbound.changelogs, and the changelog.published webhook. This reference describes Pulsar. The original /v2/changelogs routes still work; their behavior follows the selected API version. The Outbound paths require Pulsar or later. In Pulsar, the API key owner needs a full seat and the manage_changelogs permission.

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Path Parameters

idstringrequired

changelog unique identifier

Example: 507f1f77bcf86cd799439011

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-09-03.pulsar, 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-09-03.pulsar

Response

application/json

Success

deletedenum<boolean>required

Indicates the resource was deleted

Available options: true
Example: true
idstringrequired

Unique identifier of the deleted changelog

Example: 507f1f77bcf86cd799439011
objectenum<string>required

Object type identifier

Available options: changelog
Example: changelog

Still need help? Ask the team