API Reference
API Reference
Guides
Start typing to search…

/people/:id

put https://api.followupboss.com/v1/people/

Update a person by id.

Log in to see full request history

❗️

Tag updates will overwrite all existing tags

Please note that when using the tags property, all existing tags for a person will be overwritten to use the new list of tags provided.

To merge new tags with the contact's existing tag list, set the mergeTags query parameter in the request URL to true.

❗️

Phone number updates will overwrite existing phone numbers

The phones argument will overwrite all existing phone numbers, including those associated with relationships.

For example, if a contact has phone numbers of 123-456-7890 and 123-456-7891 and you want to edit the second one to 123-456-7892, you'll need to send the first one along with the updated second number. Similarly, if you wanted to add a number you need to send that with the existing set of phone numbers.

🚧

Altering email addresses and phone numbers of relationships

Email addresses and phone numbers associated to relationships can be edited and deleted through /v1/people , however you cannot alter the relationshipId of a given email address or phone number through /v1/people. This must be done through /v1/peopleRelationships.

🚧

Changing the contacted field

Changing the contacted field to true will pause action plans.

📘

Custom Fields

If the account has custom fields defined you can also set these when updating a person. You can use the customFields endpoint to see which custom fields are available in the current account.

To delete a custom field value on a person, set its value to null. (e.g., customBirthday: null)

Path Params
int32
required

ID of the person.

Query Params
boolean
Defaults to false

If set to true, this will merge the tags sent in the tags argument with the current list of tags. By default, it overwrites the existing tags.

Body Params
string

The first/given name of the person.

string

The last/family name of the person.

string
Defaults to Lead

The stage the person is in. (e.g., "Lead" or "Trash". See stage API endpoint for more options.)

boolean

Whether the person has been contacted. (Note: Changing the contacted field to true will pause action plans.)

int32

The price of the property of the person's first inquiry, or the estimated sell/buy price for this person.

string

Full name of the agent assigned to this person.

int32

ID of the agent assigned to this person.

int32

ID of the pond assigned to this person.

string

Full name of the lender assigned to this person.

int32

ID of the lender assigned to this person.

emails
array of objects

A list of email addresses associated with the person.

emails
phones
array of objects

A list of phone numbers associated with the person.

phones
addresses
array of objects

A list of addresses associated with the person. (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
tags
array of strings

A list of tags applied to the person. This list will overwrite any existing tags for the person. (To merge the tags passed with any existing tags,set the mergeTags query parameter in your request to true.)

tags
string

Background information on the person. (Can be a multi-line string.)

string

You can include any of your Custom Fields in the request, these must be prefixed with "custom". For example, if you have a Closing Date custom field, the JSON key for that field will be customClosingDate. See Custom Fields for more about Custom Fields.

int32

ID of the timeframe to move (Refer to the /timeframes endpoint for valid values of timeframeId.)

Responses

Updated 5 months ago

Language
Credentials
:
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago