Email Address

A prospect's email address

createdAt
string <date-time>

The date and time the email address was created.

email
string <email> <= 255 characters

The raw email address value

emailType
string <= 255 characters

Type of email address (work or personal)

order
integer

Ordered position in list of emails

status
string <= 255 characters

The status of the email

statusChangedAt
string <date-time>

Time the status was updated

unsubscribedAt
string <date-time>

Time a mailing was unsubscribed using this address

updatedAt
string <date-time>

The date and time the email address was last updated.

{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "emailType": "string",
  • "order": 0,
  • "status": "string",
  • "statusChangedAt": "2019-08-24T14:15:22Z",
  • "unsubscribedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Email Address Relationships

data (object) or links (object) (prospect)

The owning prospect You can use only the attribute id to filter emailAddresses by prospect (e.g. filter[prospect][id]=X).

{
  • "prospect": {
    }
}

Email Address Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta

⌵ Email Address Actions

Get a Collection of Email Addresses

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/emailAddresses
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New Email Address
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/emailAddresses
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Delete an Existing Email Address by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/emailAddresses/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "errors": [
    ]
}
Get an Email Address by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/emailAddresses/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update an Email Address
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/emailAddresses/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}