StatusGator Octri Preview
POST/boards/{board_id}/status_page_subscribers

Create a status page subscriber

Creates a status page subscription for the specified board. Provide the subscriber's email; use monitor_ids to target specific monitors or omit it to subscribe to all monitors. A confirmation email is sent unless skip_confirmation is true, and a 201 response returns the created subscriber.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
board_idstringrequired
The unique identifier of the board whose status page will receive the subscription.

Status page subscription details. When a body is provided, it must include the subscriber object.

subscriberobjectrequired
The subscriber details, including an email address and optional monitor preferences.

5 status codes
200Returns a success indicator when the subscriber already exists.
201Returns the created subscriber, including its email, confirmation status, subscribed monitor IDs, and timestamps.
dataobjectoptional
successbooleanoptional
401Returned when the request is unauthorized.
errorsarray<string>optional
successbooleanoptional
404Returned when the board's status page does not exist.
errorsarray<string>optional
successbooleanoptional
422Returned when the subscriber's email address is invalid.
errorsarray<string>optional
successbooleanoptional

Error handling

A 401 is returned when the authenticated user is not authorized to create the subscription. A 404 is returned when the status page for the board_id path parameter does not exist. A 422 is returned when subscriber.email is invalid. When you provide a body, include the subscriber object and its required email field.