Websites

Websites Documentation

Website [LIST]

Website [LIST]

Request

Endpoint

GET /api/v2/contacts/3be7a927-bb3a-4c11-b860-7b160d53080c/people/fb3656e0-2799-4d8e-aeff-5cb81a09a463/websites
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": [
    {
      "id": "baeeeb15-c5dc-42fd-adff-e76ef2291273",
      "type": "websites",
      "attributes": {
        "created_at": "2021-11-23T14:37:43Z",
        "primary": true,
        "updated_at": "2021-11-23T14:37:43Z",
        "updated_in_db_at": "2021-11-23T14:37:43Z",
        "url": "http://hartmann.info/clement"
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Website]

Description An array of Websites

Website [POST]

Website [POST]

Request

Endpoint

POST /api/v2/contacts/67305801-a76a-4d7b-9655-4b09296a388f/people/1a7f0bf2-4016-40db-9e37-f5c5e0c683f5/websites
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "websites",
    "attributes": {
      "updated_in_db_at": "2021-11-23 14:37:43 UTC",
      "url": "http://ward-pagac.co/ali.fahey"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

primary

Type boolean

Description If the website is primary or not; Accepts "true" or "false"

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

url

Type string

Description The url of the website

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "0bf705bd-532f-439b-bacb-4c4376847312",
    "type": "websites",
    "attributes": {
      "created_at": "2021-11-23T14:37:43Z",
      "primary": false,
      "updated_at": "2021-11-23T14:37:43Z",
      "updated_in_db_at": "2021-11-23T14:37:43Z",
      "url": "http://ward-pagac.co/ali.fahey"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

primary

Type boolean

Description If the website is primary or not; Accepts "true" or "false"

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.

url

Type string

Description The url of the website

Website [GET]

Website [GET]

Request

Endpoint

GET /api/v2/contacts/4f548fff-1cf4-4715-a62b-b21da7076ee1/people/cb001217-7bbd-48c3-bec4-1b89b1d4d29c/websites/9a0cb99f-a8e3-4594-afe2-86e6f360ae8b
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "9a0cb99f-a8e3-4594-afe2-86e6f360ae8b",
    "type": "websites",
    "attributes": {
      "created_at": "2021-11-23T14:37:43Z",
      "primary": true,
      "updated_at": "2021-11-23T14:37:43Z",
      "updated_in_db_at": "2021-11-23T14:37:43Z",
      "url": "http://wehner.org/son_thiel"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

primary

Type boolean

Description If the website is primary or not; Accepts "true" or "false"

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.

url

Type string

Description The url of the website

Website [PUT]

Website [PUT]

Request

Endpoint

PUT /api/v2/contacts/3fa36c27-1238-4337-9a02-e3952680e153/people/6204900f-c65d-4c77-95c1-dbebdf21787c/websites/79381416-9841-4ddf-ac92-f2fa1780373a
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "websites",
    "attributes": {
      "updated_in_db_at": "2021-11-23 14:37:42 UTC",
      "url": "http://beier.com/carline_goldner"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

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 If the website is primary or not; Accepts "true" or "false"

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

url

Type string

Description The url of the website

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "79381416-9841-4ddf-ac92-f2fa1780373a",
    "type": "websites",
    "attributes": {
      "created_at": "2021-11-23T14:37:42Z",
      "primary": true,
      "updated_at": "2021-11-23T14:37:42Z",
      "updated_in_db_at": "2021-11-23T14:37:42Z",
      "url": "http://beier.com/carline_goldner"
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

primary

Type boolean

Description If the website is primary or not; Accepts "true" or "false"

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.

url

Type string

Description The url of the website

Website [DELETE]

Website [DELETE]

Request

Endpoint

DELETE /api/v2/contacts/8793332e-7857-4803-8d83-27e749d487a4/people/6c199cd0-e098-467e-b2c0-cdf623d8ccdd/websites/9f71acd4-7d69-4c02-8a17-53a198ee9daa
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body