Remove a forwarding address
Remove an address.
https://app.usenotix.dev/api/v1/forwarding-destinations/{id}Needs a full access key. Sending access keys cannot call this. Key permissions lists the extra rules some calls have.
Remove an address. It is taken off every rule that used it, and gets no more forwards.
Who can call it
A full access key made by a team admin, as on the dashboard. Every refusal is 403:
| Code | Why |
|---|---|
SCOPE_DENIED | The key is not a full access key (send-only, read only or live AI). |
FORBIDDEN | The key was made by a team member without admin rights, or before Notix recorded who made each key. Create a new key as a team admin. |
DOMAIN_PINNED | The key is limited to one domain and the rule is on another, which is always refused here. |
Path parameters
Headers
Bearer followed by your API key.
Errors
`SCOPE_DENIED`: not a full access key. `DOMAIN_PINNED`: the key is limited to one domain. `FORBIDDEN`: the key was made by a team member without admin rights, or before Notix recorded who made each key; or the team has 100 addresses.
No forwarding address with this id for the calling team.
The team changed forwarding addresses 10 times in the last minute.
Notix cannot count the team's calls just now; try again shortly.
Every error has the same shape. See all error codes.
curl -X DELETE "https://app.usenotix.dev/api/v1/forwarding-destinations/<id>" \
-H "Authorization: Bearer $NOTIX_API_KEY"
import { Notix } from "notix-js";
const notix = new Notix(process.env.NOTIX_API_KEY);
const { data, error } = await notix.forwarding.removeDestination("clx9f2k3l0002qz8a7b6c5d4e");
{
"id": "cm1x8f3k20001qz7v5b9d2e4a",
"rulesUpdated": 1
}