Creates a draft entry. Publish it with POST /changelog/entries/{id}/publish.
bash
curl -X POST "https://usedocs.app/v1/changelog/entries" \
-H "Authorization: Bearer $USEDOCS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"title":"Faster CSV exports","contentMarkdown":"Exports of 10,000 invoices now take seconds."}'Authentication
Bearer token (content:write): A workspace API key: ud_live_…
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
bot_id | query | string | Only for a key that covers several bots (see GET /bots). Or send the Usedocs-Bot header. |
Request body
Required, application/json.
| Field | Type | Required | Description |
|---|---|---|---|
title | string | Yes | |
contentMarkdown | string | Yes | |
sourceUrl | string |
Responses
| Status | Description |
|---|---|
201 | The entry. |
400 | The request is missing something or has a bad value. |
401 | No API key, or the key is revoked. |
402 | The workspace is paused; reads still work. |
403 | A read key on a write, or a key for another bot. |
404 | Not found. |
429 | Rate limited: 120 requests a minute per key, 30 tasks an hour. See Retry-After. |
Response fields
| Field | Type | Description |
|---|---|---|
id | string | |
title | string | |
slug | string | |
status | string | One of: draft, published, archived. |
contentMarkdown | string | |
sourceUrl | `string | null` |
publishedAt | `string | null` |
createdAt | string | |
updatedAt | string |