Stop sending from the custom email domain

DELETE

/customer-email/domain

const url = 'https://example.com/customer-email/domain';
const options = {
  method: 'DELETE',
  headers: {cookie: '__Host-bottle.session_token=<__Host-bottle.session_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://example.com/customer-email/domain \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Authorizations

sessionCookie
customer-email:write
apiKey
customer-email:write

Responses

200

Customer email settings

application/json

object

senderName

required

string

>= 1 characters <= 160 characters

senderAddress

required

string | null format: email

<= 200 characters

replyTo

required

string | null format: email

<= 200 characters

deliveryEmails

required

boolean

automaticOrderEmails

required

boolean

automaticDeliveryEmails

required

boolean

automaticInvoiceEmails

required

boolean

available

required

boolean

domain

required

string | null

status

required

string

Allowed values: default ownership_pending dns_pending verified problem

records

required

Array<object>

object

type

required

string

Allowed values: TXT MX CNAME

name

required

string

value

required

string

priority

integer

status

required

string

checkedAt

required

string | null format: date-time

problem

required

string | null

Allowed values: ownership dns provider setup

Example

{
  "status": "default",
  "records": [
    {
      "type": "TXT"
    }
  ],
  "problem": "ownership"
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not permitted

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Domain already in use or must be disconnected first

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Invalid settings

application/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}