Addresses

Addresses Documentation

Address [LIST]

Address [LIST]

Request

Endpoint

GET /api/v2/contacts/d13891f3-b6d2-444c-ad38-5bf0c370d38d/addresses
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": [
    {
      "id": "589f975b-5fa9-4db9-b6f5-716f06ed1189",
      "type": "addresses",
      "attributes": {
        "city": "Fremont",
        "country": "United States",
        "created_at": "2021-11-23T14:37:29Z",
        "end_date": "2012-02-19",
        "geo": "0,0",
        "historic": false,
        "location": "Home",
        "metro_area": null,
        "postal_code": "94539",
        "primary_mailing_address": false,
        "region": null,
        "remote_id": null,
        "seasonal": false,
        "source": "MPDX",
        "start_date": "2012-02-19",
        "state": "CA",
        "street": "123 Somewhere St",
        "updated_at": "2021-11-23T14:37:29Z",
        "updated_in_db_at": "2021-11-23T14:37:29Z",
        "valid_values": true
      },
      "relationships": {
        "source_donor_account": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [address]

Description An array of addresses

Address [POST]

Address [POST]

Request

Endpoint

POST /api/v2/contacts/f9cfabfe-9135-4514-bd39-2d8947babd5d/addresses
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "addresses",
    "attributes": {
      "city": "Fremont",
      "country": "United States",
      "end_date": "2012-02-19",
      "location": "Home",
      "postal_code": "94539",
      "primary_mailing_address": false,
      "start_date": "2012-02-19",
      "state": "CA",
      "street": "123 Somewhere St",
      "updated_in_db_at": "2021-11-23 14:37:28 UTC",
      "valid_values": false
    }
  }
}

Parameters

Attributes

city

Type string

Description The city of the address

Required No

country

Type string

Description The country of the address

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

end_date

Type string

Description The end date of this address

Required No

geo

Type string

Description Longitude and Latitude

Required No

historic

Type boolean

Description If address is no longer in use

Required No

location

Type string

Description The location of the address

Required No

metro_area

Type string

Description The metro area for the address

Required No

postal_code

Type string

Description The postal code for the address

Required No

primary_mailing_address

Type string

Description The primary address for the address

Required No

region

Type string

Description The region for the address

Required No

remote_id

Type string

Description The remote ID in the remote system the address came from

Required No

seasonal

Type string

Description Does the contact only use this address seasonally

Required No

source

Type string

Description The remote source system

Required No

start_date

Type string

Description The date the contact started to reside at the address

Required No

state

Type string

Description The state for the address

Required No

street

Type string

Description The street for the 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 Does the address validate against remove validation services

Required No

Relationships

source_donor_account.data

Type Donor Account

Description The donor account which this address was originally synced from

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "eb377f4c-d587-439b-99c1-8b36dc281ea3",
    "type": "addresses",
    "attributes": {
      "city": "Fremont",
      "country": "United States",
      "created_at": "2021-11-23T14:37:28Z",
      "end_date": "2012-02-19",
      "geo": "0,0",
      "historic": false,
      "location": "Home",
      "metro_area": null,
      "postal_code": "94539",
      "primary_mailing_address": false,
      "region": null,
      "remote_id": null,
      "seasonal": false,
      "source": "MPDX",
      "start_date": "2012-02-19",
      "state": "CA",
      "street": "123 Somewhere St",
      "updated_at": "2021-11-23T14:37:28Z",
      "updated_in_db_at": "2021-11-23T14:37:28Z",
      "valid_values": true
    },
    "relationships": {
      "source_donor_account": {
        "data": null
      }
    }
  }
}

Fields

Attributes

city

Type string

Description The city of the address

country

Type string

Description The country of the address

created_at

Type date

Description The timestamp of when this resource was created

end_date

Type string

Description The end date of this address

geo

Type string

Description Longitude and Latitude

historic

Type boolean

Description If address is no longer in use

location

Type string

Description The location of the address

metro_area

Type string

Description The metro area for the address

postal_code

Type string

Description The postal code for the address

primary_mailing_address

Type string

Description The primary address for the address

region

Type string

Description The region for the address

remote_id

Type string

Description The remote ID in the remote system the address came from

seasonal

Type string

Description Does the contact only use this address seasonally

source

Type string

Description The remote source system

start_date

Type string

Description The date the contact started to reside at the address

state

Type string

Description The state for the address

street

Type string

Description The street for the 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 Does the address validate against remove validation services

Relationships

source_donor_account.data

Type Donor Account

Description The donor account which this address was originally synced from

Address [GET]

Address [GET]

Request

Endpoint

GET /api/v2/contacts/d674e134-d62e-4adf-8c4f-4302a8db05f6/addresses/9daec491-647b-4f16-82dd-b58e0facb92c
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "9daec491-647b-4f16-82dd-b58e0facb92c",
    "type": "addresses",
    "attributes": {
      "city": "Fremont",
      "country": "United States",
      "created_at": "2021-11-23T14:37:29Z",
      "end_date": "2012-02-19",
      "geo": "0,0",
      "historic": false,
      "location": "Home",
      "metro_area": null,
      "postal_code": "94539",
      "primary_mailing_address": false,
      "region": null,
      "remote_id": null,
      "seasonal": false,
      "source": "MPDX",
      "start_date": "2012-02-19",
      "state": "CA",
      "street": "123 Somewhere St",
      "updated_at": "2021-11-23T14:37:29Z",
      "updated_in_db_at": "2021-11-23T14:37:29Z",
      "valid_values": true
    },
    "relationships": {
      "source_donor_account": {
        "data": null
      }
    }
  }
}

Fields

Attributes

city

Type string

Description The city of the address

country

Type string

Description The country of the address

created_at

Type date

Description The timestamp of when this resource was created

end_date

Type string

Description The end date of this address

geo

Type string

Description Longitude and Latitude

historic

Type boolean

Description If address is no longer in use

location

Type string

Description The location of the address

metro_area

Type string

Description The metro area for the address

postal_code

Type string

Description The postal code for the address

primary_mailing_address

Type string

Description The primary address for the address

region

Type string

Description The region for the address

remote_id

Type string

Description The remote ID in the remote system the address came from

seasonal

Type string

Description Does the contact only use this address seasonally

source

Type string

Description The remote source system

start_date

Type string

Description The date the contact started to reside at the address

state

Type string

Description The state for the address

street

Type string

Description The street for the 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 Does the address validate against remove validation services

Relationships

source_donor_account.data

Type Donor Account

Description The donor account which this address was originally synced from

Address [PUT]

Address [PUT]

Request

Endpoint

PUT /api/v2/contacts/500a867e-7438-4673-a005-0743e7adfd4e/addresses/07e1ef9e-e9f5-467d-81a6-59958fe0f21f
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "addresses",
    "attributes": {
      "city": "Fremont",
      "country": "United States",
      "end_date": "2012-02-19",
      "location": "Home",
      "postal_code": "94539",
      "primary_mailing_address": false,
      "start_date": "2012-02-19",
      "state": "CA",
      "street": "123 Somewhere St",
      "updated_in_db_at": "2021-11-23 14:37:28 UTC",
      "valid_values": false
    }
  }
}

Parameters

Attributes

city

Type string

Description The city of the address

Required No

country

Type string

Description The country of the address

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

end_date

Type string

Description The end date of this address

Required No

geo

Type string

Description Longitude and Latitude

Required No

historic

Type boolean

Description If address is no longer in use

Required No

location

Type string

Description The location of the address

Required No

metro_area

Type string

Description The metro area for the address

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

postal_code

Type string

Description The postal code for the address

Required No

primary_mailing_address

Type string

Description The primary address for the address

Required No

region

Type string

Description The region for the address

Required No

remote_id

Type string

Description The remote ID in the remote system the address came from

Required No

seasonal

Type string

Description Does the contact only use this address seasonally

Required No

source

Type string

Description The remote source system

Required No

start_date

Type string

Description The date the contact started to reside at the address

Required No

state

Type string

Description The state for the address

Required No

street

Type string

Description The street for the 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 Does the address validate against remove validation services

Required No

Relationships

source_donor_account.data

Type Donor Account

Description The donor account which this address was originally synced from

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "07e1ef9e-e9f5-467d-81a6-59958fe0f21f",
    "type": "addresses",
    "attributes": {
      "city": "Fremont",
      "country": "United States",
      "created_at": "2021-11-23T14:37:28Z",
      "end_date": "2012-02-19",
      "geo": "0,0",
      "historic": false,
      "location": "Home",
      "metro_area": null,
      "postal_code": "94539",
      "primary_mailing_address": false,
      "region": null,
      "remote_id": null,
      "seasonal": false,
      "source": "MPDX",
      "start_date": "2012-02-19",
      "state": "CA",
      "street": "123 Somewhere St",
      "updated_at": "2021-11-23T14:37:28Z",
      "updated_in_db_at": "2021-11-23T14:37:28Z",
      "valid_values": false
    },
    "relationships": {
      "source_donor_account": {
        "data": null
      }
    }
  }
}

Fields

Attributes

city

Type string

Description The city of the address

country

Type string

Description The country of the address

created_at

Type date

Description The timestamp of when this resource was created

end_date

Type string

Description The end date of this address

geo

Type string

Description Longitude and Latitude

historic

Type boolean

Description If address is no longer in use

location

Type string

Description The location of the address

metro_area

Type string

Description The metro area for the address

postal_code

Type string

Description The postal code for the address

primary_mailing_address

Type string

Description The primary address for the address

region

Type string

Description The region for the address

remote_id

Type string

Description The remote ID in the remote system the address came from

seasonal

Type string

Description Does the contact only use this address seasonally

source

Type string

Description The remote source system

start_date

Type string

Description The date the contact started to reside at the address

state

Type string

Description The state for the address

street

Type string

Description The street for the 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 Does the address validate against remove validation services

Relationships

source_donor_account.data

Type Donor Account

Description The donor account which this address was originally synced from

Address [DELETE]

Address [DELETE]

Request

Endpoint

DELETE /api/v2/contacts/274d4e51-d911-4f14-b37a-f445dbd2ba5b/addresses/95e4761e-8e32-4367-aedb-d8ae955977f8
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body