Request a review of a paused domain
Ask Notix to review a domain that was paused for its sending reputation (hard bounces or complaints over the limit), as the domain card's Request review…
https://app.usenotix.dev/api/v1/domains/{id}/reviewNeeds a full access key. Sending access keys cannot call this. Key permissions lists the extra rules some calls have.
Ask Notix to review a domain that was paused for its sending reputation (hard bounces or complaints over the limit), as the domain card's Request review button does. Notix's team is told at once. It only asks: the domain stays paused, and its queued email stays held, until a person at Notix has looked at it and resumes it; the team is emailed if it is resumed. Read why it was paused with GET /v1/domains/{id}/status.
A review is asked for once per pause: calling again while the domain is still paused answers the first request's time with alreadyRequested: true, and tells no one again. A domain that is not paused, or was resumed meanwhile, answers 409. If Notix cannot pass the request on to its team, the answer is 503 and nothing is recorded, so try again. Send no body, or an empty JSON object.
Who can call it
Full access keys made by someone who is a team admin today (or the team owner), as the button is for team admins: a key made by a member answers 403, and so does a key made before Notix recorded who made each key. A key limited to one domain may ask about that domain only; any other id answers 404. Read only, send-only and live AI keys answer 403 SCOPE_DENIED. Notix's own domains answer 403. Every request is recorded in the key's audit log.
The team can call this 10 times a minute; past that the answer is 429 with Retry-After. Calls with a malformed body or id count too. When Notix cannot count the calls the answer is 503 SERVICE_UNAVAILABLE, never a 429.
Path parameters
Minimum 0. Maximum 2147483647.
Headers
Bearer followed by your API key.
Errors
A field in the body, or a body not sent as JSON.
`SCOPE_DENIED`: a read only, send-only or live AI key. Or a key made by a team member who is not an admin today, a key older than Notix's record of who made it, or a domain that belongs to Notix.
No domain with this id for the calling team, or a key limited to one domain asked about another.
The domain is not paused, so there is nothing to review.
The team asked for 10 domain reviews in the last minute.
Notix cannot count the team's calls just now, or could not pass the request on to its team (nothing was recorded); try again shortly.
Every error has the same shape. See all error codes.
curl -X POST "https://app.usenotix.dev/api/v1/domains/<id>/review" \
-H "Authorization: Bearer $NOTIX_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'
import { Notix } from "notix-js";
const notix = new Notix(process.env.NOTIX_API_KEY);
const { data, error } = await notix.domains.requestReview(12);
console.log(data?.reviewRequestedAt, data?.alreadyRequested);
{
"id": 1,
"name": "mail.example.com",
"sendingState": "ACTIVE",
"reviewRequestedAt": "string",
"alreadyRequested": true,
"message": "string"
}