Skip to main content
Changelogs

Add changelog subscribers

Adds email addresses as changelog subscribers in bulk.

POST
/v2/changelogs/subscribers

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
Authorizationstringheaderrequired

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

Featurebase-Versionenum<string>header

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

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

Body

application/json
emailsstring[]required

Array of email addresses to add as changelog subscribers

Required array length: 1 - 1000
localeenum<string>

The locale for the subscribers. Defaults to organization default locale.

Available options: ar, am, fa, ht, lo, my, pa, ps, so, tl, ur, he, ta, te, mr, gu, kn, ml, ha, jv, yo, ig, uz, ne, sd, az, si, km, kk, 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
Example: en

Response

application/json

Success

countnumberrequired

Number of email addresses processed

Example: 150
objectenum<string>required

Object type identifier

Available options: changelog_subscribers_import
Example: changelog_subscribers_import