Remove a member

DELETE

/domains/{domain}/members/{userId}

const url = 'https://api.nsin.ir/domains/example.com/members/1';
const options = {method: 'DELETE', 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 DELETE \
  --url https://api.nsin.ir/domains/example.com/members/1 \
  --header 'Authorization: Bearer <token>'

Revokes a member’s access to the domain. Removing someone else requires members.manage; any member may remove themselves (leave the domain) with just domain.view. The owner cannot be removed. If the member was the domain’s nominated payer, the nomination is cleared at the same time and both they and the owner are notified — the owner pays again.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

domain

required

string

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

Example

example.com

userId

required

integer

The member’s user id, from the member list.

Responses

200

Removed.

application/json

object

message

string

Example

{
  "message": "deleted"
}

400

Invalid user id, or an attempt to remove the owner.

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. (A valid key whose account has been deactivated gets 403 account is inactive instead.)

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

Domain or member not found.

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