Preview a branded customer email

GET

/customer-email/preview

curl --request GET \
  --url https://example.com/customer-email/preview \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Authorizations

• sessionCookie
  customer-email:read
• apiKey
  customer-email:read

Responses

200

HTML and plain-text preview

Media typeapplication/json

object

html

required

string

text

required

string

Example ^generated

{
  "html": "example",
  "text": "example"
}

401

Not signed in

Media typeapplication/json

object

error

required

string

message

required

string

Example

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

403

Not permitted

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

Media typeapplication/json

object

error

required

string

message

required

string

Example

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

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