Add free email domain

POST

/api/v1/instance/free-email-domains

curl --request POST \
  --url https://example.com/api/v1/instance/free-email-domains \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: <X-CSRF-Token>' \
  --cookie ttx_access_token=<ttx_access_token> \
  --data '{ "domain": "example" }'

Add a domain to the free email domains.

Authorizations

• csrfToken
• sessionCookie

Request Body^required

Media typeapplication/json

FreeEmailDomainCreateRequest

object

domain

required

Domain

string

>= 3 characters <= 253 characters /^[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/

Example ^generated

{
  "domain": "example"
}

Responses

201

Successful Response

Media typeapplication/json

FreeEmailDomainRead

object

active

required

Active

boolean

builtin

required

Builtin

boolean

domain

required

Domain

string

Example ^generated

{
  "active": true,
  "builtin": true,
  "domain": "example"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}