POST
/
customers
/
{customerId}
/
email-addresses
curl -X POST \
 /customers/{customerId}/email-addresses \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "email": "john.doe@example.com",
    "receiverName": "John Doe"
}'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "email": "john.doe@example.com",
  "receiverName": "John Doe",
  "type": "TYPE_COMPANY",
  "default": "true"
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

​
customerId
string
required

CustomerEmail identifier

Body

The new CustomerEmail resource
​
email
string
required
Maximum length: 255
Example:

"john.doe@example.com"

​
receiverName
string
required
Maximum length: 255
Example:

"John Doe"

​
type
enum<string>
required
Available options:
TYPE_COMPANY,
TYPE_INVOICE
Example:

"TYPE_COMPANY"

Response

201
application/json
CustomerEmail resource created
​
email
string
required
Maximum length: 255
Example:

"john.doe@example.com"

​
receiverName
string
required
Maximum length: 255
Example:

"John Doe"

​
type
enum<string>
required
Available options:
TYPE_COMPANY,
TYPE_INVOICE
Example:

"TYPE_COMPANY"

​
id
string
Example:

"00000000-0000-0000-0000-000000000000"

​
default
boolean
Example:

"true"

Was this page helpful?

Suggest editsRaise issue