Skip to main content
Version: 7.6.x

Emails

The emails resource stores a customer’s emails.

Out of the box, customers can have only one email, which is their user name. If you create a new email for a registered customer, this changes the customer’s user name.

Read Emails​

Read the customer’s list of emails.

Workflow​

  1. Start with profile
  2. GET the link with rel: emails
  3. Render the response

Read Email​

Read an email from a list of the customer’s emails.

Workflow​

  1. Start with emails
  2. GET the link with rel: element
  3. Render the response

Response Fields​

Type: emails.email​

NameDescriptionType
emailThe email address.string

Add Email​

Add an email to a logged in customer. Out of the box, customers can have only one email, which is their user name. If you create a new email for a registered customer, this changes the customer’s user name.

Workflow​

  1. Start with emails
  2. GET the link with rel: emailform
  3. Fill out the form
  4. POST the form using the link with rel: createemailaction

Request Fields​

Type: emails.email​

NameDescriptionType
emailThe email address.string