Add a number to your do-not-call list
Nothing is dialled to this number from now on, whichever way a call is placed: calls waiting for it are cancelled and never count as attempts or failures.
Nothing is dialled to this number from now on, whichever way a call is placed: calls waiting for it are cancelled and never count as attempts or failures. Calls the person makes to you are not affected. Idempotent.
Rate limit: 2000 requests per minute per organization, counted together with every endpoint that has no stricter limit of its own. Exceeding it returns 429 with Retry-After; the X-RateLimit-* response headers report your remaining allowance on every call.
v2/do-not-callAuthorization
AuthorizationRequiredBearer <token>
Your Graine API key. Create one in the dashboard under Developers, or via POST /v2/api-keys. Send it as Authorization: Bearer <key>.
In: header
Request Body
application/jsonRequiredphoneRequiredPhone
The number, with its country code.
1Maximum length: 64reasonReason | null
Why, in a few words. Avoid personal details.
200Response Body
201
The entry.
idRequiredId
The entry's id.
phone_maskedPhone Masked | null
The number, masked.
sourceSource | null
How it got here: manual, csv, api, erasure or opt_out.
reasonReason | null
Why, if you said.
added_byAdded By | null
Who added it: a member or a key.
created_atCreated At | null
When it was added.
createdRequiredCreated
False when the number was already on the list.
400
1000 — malformed or contradictory input. 1002 — a required parameter is missing.
errorRequiredError
Stable integer code from the /v2 error table. Branch on this.
messageRequiredMessage
One human-readable sentence. Wording may change; the code will not.
401
1100 — missing, unknown or inactive API key. 1101 — a browser session token was presented instead of an API key.
errorRequiredError
Stable integer code from the /v2 error table. Branch on this.
messageRequiredMessage
One human-readable sentence. Wording may change; the code will not.
403
1102 — the key is valid but lacks the scope this endpoint requires, or names another organization. GET /v2/scopes reports what a key holds.
errorRequiredError
Stable integer code from the /v2 error table. Branch on this.
messageRequiredMessage
One human-readable sentence. Wording may change; the code will not.
422
1001 — the body or query failed validation; the message names the first offending field.
errorRequiredinteger
Stable integer code from the error table. Branch on this, not on the message.
messageRequiredstring
One human-readable sentence. Wording may change; the code will not.
429
1300 — the per-organization request rate or concurrent-call limit was reached. Carries Retry-After.
errorRequiredError
Stable integer code from the /v2 error table. Branch on this.
messageRequiredMessage
One human-readable sentence. Wording may change; the code will not.
503
1501 — a service this endpoint depends on is unreachable or returned a 5xx.
errorRequiredError
Stable integer code from the /v2 error table. Branch on this.
messageRequiredMessage
One human-readable sentence. Wording may change; the code will not.
The entry.

