Update customer email address

Update customer email address

^{Required permissions: customer:write}

PATCH /customer-email-addresses/{id}

Update customer email address

cURL

curl --request PATCH \
  --url https://coreapi.io/customer-email-addresses/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '
{
  "email": "[e-mail]",
  "receiverName": "John Doe",
  "isInvoiceEmail": true,
  "isDunningEmail": false
}
'

200

{
  "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

Body

application/merge-patch+jsonapplication/vnd.api+json

The updated CustomerEmail resource

email · string<email> · erforderlich

Maximum string length: 255

Beispiel:

"[e-mail]"

receiverName · string · erforderlich

Maximum string length: 255

Beispiel:

"John Doe"

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

Antwort

200

application/json

CustomerEmail resource updated

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"