Your changelog content in HTML format.
", "createdAt": "2023-12-12T00:00:00.000Z", "date": "2023-05-07T12:59:59.000Z", "emailSentToSubscribers": true, "featuredImage": "https://cdn.example.com/images/feature.png", "isDraftDiffersFromLive": false, "isPublished": true, "locale": "en", "markdownContent": "Your changelog content in markdown format.", "notifications": { "foo": { "scheduledDate": "2024-01-15T12:00:00.000Z", "emailSent": true, "hideFromBoardAndWidgets": false, "sendEmailNotification": true } }, "object": "changelog", "organization": "myorg", "publishedLocales": [ "en", "de" ], "slug": "your-awesome-changelog", "slugs": { "en": "your-awesome-changelog", "de": "dein-tolles-changelog" }, "state": "live", "title": "Your awesome changelog!", "updatedAt": "2023-12-13T00:00:00.000Z", "url": "https://myorg.featurebase.app/en/changelog/your-awesome-changelog" } ], "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9", "object": "list", "pagination": { "limit": 10, "page": 1, "total": 42, "totalPages": 5 } } ``` ## Create a new changelog **post** `/v2/changelogs` Creates a new changelog for the authenticated organization. ### Required Fields - `title` - The title of the changelog ### Content Provide content in one of two formats (at least one is required): - `htmlContent` - HTML content of the changelog - `markdownContent` - Markdown content of the changelog **Note:** For images in content, you can use: - External URLs in img src attributes (automatically uploaded to our storage) - Base64 encoded data URIs (data:image/...) which are processed and stored ### Optional Fields - `categories` - Array of category names (e.g., ["New", "Fixed", "Improved"]) - `featuredImage` - URL of the featured image (external URLs are uploaded to our storage) - `allowedSegmentIds` - Array of segment IDs that are allowed to view the changelog - `locale` - The locale of the changelog (defaults to organization default) - `date` - The date of the changelog - `state` - The state of the changelog: `draft` (default) or `live` ### Response Returns the created changelog object. ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Body Parameters - `title: string` The title of the changelog - `allowedSegmentIds: optional array of string` An array of segment IDs that are allowed to view the changelog - `categories: optional array of string` An array of category names to which the changelog belongs - `date: optional string` The date of the changelog - `featuredImage: optional string` The URL of the featured image for the changelog. External URLs will be uploaded to our storage. - `htmlContent: optional string` The HTML content of the changelog. Provide either htmlContent or markdownContent. For images, external URLs and base64 data URIs are automatically processed and stored. - `locale: optional "bn" or "bs" or "pt-BR" or 39 more` The locale of the changelog, defaulting to the organization default locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `markdownContent: optional string` The markdown content of the changelog. Provide either htmlContent or markdownContent. For images, external URLs and base64 data URIs are automatically processed and stored. - `state: optional "draft" or "live"` The state of the changelog (draft or live) - `"draft"` - `"live"` ### Returns - `Changelog object { id, allowedSegmentIds, availableLocales, 21 more }` - `id: string` Unique identifier - `allowedSegmentIds: array of string` Segment IDs that are allowed to view this changelog - `availableLocales: array of string` Array of locale codes where the changelog has content - `categories: array of object { id, name, roles }` Categories the changelog belongs to - `id: string` Category unique identifier - `name: string` Category name - `roles: optional array of string` Roles allowed to view this category - `commentCount: number` Number of comments - `content: string` Content in HTML format - `createdAt: string` ISO 8601 timestamp when created - `date: string` Publication date as ISO 8601 timestamp - `emailSentToSubscribers: boolean` Whether email notification was sent to subscribers - `featuredImage: string` Featured image URL - `isDraftDiffersFromLive: boolean` Whether the draft content differs from the published live content - `isPublished: boolean` Whether the changelog is published (has a live version) in this locale - `locale: "bn" or "bs" or "pt-BR" or 39 more` Locale of the changelog - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `markdownContent: string` Content in markdown format - `notifications: map[object { scheduledDate, emailSent, hideFromBoardAndWidgets, sendEmailNotification } ]` Notification settings for each locale - `scheduledDate: string` Scheduled publication date as ISO 8601 timestamp - `emailSent: optional boolean` Whether the email notification has been sent - `hideFromBoardAndWidgets: optional boolean` Whether the changelog is hidden from the board and widgets - `sendEmailNotification: optional boolean` Whether email notification should be sent for this locale - `object: "changelog"` Object type identifier - `"changelog"` - `organization: string` Organization identifier - `publishedLocales: array of string` Array of locale codes where the changelog is published - `slug: string` URL-friendly slug - `slugs: map[string]` URL-friendly slugs for each locale - `state: "live" or "draft"` State of the changelog - `"live"` - `"draft"` - `title: string` Changelog title - `updatedAt: string` ISO 8601 timestamp when updated - `url: string` Public URL to view the changelog ### Example ```http curl https://do.featurebase.app/v2/changelogs \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" \ -d '{ "title": "New Features Update", "allowedSegmentIds": [ "507f1f77bcf86cd799439011" ], "categories": [ "New", "Fixed", "Improved" ], "date": "2024-01-15", "featuredImage": "https://example.com/image.png", "htmlContent": "Exciting new features to explore.
", "locale": "en", "markdownContent": "Exciting new features to explore.", "state": "draft" }' ``` #### Response ```json { "id": "6457e3ff70afca5d8c27dccc", "allowedSegmentIds": [ "string" ], "availableLocales": [ "en", "de", "fr" ], "categories": [ { "id": "6438a1efda3640f8feb72121", "name": "New Features", "roles": [ "string" ] } ], "commentCount": 2, "content": "Your changelog content in HTML format.
", "createdAt": "2023-12-12T00:00:00.000Z", "date": "2023-05-07T12:59:59.000Z", "emailSentToSubscribers": true, "featuredImage": "https://cdn.example.com/images/feature.png", "isDraftDiffersFromLive": false, "isPublished": true, "locale": "en", "markdownContent": "Your changelog content in markdown format.", "notifications": { "foo": { "scheduledDate": "2024-01-15T12:00:00.000Z", "emailSent": true, "hideFromBoardAndWidgets": false, "sendEmailNotification": true } }, "object": "changelog", "organization": "myorg", "publishedLocales": [ "en", "de" ], "slug": "your-awesome-changelog", "slugs": { "en": "your-awesome-changelog", "de": "dein-tolles-changelog" }, "state": "live", "title": "Your awesome changelog!", "updatedAt": "2023-12-13T00:00:00.000Z", "url": "https://myorg.featurebase.app/en/changelog/your-awesome-changelog" } ``` ## Get a changelog by ID **get** `/v2/changelogs/{id}` Retrieves a single changelog by its unique identifier or slug. Returns the full changelog object including: - Title and content (in HTML and markdown formats) - Featured image - Publication date - Categories - Comment count - Email notification status ### Localization The changelog content is returned in the organization's default locale. If the changelog doesn't exist in the default locale, the first available locale is used. ### State Both published (`live`) and draft changelogs can be retrieved. The `state` field indicates the current publication status. ### Path Parameters - `id: string` Changelog unique identifier ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Returns - `Changelog object { id, allowedSegmentIds, availableLocales, 21 more }` - `id: string` Unique identifier - `allowedSegmentIds: array of string` Segment IDs that are allowed to view this changelog - `availableLocales: array of string` Array of locale codes where the changelog has content - `categories: array of object { id, name, roles }` Categories the changelog belongs to - `id: string` Category unique identifier - `name: string` Category name - `roles: optional array of string` Roles allowed to view this category - `commentCount: number` Number of comments - `content: string` Content in HTML format - `createdAt: string` ISO 8601 timestamp when created - `date: string` Publication date as ISO 8601 timestamp - `emailSentToSubscribers: boolean` Whether email notification was sent to subscribers - `featuredImage: string` Featured image URL - `isDraftDiffersFromLive: boolean` Whether the draft content differs from the published live content - `isPublished: boolean` Whether the changelog is published (has a live version) in this locale - `locale: "bn" or "bs" or "pt-BR" or 39 more` Locale of the changelog - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `markdownContent: string` Content in markdown format - `notifications: map[object { scheduledDate, emailSent, hideFromBoardAndWidgets, sendEmailNotification } ]` Notification settings for each locale - `scheduledDate: string` Scheduled publication date as ISO 8601 timestamp - `emailSent: optional boolean` Whether the email notification has been sent - `hideFromBoardAndWidgets: optional boolean` Whether the changelog is hidden from the board and widgets - `sendEmailNotification: optional boolean` Whether email notification should be sent for this locale - `object: "changelog"` Object type identifier - `"changelog"` - `organization: string` Organization identifier - `publishedLocales: array of string` Array of locale codes where the changelog is published - `slug: string` URL-friendly slug - `slugs: map[string]` URL-friendly slugs for each locale - `state: "live" or "draft"` State of the changelog - `"live"` - `"draft"` - `title: string` Changelog title - `updatedAt: string` ISO 8601 timestamp when updated - `url: string` Public URL to view the changelog ### Example ```http curl https://do.featurebase.app/v2/changelogs/$ID \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" ``` #### Response ```json { "id": "6457e3ff70afca5d8c27dccc", "allowedSegmentIds": [ "string" ], "availableLocales": [ "en", "de", "fr" ], "categories": [ { "id": "6438a1efda3640f8feb72121", "name": "New Features", "roles": [ "string" ] } ], "commentCount": 2, "content": "Your changelog content in HTML format.
", "createdAt": "2023-12-12T00:00:00.000Z", "date": "2023-05-07T12:59:59.000Z", "emailSentToSubscribers": true, "featuredImage": "https://cdn.example.com/images/feature.png", "isDraftDiffersFromLive": false, "isPublished": true, "locale": "en", "markdownContent": "Your changelog content in markdown format.", "notifications": { "foo": { "scheduledDate": "2024-01-15T12:00:00.000Z", "emailSent": true, "hideFromBoardAndWidgets": false, "sendEmailNotification": true } }, "object": "changelog", "organization": "myorg", "publishedLocales": [ "en", "de" ], "slug": "your-awesome-changelog", "slugs": { "en": "your-awesome-changelog", "de": "dein-tolles-changelog" }, "state": "live", "title": "Your awesome changelog!", "updatedAt": "2023-12-13T00:00:00.000Z", "url": "https://myorg.featurebase.app/en/changelog/your-awesome-changelog" } ``` ## Update a changelog **patch** `/v2/changelogs/{id}` Updates an existing changelog by its unique identifier. You can update: - **title** - The changelog title - **htmlContent** - HTML content (one of htmlContent or markdownContent) - **markdownContent** - Markdown content (one of htmlContent or markdownContent) - **categories** - Array of category names - **featuredImage** - Featured image URL - **allowedSegmentIds** - Segment IDs for access control - **date** - The date of the changelog ### Content Format Provide content in one of two formats: - `htmlContent` - HTML content of the changelog - `markdownContent` - Markdown content of the changelog **Note:** For images in content, you can use: - External URLs in img src attributes (automatically uploaded to our storage) - Base64 encoded data URIs (data:image/...) which are processed and stored ### Categories Provide category names as an array. The categories must already exist in your organization. **Example:** `["New", "Fixed", "Improved"]` ### Response Returns the updated changelog object with all fields populated. ### Errors - `400` - Invalid changelog ID format or invalid input - `404` - Changelog not found or doesn't belong to your organization ### Path Parameters - `id: string` Changelog unique identifier ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Body Parameters - `allowedSegmentIds: optional array of string` An array of segment IDs that are allowed to view the changelog - `categories: optional array of string` An array of category names to which the changelog belongs - `date: optional string` The date of the changelog - `featuredImage: optional string` The URL of the featured image for the changelog. External URLs will be uploaded to our storage. - `htmlContent: optional string` The HTML content of the changelog. Provide either htmlContent or markdownContent. For images, external URLs and base64 data URIs are automatically processed and stored. - `markdownContent: optional string` The markdown content of the changelog. Provide either htmlContent or markdownContent. For images, external URLs and base64 data URIs are automatically processed and stored. - `title: optional string` The title of the changelog ### Returns - `Changelog object { id, allowedSegmentIds, availableLocales, 21 more }` - `id: string` Unique identifier - `allowedSegmentIds: array of string` Segment IDs that are allowed to view this changelog - `availableLocales: array of string` Array of locale codes where the changelog has content - `categories: array of object { id, name, roles }` Categories the changelog belongs to - `id: string` Category unique identifier - `name: string` Category name - `roles: optional array of string` Roles allowed to view this category - `commentCount: number` Number of comments - `content: string` Content in HTML format - `createdAt: string` ISO 8601 timestamp when created - `date: string` Publication date as ISO 8601 timestamp - `emailSentToSubscribers: boolean` Whether email notification was sent to subscribers - `featuredImage: string` Featured image URL - `isDraftDiffersFromLive: boolean` Whether the draft content differs from the published live content - `isPublished: boolean` Whether the changelog is published (has a live version) in this locale - `locale: "bn" or "bs" or "pt-BR" or 39 more` Locale of the changelog - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `markdownContent: string` Content in markdown format - `notifications: map[object { scheduledDate, emailSent, hideFromBoardAndWidgets, sendEmailNotification } ]` Notification settings for each locale - `scheduledDate: string` Scheduled publication date as ISO 8601 timestamp - `emailSent: optional boolean` Whether the email notification has been sent - `hideFromBoardAndWidgets: optional boolean` Whether the changelog is hidden from the board and widgets - `sendEmailNotification: optional boolean` Whether email notification should be sent for this locale - `object: "changelog"` Object type identifier - `"changelog"` - `organization: string` Organization identifier - `publishedLocales: array of string` Array of locale codes where the changelog is published - `slug: string` URL-friendly slug - `slugs: map[string]` URL-friendly slugs for each locale - `state: "live" or "draft"` State of the changelog - `"live"` - `"draft"` - `title: string` Changelog title - `updatedAt: string` ISO 8601 timestamp when updated - `url: string` Public URL to view the changelog ### Example ```http curl https://do.featurebase.app/v2/changelogs/$ID \ -X PATCH \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" \ -d '{ "allowedSegmentIds": [ "507f1f77bcf86cd799439011" ], "categories": [ "New", "Fixed", "Improved" ], "date": "2024-01-15", "featuredImage": "https://example.com/image.png", "htmlContent": "Updated features to explore.
", "markdownContent": "Updated features to explore.", "title": "Updated Features Release" }' ``` #### Response ```json { "id": "6457e3ff70afca5d8c27dccc", "allowedSegmentIds": [ "string" ], "availableLocales": [ "en", "de", "fr" ], "categories": [ { "id": "6438a1efda3640f8feb72121", "name": "New Features", "roles": [ "string" ] } ], "commentCount": 2, "content": "Your changelog content in HTML format.
", "createdAt": "2023-12-12T00:00:00.000Z", "date": "2023-05-07T12:59:59.000Z", "emailSentToSubscribers": true, "featuredImage": "https://cdn.example.com/images/feature.png", "isDraftDiffersFromLive": false, "isPublished": true, "locale": "en", "markdownContent": "Your changelog content in markdown format.", "notifications": { "foo": { "scheduledDate": "2024-01-15T12:00:00.000Z", "emailSent": true, "hideFromBoardAndWidgets": false, "sendEmailNotification": true } }, "object": "changelog", "organization": "myorg", "publishedLocales": [ "en", "de" ], "slug": "your-awesome-changelog", "slugs": { "en": "your-awesome-changelog", "de": "dein-tolles-changelog" }, "state": "live", "title": "Your awesome changelog!", "updatedAt": "2023-12-13T00:00:00.000Z", "url": "https://myorg.featurebase.app/en/changelog/your-awesome-changelog" } ``` ## Delete a changelog **delete** `/v2/changelogs/{id}` Deletes a changelog by its unique identifier. ### Deletion Behavior The changelog and all associated comments are permanently deleted. This action cannot be undone. ### Permissions Only organization admins can delete changelogs. ### Response Returns a deletion confirmation: ```json { "id": "6457e3ff70afca5d8c27dccc", "object": "changelog", "deleted": true } ``` ### Errors - `400` - Invalid changelog ID format - `404` - Changelog not found or doesn't belong to your organization ### Path Parameters - `id: string` Changelog unique identifier ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Returns - `id: string` Unique identifier of the deleted changelog - `deleted: true` Indicates the resource was deleted - `true` - `object: "changelog"` Object type identifier - `"changelog"` ### Example ```http curl https://do.featurebase.app/v2/changelogs/$ID \ -X DELETE \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" ``` #### Response ```json { "id": "507f1f77bcf86cd799439011", "deleted": true, "object": "changelog" } ``` ## Publish a changelog **post** `/v2/changelogs/{id}/publish` Publishes a changelog and optionally sends an email notification to subscribers. ### Optional Fields - `sendEmail` - Whether to send an email notification to subscribers (default: false) - `locales` - Array of locales to publish. An empty array publishes to all available locales - `scheduledDate` - A future date/time when the changelog should be published ### Scheduling If `scheduledDate` is provided: - Must be a future date - The changelog will be scheduled for publishing at that time - Any existing scheduled publish for the same locales will be cancelled and replaced ### Email Notifications If `sendEmail` is true: - Email notifications are sent to all subscribers in the published locales - Emails are only sent once per locale (won't resend on republish) ### Response Returns a success confirmation: ```json { "success": true, "state": "published" } ``` Or for scheduled publishes: ```json { "success": true, "state": "scheduled" } ``` ### Errors - `400` - Invalid changelog ID or scheduled date is not in the future - `404` - Changelog not found or doesn't belong to your organization ### Path Parameters - `id: string` Changelog unique identifier ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Body Parameters - `locales: optional array of "bn" or "bs" or "pt-BR" or 39 more` An array of locales to publish the changelog to. An empty array publishes to all locales. - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `scheduledDate: optional string` The date when the changelog should be published. Must be a future date. Pass null or omit to publish immediately. - `sendEmail: optional boolean` A flag indicating whether to send an email notification to subscribers. ### Returns - `PublishUnpublishSuccess object { success, state }` - `success: true` Indicates the operation was successful - `true` - `state: optional "published" or "scheduled" or "unpublished"` The state of the changelog after the operation - `"published"` - `"scheduled"` - `"unpublished"` ### Example ```http curl https://do.featurebase.app/v2/changelogs/$ID/publish \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" \ -d '{ "locales": [ "en", "de" ], "scheduledDate": "2023-12-01T00:00:00Z", "sendEmail": true }' ``` #### Response ```json { "success": true, "state": "published" } ``` ## Unpublish a changelog **post** `/v2/changelogs/{id}/unpublish` Unpublishes a changelog, removing it from public view. ### Optional Fields - `locales` - Array of locales to unpublish from. An empty array unpublishes from all locales ### Behavior - The changelog content is preserved (reverts to draft state) - Any scheduled publishes for the specified locales are cancelled - The changelog can be re-published later ### Response Returns a success confirmation: ```json { "success": true, "state": "unpublished" } ``` ### Errors - `400` - Invalid changelog ID format - `404` - Changelog not found or doesn't belong to your organization ### Path Parameters - `id: string` Changelog unique identifier ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Body Parameters - `locales: optional array of "bn" or "bs" or "pt-BR" or 39 more` An array of locales to unpublish the changelog from. An empty array unpublishes from all locales. - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` ### Returns - `PublishUnpublishSuccess object { success, state }` - `success: true` Indicates the operation was successful - `true` - `state: optional "published" or "scheduled" or "unpublished"` The state of the changelog after the operation - `"published"` - `"scheduled"` - `"unpublished"` ### Example ```http curl https://do.featurebase.app/v2/changelogs/$ID/unpublish \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" \ -d '{ "locales": [ "en" ] }' ``` #### Response ```json { "success": true, "state": "published" } ``` ## Domain Types ### Changelog - `Changelog object { id, allowedSegmentIds, availableLocales, 21 more }` - `id: string` Unique identifier - `allowedSegmentIds: array of string` Segment IDs that are allowed to view this changelog - `availableLocales: array of string` Array of locale codes where the changelog has content - `categories: array of object { id, name, roles }` Categories the changelog belongs to - `id: string` Category unique identifier - `name: string` Category name - `roles: optional array of string` Roles allowed to view this category - `commentCount: number` Number of comments - `content: string` Content in HTML format - `createdAt: string` ISO 8601 timestamp when created - `date: string` Publication date as ISO 8601 timestamp - `emailSentToSubscribers: boolean` Whether email notification was sent to subscribers - `featuredImage: string` Featured image URL - `isDraftDiffersFromLive: boolean` Whether the draft content differs from the published live content - `isPublished: boolean` Whether the changelog is published (has a live version) in this locale - `locale: "bn" or "bs" or "pt-BR" or 39 more` Locale of the changelog - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `markdownContent: string` Content in markdown format - `notifications: map[object { scheduledDate, emailSent, hideFromBoardAndWidgets, sendEmailNotification } ]` Notification settings for each locale - `scheduledDate: string` Scheduled publication date as ISO 8601 timestamp - `emailSent: optional boolean` Whether the email notification has been sent - `hideFromBoardAndWidgets: optional boolean` Whether the changelog is hidden from the board and widgets - `sendEmailNotification: optional boolean` Whether email notification should be sent for this locale - `object: "changelog"` Object type identifier - `"changelog"` - `organization: string` Organization identifier - `publishedLocales: array of string` Array of locale codes where the changelog is published - `slug: string` URL-friendly slug - `slugs: map[string]` URL-friendly slugs for each locale - `state: "live" or "draft"` State of the changelog - `"live"` - `"draft"` - `title: string` Changelog title - `updatedAt: string` ISO 8601 timestamp when updated - `url: string` Public URL to view the changelog ### Publish Unpublish Success - `PublishUnpublishSuccess object { success, state }` - `success: true` Indicates the operation was successful - `true` - `state: optional "published" or "scheduled" or "unpublished"` The state of the changelog after the operation - `"published"` - `"scheduled"` - `"unpublished"` ### Changelog Delete Response - `ChangelogDeleteResponse object { id, deleted, object }` - `id: string` Unique identifier of the deleted changelog - `deleted: true` Indicates the resource was deleted - `true` - `object: "changelog"` Object type identifier - `"changelog"` # Subscribers ## Add changelog subscribers **post** `/v2/changelogs/subscribers` Adds email addresses as changelog subscribers in bulk. Subscribers will receive email notifications when new changelogs are published (if email notifications are enabled during publishing). ### Request Body - `emails` - Array of email addresses to add (required, 1-1000 emails) - `locale` - Locale for the subscribers (optional, defaults to organization default) ### Email Validation - Invalid email addresses are automatically filtered out - Emails are normalized (trimmed, lowercased) - Duplicate emails are deduplicated ### Rate Limiting This endpoint is rate limited to prevent abuse. If you need to import more subscribers, please contact support. ### Response Returns a confirmation with the count of processed emails: ```json { "object": "changelog_subscribers_import", "count": 150 } ``` ### Errors - `400` - Invalid request (empty emails array, too many emails) - `429` - Rate limit exceeded ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Body Parameters - `emails: array of string` Array of email addresses to add as changelog subscribers - `locale: optional "bn" or "bs" or "pt-BR" or 39 more` The locale for the subscribers. Defaults to organization default locale. - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` ### Returns - `count: number` Number of email addresses processed - `object: "changelog_subscribers_import"` Object type identifier - `"changelog_subscribers_import"` ### Example ```http curl https://do.featurebase.app/v2/changelogs/subscribers \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" \ -d '{ "emails": [ "john@example.com", "jane@example.com" ], "locale": "en" }' ``` #### Response ```json { "count": 150, "object": "changelog_subscribers_import" } ``` ## Remove changelog subscribers **delete** `/v2/changelogs/subscribers` Removes email addresses from changelog subscribers in bulk. Removed subscribers will no longer receive email notifications when new changelogs are published. ### Request Body - `emails` - Array of email addresses to remove (required, 1-1000 emails) ### Email Handling - Emails that don't exist as subscribers are silently ignored - Emails are normalized (trimmed, lowercased) before matching ### Response Returns a confirmation with the count of processed emails: ```json { "object": "changelog_subscribers_removal", "count": 150 } ``` ### Errors - `400` - Invalid request (empty emails array, too many emails) ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Body Parameters - `emails: array of string` Array of email addresses to remove from changelog subscribers ### Returns - `count: number` Number of email addresses processed - `object: "changelog_subscribers_removal"` Object type identifier - `"changelog_subscribers_removal"` ### Example ```http curl https://do.featurebase.app/v2/changelogs/subscribers \ -X DELETE \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" ``` #### Response ```json { "count": 150, "object": "changelog_subscribers_removal" } ``` ## Domain Types ### Subscriber Add Response - `SubscriberAddResponse object { count, object }` - `count: number` Number of email addresses processed - `object: "changelog_subscribers_import"` Object type identifier - `"changelog_subscribers_import"` ### Subscriber Remove Response - `SubscriberRemoveResponse object { count, object }` - `count: number` Number of email addresses processed - `object: "changelog_subscribers_removal"` Object type identifier - `"changelog_subscribers_removal"`