Skip to content
bynhDocs
Log in

Invite a subscriber

POST/workspaces/{workspace}/status/subscribers

Invites an email address to your status page updates. They get a confirmation email and receive nothing until they confirm.

Authentication

Send an API token as a bearer token. This endpoint needs a read and write token, made by an editor, admin or owner. Create one in My account → API tokens; see scopes and roles.

Authorization: Bearer 42|bynh_pat_•••••••Header

Path parameters

  • workspacestringRequired

    Your workspace slug, e.g. dokan.

Request body

application/json

  • emailstringRequiredmax 254

    RFC email. “Enter the email address to invite.” / “Enter a full email address, like ops@example.com.”

  • companystring, nullablemax 120

    Company.

Response

201 Created

The subscriber (follows reads “All components”).

  • idintegerSubscriber id.
  • emailstringLower-cased.
  • companystring|nullCompany.
  • channelenumAlways email. One of email.
  • scopeenumWhat they follow. One of all, components, maintenance.
  • followsstringLocalized description of scope (component names for components).
  • sourcestringHow they joined, manual (added in the app or API), import (CSV), form (the public status page).
  • confirmedbooleanClicked the confirmation link.
  • confirmed_atstring|nullISO 8601.
  • confirmation_sent_atstring|nullISO 8601.
  • last_notified_atstring|nullISO 8601.
  • created_atstringISO 8601.

Rate limits

This endpoint counts toward your general limit of 120 requests a minute and its own limit of 60 an hour. Its own limit answers 429 without Retry-After; wait and try again.

Errors

401The token is missing, wrong, revoked or expired.
403The token is read-only (message: “This token is read-only. Create a read and write token to make changes.”). Or: The token’s owner is a viewer (“Viewers can read everything but can’t change it.”), or the workspace’s editing is paused (a billing message, e.g. “Your trial has ended, so editing is paused. …”).
404The token belongs to another workspace, or its owner is no longer a member.
422Invalid email, or the address is already confirmed (“That address already gets your updates.”).
429More than 60 invites an hour (“Too many attempts. Wait a few minutes, then try again.”).

Every error is JSON with a message. See Errors.

Next →List access requests
curl -X POST "https://api.bynh.io/api/v1/workspaces/dokan/status/subscribers" \
  -H "Authorization: Bearer $BYNH_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "ops@almarai-retail.sa",
    "company": "Almarai Retail"
  }'

Response201 Created

application/json
{
  "data": {
    "id": 301,
    "email": "ops@almarai-retail.sa",
    "company": "Almarai Retail",
    "channel": "email",
    "scope": "all",
    "follows": "All components",
    "source": "manual",
    "confirmed": false,
    "confirmed_at": null,
    "confirmation_sent_at": "2026-10-01T08:10:00+00:00",
    "last_notified_at": null,
    "created_at": "2026-10-01T08:10:00+00:00"
  }
}

Examples use Dokan, a sample workspace. Responses are shortened where lists are long.