Subscribe an email to the changelog

POST

/v1/changelog/subscribers

Adds an email subscriber to receive changelog notification emails whenever a public entry is published with notify_subscribers: true. labels (slugs) limits the emails to entries carrying one of them; none means every public entry. From a browser, unknown slugs are skipped and an existing subscriber’s labels are left as they are; a secret key is told about unknown slugs and replaces an existing subscriber’s labels.

Confirmation: a browser subscription (publishable key) waits for the person to confirm from one email with a Confirm button (confirmed: false), and the answer is 201 whether or not the address was already subscribed; unconfirmed subscriptions are removed after 7 days, and changelog.subscriber.created fires on confirmation. A secret key’s subscription is confirmed at once.

Auth: Publishable key (nv_pub_live_*), browser-safe.

CORS: Access-Control-Allow-Origin: *.

Authorizations

• PublishableApiKey
• SecretApiKey

Request Body ^required

object

email

required

string format: email

<= 254 characters /^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

labels

Array<string>

<= 20 items

Responses

201

Subscriber created

object

data

required

object

id

required

string

/^sub_[0-9A-HJKMNP-TV-Z]{26}$/

project_id

required

string

/^prj_[0-9A-HJKMNP-TV-Z]{26}$/

email

required

string format: email

/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

confirmed

required

boolean

created_at

required

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

error

required

null

meta

object

key

additional properties

401

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties

409

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties