/peopleRelationships/:id

put

https://api.followupboss.com/v1/peopleRelationships/{id}

Update details of a specific relationship.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
Update Access
To update a relationship, you must have access to the parent person.
The personId of an existing relationship cannot be altered after it is created.

❗️
Updating Email Addresses, Phones, and Addresses
Sending an array of email address, phone, or address objects will overwrite the values that are already present for a relationship. (e.g., If there are two emails listed and you send one new email address, the two emails are removed and just the new one is saved.)
If you want to maintain existing email address, phone, and/or address objects while adding new ones, you must resend the current list and add any new ones to that array.
(If these arrays are left blank, no changes are made.)

Path Params

int32

required

The ID of a given relationship.

Body Params

firstName

string

The first/given name of the relationship.

lastName

string

The last/family name of the relationship.

type

string

The type of relationship. (e.g., Spouse, Brother, Partner , etc.)

emails

array of objects

A list of email addresses associated with the relationship. (Specify type and value, isPrimary is not expected. The first email in the list will be the primary email address for the relationship.)

emails

phones

array of objects

A list of phone numbers associated with the relationship. (Specify type and value, isPrimary is not expected. The first phone in the list will be the primary phone number for the relationship.)

phones

addresses

array of objects

A list of addresses associated with the relationship. (This is the address where this person can be contacted, it is not the address of a property this person may be interested in selling or buying).

addresses

Responses

Update Access

Updating Email Addresses, Phones, and Addresses

200200

400400