Websites
Websites Documentation
Website [LIST]
Website [LIST]
Request
Endpoint
GET /api/v2/contacts/87e03312-7df2-44f3-ad58-d6594cad3db4/people/bc76e94c-04b0-4593-bdd1-f2220599894d/websites
Content-Type: application/vnd.api+json
Body
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
Body
{
"data": [
{
"id": "bbcc3414-eb7a-483c-b4df-6cb672a00475",
"type": "websites",
"attributes": {
"created_at": "2022-01-12T17:18:39Z",
"primary": true,
"updated_at": "2022-01-12T17:18:39Z",
"updated_in_db_at": "2022-01-12T17:18:39Z",
"url": "http://barton.org/ivette_davis"
}
}
],
"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/a1286317-52de-4aa0-be15-0245ee5b37ee/people/e3277d48-2124-4b1c-93b4-da7b202ae8f7/websites
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "websites",
"attributes": {
"updated_in_db_at": "2022-01-12 17:18:40 UTC",
"url": "http://stanton-klocko.net/barrie.boyle"
}
}
}
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": "fce9d784-8424-4652-93bf-5d092ce1bb9a",
"type": "websites",
"attributes": {
"created_at": "2022-01-12T17:18:40Z",
"primary": false,
"updated_at": "2022-01-12T17:18:40Z",
"updated_in_db_at": "2022-01-12T17:18:40Z",
"url": "http://stanton-klocko.net/barrie.boyle"
}
}
}
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/c8ee5c6b-9040-435d-9215-287287ef7354/people/773444ab-687e-46e0-aac0-35b28e95648b/websites/3dacb815-02a0-4878-9bf5-5a30fb2aa490
Content-Type: application/vnd.api+json
Body
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
Body
{
"data": {
"id": "3dacb815-02a0-4878-9bf5-5a30fb2aa490",
"type": "websites",
"attributes": {
"created_at": "2022-01-12T17:18:40Z",
"primary": true,
"updated_at": "2022-01-12T17:18:40Z",
"updated_in_db_at": "2022-01-12T17:18:40Z",
"url": "http://marvin-bahringer.info/an"
}
}
}
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/ea3418e1-470a-487e-9c6e-fad7a4f8e52a/people/22476981-d3cc-4703-83c2-dceebd2e16bf/websites/75eee125-f5a8-453e-969b-4fa996213194
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "websites",
"attributes": {
"updated_in_db_at": "2022-01-12 17:18:39 UTC",
"url": "http://haley.org/daniel.flatley"
}
}
}
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": "75eee125-f5a8-453e-969b-4fa996213194",
"type": "websites",
"attributes": {
"created_at": "2022-01-12T17:18:39Z",
"primary": true,
"updated_at": "2022-01-12T17:18:39Z",
"updated_in_db_at": "2022-01-12T17:18:39Z",
"url": "http://haley.org/daniel.flatley"
}
}
}
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/9a1d2315-d719-4dd9-9513-5f57ebf5ceee/people/d8241dd7-6fc6-44fd-9d56-998d67d993f3/websites/d30aa97b-eb19-4328-868e-4feedb50f42a
Content-Type: application/vnd.api+json
Body
Response
Headers
204 No Content
Body
Last updated