Skip to content

Delete many records at once

POST
/domains/{domain}/records/batch-delete
curl --request POST \
--url https://api.nsin.ir/domains/example.com/records/batch-delete \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "ids": [ 1 ] }'

Deletes many records in one request. Best-effort per record — see batch-update. Requires records.edit.

domain
required
string

The domain name (for example example.com) — not a numeric id.

Example
example.com
Media type application/json
object
ids
required
Array<integer>
Example generated
{
"ids": [
1
]
}

Per-record outcome.

Media type application/json

Outcome of a best-effort bulk operation. The status code is 200 even when some records failed — inspect results.

object
succeeded
integer
failed
integer
results
Array<object>
object
id
integer
ok
boolean
error

Present only when ok is false.

string
Example generated
{
"succeeded": 1,
"failed": 1,
"results": [
{
"id": 1,
"ok": true,
"error": "example"
}
]
}

Missing, malformed, revoked or expired API key — or the owning account is inactive.

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Examples
Example invalidKey
{
"error": "invalid API key"
}

The key is read-only, your role on the domain lacks the required permission, or the domain’s plan does not include the feature.

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Example
{
"error": "read-only API key"
}

No such domain, or it is not visible to this account. Domains you cannot access are reported as not found rather than forbidden.

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Example
{
"error": "read-only API key"
}

The key exceeded its request budget (300 requests per minute by default).

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Examples
Example limited
{
"error": "rate limit exceeded"
}