Skip to content
nsin docs
EN فا

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, at most 1000 per call. Best-effort per record — see batch-update; records NSIN manages are refused per item. Requires records.edit.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
domain
required
string

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

Example 
example.com

Request Body required

Section titled “Request Body required ”
Media type application/json
object
ids
required
Array<integer>
Example generated
{
  "ids": [
    1
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

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"
    }
  ]
}

400

Section titled “400 ”

Malformed body, an empty ids, or more than 1000 records.

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"
}

401

Section titled “401 ”

Missing, malformed, revoked or expired API key. (A valid key whose account has been deactivated gets 403 account is inactive instead.)

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"
}

403

Section titled “403 ”

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"
}

404

Section titled “404 ”

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"
}

409

Section titled “409 ”

The domain is disabled or banned.

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"
}

429

Section titled “429 ”

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"
}