API version:
  • 1.0
  • 1.1
  • 2.0

accounts/email_addresses

Supported methods

List methods:GETPOST

Instance methods:GETPOSTDELETE

The main purpose of this resource is to filter out results in the contacts resource. If the account holder sends or receives emails using aliases, add those aliases here and they won't show up in the results of the contacts resource.

Adding a source on the account will automatically populate the list of email_addreses based on the email given for that source.

email_addresses list

GET: List of email addressed used by an account

List your configured user account emails.

GET https://api.context.io/2.0/accounts/id/email_addressestest it
idUnique id of an account accessible through your API key

Response body

[
  {
    "email": stringEmail address associated to an account,
    "validated": numberUnix timestamp of email address validation time,
    "primary": numberWhether or not this address is the primary one asssociated to the account: 1 for yes, 0 for no
  },
  ...
]

POST: Adding a new email addresses as an alias for an account
POST https://api.context.io/2.0/accounts/id/email_addressestest it
idUnique id of an account accessible through your API key

Parameters

nametypedescription
required:
email_addressstringAn email address

Response body

{
  "success": booleanwhether or not the email address was succesfully added,
  "email_address": stringemail address added to the account,
  "resource_url": stringComplete URL of the resource created
}

email_addresses instance

POST: Modifiying a given email address
POST https://api.context.io/2.0/accounts/id/email_addresses/emailtest it
idUnique id of an account accessible through your API key
emailOne of the email addresses associated to the account

Parameters

nametypedescription
optional:
primaryintegerSet to 1 to make this email address the primary one for the account

Response body

{
  "success": booleanwhether or not the email address was succesfully modified
}

DELETE: Removing an email addresses form the aliases of an account
DELETE https://api.context.io/2.0/accounts/id/email_addresses/emailtest it
idUnique id of an account accessible through your API key
emailOne of the email addresses associated to the account