Email Addresses

Email Addresses Documentation

Email Address [LIST]

Email Address [LIST]

Request

Endpoint

GET /api/v2/contacts/0d89a8f1-3503-4722-a25f-a1821d3fafc5/people/ce2b82f1-5305-44a3-8111-4d5dd324a675/email_addresses
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "755c8fa3-7541-478f-b7dd-270d7e70da45",
      "type": "email_addresses",
      "attributes": {
        "created_at": "2021-11-23T14:37:57Z",
        "email": "[e-mail]",
        "historic": false,
        "location": "home",
        "primary": true,
        "source": "MPDX",
        "updated_at": "2021-11-23T14:37:57Z",
        "updated_in_db_at": "2021-11-23T14:37:57Z",
        "valid_values": true
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Email Address]

Description An array of Email Addresses

Email Address [POST]

Email Address [POST]

Request

Endpoint

POST /api/v2/contacts/43d337af-e18e-4008-a4a1-001b530588de/people/fd941b16-a81d-46b3-8b2e-81d79b6900db/email_addresses
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "email_addresses",
    "attributes": {
      "email": "[e-mail]",
      "historic": false,
      "location": "home",
      "primary": false,
      "updated_in_db_at": "2021-11-23 14:37:56 UTC"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

email

Type string

Description The actual email address that this Email Address resource represents

Required No

historic

Type boolean

Description This should be true when an Email Address should no longer be used

Required No

location

Type string

Description Essentially a label for the Email Address, such as 'home', 'mobile', 'office'

Required No

primary

Type boolean

Description Whether or not the email is the owner's primary email address. Ultimately there should only be one of these.

Required No

source

Type string

Description The source of the email address

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

valid_values

Type boolean

Description This boolean indicates whether the email address is accurate or not

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

Body

{
  "data": {
    "id": "353e1be4-d134-49c7-a55a-58307e62b438",
    "type": "email_addresses",
    "attributes": {
      "created_at": "2021-11-23T14:37:56Z",
      "email": "[e-mail]",
      "historic": false,
      "location": "home",
      "primary": false,
      "source": "MPDX",
      "updated_at": "2021-11-23T14:37:56Z",
      "updated_in_db_at": "2021-11-23T14:37:56Z",
      "valid_values": true
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

email

Type string

Description The actual email address that this Email Address resource represents

historic

Type boolean

Description This should be true when an Email Address should no longer be used

location

Type string

Description Essentially a label for the Email Address, such as 'home', 'mobile', 'office'

primary

Type boolean

Description Whether or not the email is the owner's primary email address. Ultimately there should only be one of these.

source

Type string

Description The source of the email address

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

valid_values

Type boolean

Description This boolean indicates whether the email address is accurate or not

Email Address [GET]

Email Address [GET]

Request

Endpoint

GET /api/v2/contacts/8b8ccc88-291d-4000-9057-61563d4498b4/people/9b5969c1-4756-4fd6-9255-a31045cb0272/email_addresses/4406481e-1146-4573-8398-f89dc9f078be
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "4406481e-1146-4573-8398-f89dc9f078be",
    "type": "email_addresses",
    "attributes": {
      "created_at": "2021-11-23T14:37:56Z",
      "email": "[e-mail]",
      "historic": false,
      "location": "home",
      "primary": true,
      "source": "MPDX",
      "updated_at": "2021-11-23T14:37:56Z",
      "updated_in_db_at": "2021-11-23T14:37:56Z",
      "valid_values": true
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

email

Type string

Description The actual email address that this Email Address resource represents

historic

Type boolean

Description This should be true when an Email Address should no longer be used

location

Type string

Description Essentially a label for the Email Address, such as 'home', 'mobile', 'office'

primary

Type boolean

Description Whether or not the email is the owner's primary email address. Ultimately there should only be one of these.

source

Type string

Description The source of the email address

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

valid_values

Type boolean

Description This boolean indicates whether the email address is accurate or not

Email Address [PUT]

Email Address [PUT]

Request

Endpoint

PUT /api/v2/contacts/95011b4c-5f29-47b5-9f5b-13a16b599536/people/fd0b7375-290c-454d-a26b-76f1fbc0bab4/email_addresses/5b7b01b4-d383-4574-90cd-bab5c95603d2
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "email_addresses",
    "attributes": {
      "email": "[e-mail]",
      "historic": false,
      "location": "home",
      "primary": false,
      "updated_in_db_at": "2021-11-23 14:37:57 UTC"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

email

Type string

Description The actual email address that this Email Address resource represents

Required No

historic

Type boolean

Description This should be true when an Email Address should no longer be used

Required No

location

Type string

Description Essentially a label for the Email Address, such as 'home', 'mobile', 'office'

Required No

overwrite

Type boolean

Description Only used for updating a record where you want to ignore the server's ' 'updated_in_db_at value and force overwrite the values for the record. ' 'Must be true to work.

Required No

primary

Type boolean

Description Whether or not the email is the owner's primary email address. Ultimately there should only be one of these.

Required No

source

Type string

Description The source of the email address

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

valid_values

Type boolean

Description This boolean indicates whether the email address is accurate or not

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "5b7b01b4-d383-4574-90cd-bab5c95603d2",
    "type": "email_addresses",
    "attributes": {
      "created_at": "2021-11-23T14:37:57Z",
      "email": "[e-mail]",
      "historic": false,
      "location": "home",
      "primary": false,
      "source": "MPDX",
      "updated_at": "2021-11-23T14:37:57Z",
      "updated_in_db_at": "2021-11-23T14:37:57Z",
      "valid_values": true
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

email

Type string

Description The actual email address that this Email Address resource represents

historic

Type boolean

Description This should be true when an Email Address should no longer be used

location

Type string

Description Essentially a label for the Email Address, such as 'home', 'mobile', 'office'

primary

Type boolean

Description Whether or not the email is the owner's primary email address. Ultimately there should only be one of these.

source

Type string

Description The source of the email address

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

valid_values

Type boolean

Description This boolean indicates whether the email address is accurate or not

Email Address [DELETE]

Email Address [DELETE]

Request

Endpoint

DELETE /api/v2/contacts/6ae31df6-b7d2-4f6d-8121-f6945885c8ae/people/914a5d59-fad0-4988-b6b7-2a767655e8a4/email_addresses/b8e0f920-543c-43d4-b744-8afcd6ac727a
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body