Email Addresses
An email address record stores a customer’s email along with its verification status, marketing consent and delivery health. The API lets you create, retrieve, update and delete email addresses. See Managing Email Addresses for the user guide.
Methods
Section titled “Methods”Retrieve Single Email Address
Section titled “Retrieve Single Email Address”/backend/api/v1/emailAddresses/ID - fetch the email address with the specified ID.
List Email Addresses
Section titled “List Email Addresses”/backend/api/v1/emailAddresses/ - list all email addresses.
/backend/api/v1/customers/ID/emailAddresses/ - list email addresses for the customer with the specified ID.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include addresses with a higher ID |
createdSince | datetime | No | Only include addresses created since the given time |
updatedSince | datetime | No | Only include addresses updated since the given time |
/backend/api/v1/customers/ID/emailAddresses/ - add a new email address to the specified customer. The newly-added address will be returned.
/backend/api/v1/emailAddresses/ID - update the email address with the specified ID. The modified address will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/emailAddresses/ID - delete the email address with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| dealerCode | Dealer Code | Preset Value | Dealer code associated with this email address |
| Email Address | Text | The email address itself | |
| verificationSentDate | Verification Email Sent | Date | Date when a verification email was most recently sent to this address |
| verificationStamp | Verified On | Date | Date when this email address was verified by the customer |
| marketingConsent | Marketing Consent Given | Preset Value | Whether the customer has given consent to receive marketing emails |
| reactivationKeyExpiresDate | Reactivation Key Expires | Date | Expiry date for the address reactivation key |
| myAccountAccess | MyAccount Access | Preset Value | Whether this email address has MyAccount portal access |
| attachmentPreference | Attachment Preference | Preset Value | User preference for how email attachments should be handled |
| badEmailStatus | Failure Type | Preset Value | Type of email delivery failure, if any |
| badEmailRemovable | Removable | Text | Whether this failed email address can be manually removed |
| id | Email Address ID | Text | The unique identifier for this email address record |