Create Changelogs via API

Step-by-step guide to creating changelogs programmatically using the ChangeCrab API.

All Articles

Create Changelogs via API

Create changelogs programmatically using the ChangeCrab API. Automate changelog creation and integrate with your development workflow.

Prerequisites

Endpoint

POST /api/changelogs

Request Body

{
  "name": "My Changelog",
  "team": 1,
  "subdomain": "mychangelog",
  "description": "Product updates changelog",
  "accent": "#E33597",
  "private": false
}

Required Fields

  • name - Changelog name (required)
  • team - Team ID (required)

Optional Fields

  • subdomain - Subdomain name
  • domain - Custom domain
  • description - Changelog description
  • accent - Accent color (hex)
  • private - Privacy setting (boolean)

Example: cURL

curl -X POST https://changecrab.com/api/changelogs \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Changelog",
    "team": 1,
    "subdomain": "mychangelog"
  }'

Example: JavaScript

fetch('https://changecrab.com/api/changelogs', {
  method: 'POST',
  headers: {
    'X-API-Key': 'your-api-key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'My Changelog',
    team: 1,
    subdomain: 'mychangelog'
  })
})
.then(response => response.json())
.then(data => console.log(data));

Response

{
  "success": true,
  "data": {
    "id": 123,
    "accessid": "abc123xyz",
    "name": "My Changelog",
    "subdomain": "mychangelog",
    "team": 1
  }
}

Next Steps