Enable or disable an email address

POST

/domains/{domain}/email-routing/rules/{ruleId}/toggle

const url = 'https://api.nsin.ir/domains/example.com/email-routing/rules/1/toggle';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.nsin.ir/domains/example.com/email-routing/rules/1/toggle \
  --header 'Authorization: Bearer <token>'

Flips enabled. Requires records.edit.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

domain

required

string

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

Example

example.com

ruleId

required

integer

Numeric id of the email address rule, from the rule list.

Responses

200

The rule after the flip.

application/json

object

integer

local_part

string

address

The full address, local_part@domain.

string

action

string

Allowed values: forward drop

destination_id

integer

nullable

destination_email

string

nullable

destination_verified

boolean

enabled

Your switch.

boolean

active

Whether the address is live right now — enabled, routing on for the domain, and (for forward) the destination verified.

boolean

name

Optional label.

string

created_at

string format: date-time

updated_at

string format: date-time

Example

{
  "action": "forward"
}

400

The rule forwards but has no destination; set one first.

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

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

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

invalidKey

{
  "error": "invalid API key"
}

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.

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

No such domain, or no such rule on it.

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

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

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

limited

{
  "error": "rate limit exceeded"
}