Relationships
Relationships Documentation
Relationship [LIST]
Relationship [LIST]
Request
Endpoint
GET /api/v2/contacts/3be593ad-f95a-4cfb-8e27-b98c2e711a8d/people/c21911c1-ca41-4888-ae0c-625231c692c5/relationships
Content-Type: application/vnd.api+json
Body
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
Body
{
"data": [
{
"id": "950fc19a-a283-4620-876f-1de83179fc61",
"type": "family_relationships",
"attributes": {
"created_at": "2021-11-23T14:37:39Z",
"relationship": "MyString",
"updated_at": "2021-11-23T14:37:39Z",
"updated_in_db_at": "2021-11-23T14:37:39Z"
},
"relationships": {
"related_person": {
"data": {
"id": "cde917a7-5fbd-43a7-9bc9-9a330cc97f45",
"type": "people"
}
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
data
Type
[Family Relationship]
Description An array of Family Relationships
Relationship [POST]
Relationship [POST]
Request
Endpoint
POST /api/v2/contacts/fd0a17ef-724d-4477-913c-a1ef4afc4de3/people/1b322f4d-6ac3-4d37-91ce-c8f254dc5f92/relationships
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "family_relationships",
"attributes": {
"relationship": "MyString",
"updated_in_db_at": "2021-11-23 14:37:39 UTC"
},
"relationships": {
"related_person": {
"data": {
"type": "people",
"id": "f142f5b3-9a7f-4bbc-988c-0f4cc6abade5"
}
}
}
}
}
Parameters
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
Required No
relationship
Type
string
Description The description of how these two people are related
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
Relationships
related_person.data
Type
Person
Description The person this person is related to
Required No
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
Body
{
"data": {
"id": "409de7f9-32e7-436c-abff-6b79cf596caa",
"type": "family_relationships",
"attributes": {
"created_at": "2021-11-23T14:37:39Z",
"relationship": "MyString",
"updated_at": "2021-11-23T14:37:39Z",
"updated_in_db_at": "2021-11-23T14:37:39Z"
},
"relationships": {
"related_person": {
"data": {
"id": "f142f5b3-9a7f-4bbc-988c-0f4cc6abade5",
"type": "people"
}
}
}
}
}
Fields
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
relationship
Type
string
Description The description of how these two people are related
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.
Relationships
related_person.data
Type
Person
Description The person this person is related to
Relationship [GET]
Relationship [GET]
Request
Endpoint
GET /api/v2/contacts/8286fee8-9cae-4410-a1c1-d0c6c56fdf81/people/bfb15313-9683-4a08-9f92-4ae0cf3846ee/relationships/d8e9f055-9fcb-4ad9-8229-441e6359dc12
Content-Type: application/vnd.api+json
Body
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
Body
{
"data": {
"id": "d8e9f055-9fcb-4ad9-8229-441e6359dc12",
"type": "family_relationships",
"attributes": {
"created_at": "2021-11-23T14:37:39Z",
"relationship": "MyString",
"updated_at": "2021-11-23T14:37:39Z",
"updated_in_db_at": "2021-11-23T14:37:39Z"
},
"relationships": {
"related_person": {
"data": {
"id": "633d5787-f71e-420e-bdf9-99da83a8fd07",
"type": "people"
}
}
}
}
}
Fields
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
relationship
Type
string
Description The description of how these two people are related
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.
Relationships
related_person.data
Type
Person
Description The person this person is related to
Relationship [PUT]
Relationship [PUT]
Request
Endpoint
PUT /api/v2/contacts/d616301d-91b2-464c-b99a-799a0dbe05ca/people/8a0a53d3-6e7e-453e-92f7-7663ee66dad6/relationships/0db17b56-8792-4743-8e17-ce350ee1a760
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "family_relationships",
"attributes": {
"relationship": "MyString",
"updated_in_db_at": "2021-11-23 14:37:40 UTC"
},
"relationships": {
"related_person": {
"data": {
"type": "people",
"id": "6536fc4c-78ff-42f7-99e0-8bfcd4ee9910"
}
}
}
}
}
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
relationship
Type
string
Description The description of how these two people are related
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
Relationships
related_person.data
Type
Person
Description The person this person is related to
Required No
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
Body
{
"data": {
"id": "0db17b56-8792-4743-8e17-ce350ee1a760",
"type": "family_relationships",
"attributes": {
"created_at": "2021-11-23T14:37:40Z",
"relationship": "MyString",
"updated_at": "2021-11-23T14:37:40Z",
"updated_in_db_at": "2021-11-23T14:37:40Z"
},
"relationships": {
"related_person": {
"data": {
"id": "6536fc4c-78ff-42f7-99e0-8bfcd4ee9910",
"type": "people"
}
}
}
}
}
Fields
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
relationship
Type
string
Description The description of how these two people are related
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.
Relationships
related_person.data
Type
Person
Description The person this person is related to
Relationship [DELETE]
Relationship [DELETE]
Request
Endpoint
DELETE /api/v2/contacts/d10e6150-93ac-43a3-8898-831133639b28/people/fe780b50-0931-48c9-9506-18afd083d33b/relationships/8dda14b1-3f5e-44de-a16d-86fd5a789993
Content-Type: application/vnd.api+json
Body
Response
Headers
204 No Content
Body
Last updated