Skip to content
nsin docs
EN فا

Dismiss a recommendation

POST
/recommendations/dismiss
 
curl --request POST \
  --url 'https://api.nsin.ir/recommendations/dismiss?domain=example.com' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "key": "example" }'

Hides one checklist item for the calling user on this domain. Dismissals are per user, not per domain — they do not affect other members.

How long it stays hidden depends on the item’s severity: a low item is hidden for good, a medium one for 7 days, and a high one cannot be hidden at all (409). Repeating the call on a medium item restarts its 7 days. Requires domain.view — dismissing only changes what you see.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
domain
required
string

The domain name (for example example.com). These endpoints take the domain as a query parameter rather than a path segment.

Example 
example.com

Request Body required

Section titled “Request Body required ”
Media type application/json
object
key
required

The recommendation’s key.

string
Example generated
{
  "key": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Dismissed.

Media type application/json
object
ok
boolean
Example 
{
  "ok": true
}

400

Section titled “400 ”

Missing domain, or missing key in the body.

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 and this endpoint is a write. Read-only keys may only issue GET, HEAD and OPTIONS.

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 readOnly 
{
  "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 item is a high-severity warning, which cannot be dismissed.

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