Skip to content
Bottle

Set a connected shop's own sender address, or go back to the business's

PUT
/customer-email/shops/{shopId}
curl --request PUT \
  --url https://example.com/customer-email/shops/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "senderAddress": "hello@example.com", "replyTo": "hello@example.com" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
shopId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
senderAddress
required
string | null format: email
<= 200 characters
replyTo
required
string | null format: email
<= 200 characters

Example generated

{
  "senderAddress": "hello@example.com",
  "replyTo": "hello@example.com"
}

Responses

Section titled “Responses”

200

Section titled “200”

A connected shop’s sender

Media typeapplication/json
object
senderAddress
required
string | null format: email
<= 200 characters
replyTo
required
string | null format: email
<= 200 characters
shopId
required
string format: uuid
shopName
required
string
customerName
required
string | null
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"
}

404

Section titled “404”

No such connected shop

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