Remove an email domain

DELETE

/api/v1/email-domains/{domain}

curl --request DELETE \
  --url http://localhost:3000/api/v1/email-domains/example \
  --header 'Authorization: Bearer <token>'

Not while single sign-on uses it: change its domain, or turn it off, first.

Scope: admin.

Authorizations

• bearer
• session
• None

Parameters

Path Parameters

domain

required

string

E.g. acme.com

Responses

200

Removed

Media typeapplication/json

object

data

required

object

deleted

required

boolean

Example

{
  "data": {
    "deleted": true
  }
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}