API Reference

This section documents all available API endpoints for the NotifiedBy service. All endpoints are served at https://api.notifiedby.com/v1/ and require authentication via an API key passed in the Authorization header.

Authorization: Api-Key YOUR_API_KEY

Note

The email flows feature must be enabled for your team. If you receive a 403 response, contact support to have the feature activated on your account.

Email Endpoints

Method	Endpoint	Description
POST	`/v1/email/send/`	Send an email to a recipient.
GET	`/v1/email/list/`	List sent emails.
GET	`/v1/email/detail/<id>/`	Get full details of a sent email.

Flow Endpoints

Method	Endpoint	Description
POST	`/v1/flows/subscribe/`	Subscribe a recipient to a flow.
POST	`/v1/flows/unsubscribe/`	Unsubscribe a recipient from a flow.
GET	`/v1/flows/subscriptions/`	List flow subscriptions.
DELETE	`/v1/flows/subscriptions/`	Delete a flow subscription.

Recipient Endpoints

Method	Endpoint	Description
POST	`/v1/recipients/`	Create or update a recipient.
GET	`/v1/recipients/`	List all recipients.

Flag Endpoints

Method	Endpoint	Description
POST	`/v1/recipients/flags/set/`	Set flags on a recipient.
POST	`/v1/recipients/flags/clear/`	Clear flags from a recipient.

Authentication Errors

All endpoints return 401 or 403 if the API key is missing, invalid, or the email flows feature is not enabled for your team.

{"detail": "Authentication credentials were not provided."}