Create customer email address

Create customer email address

^{Required permissions: customer:write}

POST /customers/{customerId}/email-addresses

cURL

cURL

curl -X POST \
 /customers/{customerId}/email-addresses \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "email": "[e-mail]",
    "receiverName": "John Doe"
}'

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

customerId · string · erforderlich

CustomerEmail identifier

Body

application/jsontext/html

The new CustomerEmail resource

email · string<email> · erforderlich

Maximum string length: 255

Beispiel:

"[e-mail]"

receiverName · string

Maximum string length: 255

Beispiel:

"John Doe"

isInvoiceEmail · boolean · Standard: false

Use this to send invoices, credits and reminders to the customer.

Beispiel:

false

isDunningEmail · boolean · Standard: false

Use this to send dunning reminders to the customer.

Beispiel:

false

isDefault · boolean · Standard: false

Set this email as the primary/default email address.

Beispiel:

false

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"