Skip to content
Bottle

Save customer email settings

PUT
/customer-email
curl --request PUT \
  --url https://example.com/customer-email \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "senderName": "example", "senderAddress": "hello@example.com", "replyTo": "hello@example.com", "deliveryEmails": true, "automaticOrderEmails": true, "automaticDeliveryEmails": true, "automaticInvoiceEmails": true }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/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
boolean
automaticDeliveryEmails
boolean
automaticInvoiceEmails
boolean

Example generated

{
  "senderName": "example",
  "senderAddress": "hello@example.com",
  "replyTo": "hello@example.com",
  "deliveryEmails": true,
  "automaticOrderEmails": true,
  "automaticDeliveryEmails": true,
  "automaticInvoiceEmails": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Customer email settings

Media typeapplication/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

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

403

Section titled “403”

Not permitted

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

409

Section titled “409”

Domain already in use or must be disconnected first

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

422

Section titled “422”

Invalid settings

Media typeapplication/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"
    }
  ]
}