Admin API
Disable a project
Stop a project from sending. Nothing is deleted, and it can be enabled again.
DELETE
/v1/admin/projects/{slug}Admin keyDespite the DELETE method, this does not delete anything. It sets the project's disabledAt, the same as updating it with { "disabled": true }. Its emails, keys, templates and contacts stay.
While a project is disabled:
- Requests with its API keys fail with
403 project_disabled. - RPC calls for its slug fail with
403 project_disabled. - A broadcast that is sending is canceled on its next cron tick.
- Resend an email refuses its emails with
403 project_disabled.
To turn it back on, send PATCH /v1/admin/projects/:slug with { "disabled": false }, or run flaresend projects enable <slug>.
Path parameters
The project slug.
Response
Status 200 with the project, now with disabledAt set. Calling it on a project that is already disabled keeps the original disabledAt.
Errors
| Status | Code | When |
|---|---|---|
| 404 | project_not_found | No project has this slug. |