Add changelog subscribers
client.changelogs.subscribers.add(SubscriberAddParams { emails, locale, featurebaseVersion } params, RequestOptionsoptions?): SubscriberAddResponse { count, object }
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:
{
"object": "changelog_subscribers_import",
"count": 150
}Errors
400- Invalid request (empty emails array, too many emails)429- Rate limit exceeded
Add changelog subscribers
import Featurebase from 'featurebase-node';
const client = new Featurebase({
apiKey: process.env['FEATUREBASE_API_KEY'], // This is the default and can be omitted
});
const response = await client.changelogs.subscribers.add({
emails: ['john@example.com', 'jane@example.com'],
});
console.log(response.count);{
"count": 150,
"object": "changelog_subscribers_import"
}Returns Examples
{
"count": 150,
"object": "changelog_subscribers_import"
}