Set default customer email address

Set a customer email as default. The default will be set only for the email type of the given email.

^{Required permissions: customer:write}

POST /customer-email-addresses/{id}/default

cURL

cURL

curl -X POST \
 /customer-email-addresses/{id}/default \
 --header "Authorization: Bearer <token>"

201

{
  "email": "[e-mail]",
  "receiverName": "John Doe",
  "id": "00000000-0000-0000-0000-000000000000",
  "isInvoiceEmail": true,
  "isDunningEmail": false,
  "default": "true"
}

Autorisierungen

Authorization · string · header · erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Pfadparameter

id · string · erforderlich

CustomerEmail identifier

Antwort

201

application/json

CustomerEmail resource created

email · string<email> · erforderlich

Maximum string length: 255

Beispiel:

"[e-mail]"

receiverName · string · erforderlich

Maximum string length: 255

Beispiel:

"John Doe"

id · string

Beispiel:

"00000000-0000-0000-0000-000000000000"

isInvoiceEmail · boolean

Use this email for invoices, credits and financial documents.

Beispiel:

true

isDunningEmail · boolean

Use this email for dunning reminders and payment reminders.

Beispiel:

false

default · boolean

Beispiel:

"true"