{"openapi":"3.1.0","info":{"title":"API Settings","version":"1.0"},"servers":[{"url":"https://api.followupboss.com/v1"}],"components":{"securitySchemes":{"sec0":{"type":"http","scheme":"basic"}}},"security":[{"sec0":[]}],"paths":{"/events":{"post":{"summary":"/events","description":"Send in a lead or an event related to a lead.","operationId":"events-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"source":{"type":"string","description":"The name of the lead source."},"system":{"type":"string","description":"The name of the system used in providing leads."},"type":{"type":"string","description":"The type of event. Currently one of `Registration`, `Inquiry`, `Seller Inquiry`, `Property Inquiry`, `General Inquiry`, `Viewed Property`, `Saved Property`, `Visited Website`, `Incoming Call`, `Unsubscribed`, `Property Search`, `Saved Property Search`, `Visited Open House` or `Viewed Page`."},"message":{"type":"string","description":"A message from the user about this inquiry."},"description":{"type":"string","description":"Any additional information about this inquiry."},"person":{"properties":{"id":{"type":"integer","description":"The ID of the person the event corresponds to (optional).","format":"int32"},"firstName":{"type":"string","description":"The first/given name of the person."},"lastName":{"type":"string","description":"The last/family name of the person."},"stage":{"type":"string","description":"The stage of the person. (e.g., `Lead` or `Trash` See stages API endpoint for more options.)"},"source":{"type":"string","description":"The source of the lead."},"sourceUrl":{"type":"string","description":"This is a direct link to the information about a person at the lead provider."},"contacted":{"type":"boolean","description":"Sets whether the person has been contacted or not.","default":false},"price":{"type":"integer","description":"The estimated sell/buy price for this person.","format":"int32"},"assignedTo":{"type":"string","description":"Full name of the agent to assign to this person."},"assignedLenderName":{"type":"string","description":"Full name of the lender to assign to this person."},"assignedUserId":{"type":"integer","description":"ID of the agent assigned to this person.","format":"int32"},"assignedLenderId":{"type":"integer","description":"ID of the lender assigned to this person.","format":"int32"},"emails":{"type":"array","description":"A list of email addresses associated with this person.","items":{"properties":{"value":{"type":"string","description":"The email address."},"type":{"type":"string","description":"The type of email address. (e.g., \"work\", \"home\")"}},"type":"object"}},"phones":{"type":"array","description":"A list of phone numbers associated with the person.","items":{"properties":{"value":{"type":"string","description":"The phone number. (e.g., 888-555-1234)."},"type":{"type":"string","description":"Type of number. (e.g., \"mobile\", \"home\", \"fax\", etc.)"}},"type":"object"}},"addresses":{"type":"array","description":"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).","items":{"properties":{"type":{"type":"string","description":"The address type. (e.g., \"home\", \"work\", \"mailing\", \"investment\", etc.)","default":"home"},"street":{"type":"string","description":"Street address. (e.g., \"3595 South Higuera St., Suite B\")"},"city":{"type":"string","description":"City name."},"state":{"type":"string","description":"Abbreviated state code. (e.g., \"CA\", \"NY\", etc.)"},"code":{"type":"string","description":"Zipcode. (As a string, not a number.)"},"country":{"type":"string","description":"Country name. (e.g., \"United States\", \"Japan\", etc.)"}},"type":"object"}},"tags":{"type":"array","description":"A list of tags applied to the person.","items":{"type":"string"}},"custom*":{"type":"string","description":"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](ref:customfields-get) for more about Custom Fields."}},"required":[],"type":"object","description":"Information about the lead who triggered this event. Follow Up Boss will automatically de-duplicate people based on their phone number or email address."},"property":{"properties":{"street":{"type":"string","description":"Street address. (e.g., \"3595 South Higuera St, Suite B\")"},"city":{"type":"string","description":"City name."},"state":{"type":"string","description":"Abbreviated state code. (e.g., \"CA\", \"NY\", etc.)"},"code":{"type":"string","description":"Zipcode. (Only as a string, not a number. e.g., \"90210\")"},"mlsNumber":{"type":"string","description":"MLS Number for the property."},"price":{"type":"integer","description":"The asking price or price estimate for the property.","format":"int32"},"forRent":{"type":"boolean","description":"Sets whether this property is for rent or not."},"url":{"type":"string","description":"A URL for the property provided by the lead source."},"type":{"type":"string","description":"A freeform description of property type. (e.g., \"Bungalow\" or \"Apartment\")"},"bedrooms":{"type":"string","description":"The number of bedrooms."},"bathrooms":{"type":"string","description":"The number of bathrooms."},"area":{"type":"string","description":"Area of the property in square feet."},"lot":{"type":"string","description":"Area of the lot/land in acres."}},"required":[],"type":"object","description":"Information about the property this event is related to."},"propertySearch":{"properties":{"type":{"type":"string","description":"The type of property the person was searching for. (e.g., \"Residential\", \"Lot\", \"Apartment\", etc.)"},"neighborhood":{"type":"string","description":"The neighborhood or area in which a person is searching for a property."},"city":{"type":"string","description":"The city in which a person was searching."},"state":{"type":"string","description":"The state in which a person was searching."},"code":{"type":"array","description":"The zipcode(s) in which a person was searching. (This can also be sent in as just a string for one zip code.)","items":{"type":"string"}},"minPrice":{"type":"integer","description":"The minimum price in which a person was searching.","format":"int32"},"maxPrice":{"type":"integer","description":"The maximum price in which a person was searching.","format":"int32"},"minBedrooms":{"type":"integer","description":"The minimum number of bedrooms that a person was searching for.","format":"int32"},"maxBedrooms":{"type":"integer","description":"The maximum number of bedrooms that a person was searching for.","format":"int32"},"minBathrooms":{"type":"number","description":"The minimum number of bathrooms that a person was searching for.","format":"float"},"maxBathrooms":{"type":"number","description":"The maximum number of bathrooms that a person was searching for.","format":"float"}},"required":[],"type":"object","description":"If this event was an inquiry you may have information about what the person was searching for, you can submit this information using this field."},"campaign":{"type":"object","description":"The name of the source where the lead originated. (e.g., If the lead came to your site through an organic search on `www.google.com` the source is \"Google\".)","required":["source"],"properties":{"source":{"type":"string","description":"The source of the campaign."},"medium":{"type":"string","description":"The medium of the campaign. (e.g., For an organic search the medium is \"organic\".)"},"term":{"type":"string","description":"The search terms entered by the person."},"content":{"type":"string","description":"The content of the campaign."},"campaign":{"type":"string","description":"The name or identifier for this campaign."}}},"pageTitle":{"type":"string","description":"This field is to be used with the `Viewed Page` event type and indicates the title of the page viewed. (e.g., \"Contact Us\")"},"pageUrl":{"type":"string","description":"This field is to be used with the `Viewed Page` event type and indicates the url of the page viewed. (e.g., \"http://www.samplerealestate.com/contact-us\")"},"pageReferrer":{"type":"string","description":"This field is to be used with the `Viewed Page` event type and indicates the referrer url where the visitor came from. (e.g., \"https://www.google.com\") (Note: If `pageReferrer` is sent in, `pageUrl` should be set as well.)"},"pageDuration":{"type":"integer","description":"This field is to be used with the `Viewed Page` event type and indicates the duration of the visitor on the page viewed given in seconds.","format":"int32"},"occurredAt":{"type":"string","description":"The date this event occurred. This is used to determine if the event is historical. Historical events will not trigger workflows upon creation. Any DateTime greater than 1 day will be considered historical.","format":"date"}}},"examples":{"JSON Example 1":{"value":{"source":"Zillow","system":"Zillow","type":"Property Inquiry","message":"I am interested in 6825 Mulholland Dr, ...","description":"Move-in: 12/28/2013","person":{"id":1234,"firstName":"Melissa ","lastName":"Hartman","emails":[{"value":"m.hartman@example.com","type":"home"}],"phones":[{"value":"(555) 555-1234","type":"home"}],"tags":["Lease option"],"sourceUrl":"http://click.email.zillow.com/?qs=1e120cec11e3","customBirthday":"2/16/1990"},"property":{"street":"6825 Mulholland Dr","city":"Los Angeles","state":"CA","code":"90068","mlsNumber":"14729339","price":"310000","forRent":"0","url":"http://www.zillow.com/homedetails/6825-Mulholland-Dr-Los-Angeles-CA-90068/2109065822_zpid/","type":"Residential"},"propertySearch":{"type":"Lot","neighborhood":"Cahuenga Pass","city":"Los Angeles","state":"CA","code":"90068","minPrice":100000,"maxPrice":500000},"campaign":{"source":"google","medium":"organic","term":"Cahuenga Pass land","content":"","campaign":""}}},"Example 2":{"value":{"source":"MyAwesomeWebsite.com","system":"AwesomeSiteBuilder","type":"General Inquiry","message":"Looking for a house under $500k in the East Boston area","person":{"firstName":"John","lastName":"Smith","emails":[{"value":"john@gmail.com"}],"phones":[{"value":"555-555-5555"}]}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"201":{"description":"201","content":{"text/plain":{"examples":{"Result":{"value":""}}}}},"204":{"description":"204","content":{"text/plain":{"examples":{"Result":{"value":""}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"get":{"summary":"/events","description":"Search for events.","operationId":"events-get","parameters":[{"name":"limit","in":"query","description":"Number of results to return. (Max 100.)","schema":{"type":"integer","format":"int32","default":10}},{"name":"next","in":"query","description":"To get the next page of results, set this to the value returned in _metadata.next, or use the URL from _metadata.nextLink directly.","schema":{"type":"string"}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip, before starting to return results.  (For more efficient paging, please use the \"next\" parameter instead.)","schema":{"type":"integer","format":"int32","default":0}},{"name":"personId","in":"query","description":"Find all events related to a person.","schema":{"type":"integer","format":"int32"}},{"name":"type","in":"query","description":"Comma separated list of one or more of the following: \"Registration\", \"Inquiry\", \"Seller Inquiry\", \"Property Inquiry\", \"General Inquiry\", \"Viewed Property\", \"Saved Property\", \"Visited Website\", \"Incoming Call\", \"Unsubscribed\", \"Property Search\", \"Saved Property Search\", \"Visited Open House\" or \"Viewed Page\".","schema":{"type":"string"}},{"name":"hasProperty","in":"query","description":"Filters based on whether a property is associated with an event or not.","schema":{"type":"boolean"}},{"name":"propertyAddress","in":"query","description":"Searches property addresses for a given value, including partial matches.","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"events\",\n    \"offset\": 0,\n    \"limit\": 1,\n    \"total\": 1000,\n    \"next\": \"eyJzaW5jZUlkIjoxMjYzMn0\",\n    \"nextLink\": \"https://api.reclients.com/v1/events?updatedAfter=1980-01-01T00%3A00%3A00Z&next=eyJzaW5jZUlkIjoxMjYzMn0\"\n  },\n  \"events\": [\n    {\n      \"id\": 132,\n      \"created\": \"2014-05-05T19:38:27Z\",\n      \"updated\": \"2014-05-05T19:38:27Z\",\n      \"personId\": 12264,\n      \"message\": \"I am interested in 6825 Mulholland Dr, ...\",\n      \"description\": \"Move-in: 12/28/2013\",\n      \"noteId\": 32,\n      \"source\": \"Zillow\",\n      \"type\": \"Property Inquiry\",\n      \"property\": {\n        \"street\": \"6825 Mulholland Dr\",\n        \"city\": \"Los Angeles\",\n        \"state\": \"CA\",\n        \"code\": \"90068\",\n        \"mlsNumber\": \"14729339\",\n        \"price\": \"310000\",\n        \"forRent\": \"0\",\n        \"url\": \"http://www.zillow.com/homedetails/6825-Mulholland-Dr-Los-Angeles-CA-90068/2109065822_zpid/\",\n        \"type\": \"Residential\",\n        \"bedrooms\": \"0\",\n        \"bathrooms\": null,\n        \"area\": null,\n        \"lot\": null\n      },\n      \"propertySearch\": {\n        \"type\": \"Residential\",\n        \"neighborhood\": \"Hollywood\",\n        \"city\": \"Los Angeles\",\n        \"state\": \"CA\",\n        \"code\": \"90068\",\n        \"minPrice\": 300000,\n        \"maxPrice\": 500000,\n        \"minBedrooms\": 0,\n        \"maxBedrooms\": 2,\n        \"minBathrooms\": 1,\n        \"maxBathrooms\": 2,\n        \"minArea\": 100,\n        \"maxArea\": 1200,\n        \"forRent\": 0,\n        \"action\": \"ADD\",\n        \"maxHoaFee\": 0,\n        \"zillowSsid\": \"1234\",\n        \"keywordList\": [\"Downtown\"],\n        \"statusTypes\": [\n            \"pending\",\n            \"recently closed\"\n        ],\n        \"minYearBuilt\": 1930,\n        \"minParkingSpot\": 1\n      },\n      \"pageTitle\": null,\n      \"pageUrl\": null,\n      \"pageDuration\": 0\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"_metadata":{"type":"object","properties":{"collection":{"type":"string","example":"events"},"offset":{"type":"integer","example":0,"default":0},"limit":{"type":"integer","example":1,"default":0},"total":{"type":"integer","example":1000,"default":0},"next":{"type":"string","example":"eyJzaW5jZUlkIjoxMjYzMn0"},"nextLink":{"type":"string","example":"https://api.reclients.com/v1/events?updatedAfter=1980-01-01T00%3A00%3A00Z&next=eyJzaW5jZUlkIjoxMjYzMn0"}}},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":132,"default":0},"created":{"type":"string","example":"2014-05-05T19:38:27Z"},"updated":{"type":"string","example":"2014-05-05T19:38:27Z"},"personId":{"type":"integer","example":12264,"default":0},"message":{"type":"string","example":"I am interested in 6825 Mulholland Dr, ..."},"description":{"type":"string","example":"Move-in: 12/28/2013"},"noteId":{"type":"integer","example":32,"default":0},"source":{"type":"string","example":"Zillow"},"type":{"type":"string","example":"Property Inquiry"},"property":{"type":"object","properties":{"street":{"type":"string","example":"6825 Mulholland Dr"},"city":{"type":"string","example":"Los Angeles"},"state":{"type":"string","example":"CA"},"code":{"type":"string","example":"90068"},"mlsNumber":{"type":"string","example":"14729339"},"price":{"type":"string","example":"310000"},"forRent":{"type":"string","example":"0"},"url":{"type":"string","example":"http://www.zillow.com/homedetails/6825-Mulholland-Dr-Los-Angeles-CA-90068/2109065822_zpid/"},"type":{"type":"string","example":"Residential"},"bedrooms":{"type":"string","example":"0"},"bathrooms":{},"area":{},"lot":{}}},"propertySearch":{"type":"object","properties":{"type":{"type":"string","example":"Residential"},"neighborhood":{"type":"string","example":"Hollywood"},"city":{"type":"string","example":"Los Angeles"},"state":{"type":"string","example":"CA"},"code":{"type":"string","example":"90068"},"minPrice":{"type":"integer","example":300000,"default":0},"maxPrice":{"type":"integer","example":500000,"default":0},"minBedrooms":{"type":"integer","example":0,"default":0},"maxBedrooms":{"type":"integer","example":2,"default":0},"minBathrooms":{"type":"integer","example":1,"default":0},"maxBathrooms":{"type":"integer","example":2,"default":0},"minArea":{"type":"integer","example":100,"default":0},"maxArea":{"type":"integer","example":1200,"default":0},"forRent":{"type":"integer","example":0,"default":0},"action":{"type":"string","example":"ADD"},"maxHoaFee":{"type":"integer","example":0,"default":0},"zillowSsid":{"type":"string","example":"1234"},"keywordList":{"type":"array","items":{"type":"string","example":"Downtown"}},"statusTypes":{"type":"array","items":{"type":"string","example":"pending"}},"minYearBuilt":{"type":"integer","example":1930,"default":0},"minParkingSpot":{"type":"integer","example":1,"default":0}}},"pageTitle":{},"pageUrl":{},"pageDuration":{"type":"integer","example":0,"default":0}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/events/{id}":{"get":{"summary":"/events/:id","description":"Retrieve a single event by id.","operationId":"events-id-get","parameters":[{"name":"id","in":"path","description":"The id of the event.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 132,\n  \"created\": \"2014-05-05T19:38:27Z\",\n  \"updated\": \"2014-05-05T19:38:27Z\",\n  \"personId\": 12264,\n  \"message\": \"I am interested in 6825 Mulholland Dr, ...\",\n  \"description\": \"Move-in: 12/28/2013\",\n  \"noteId\": 32,\n  \"source\": \"Zillow\",\n  \"type\": \"Property Inquiry\",\n  \"property\": {\n    \"street\": \"6825 Mulholland Dr\",\n    \"city\": \"Los Angeles\",\n    \"state\": \"CA\",\n    \"code\": \"90068\",\n    \"mlsNumber\": \"14729339\",\n    \"price\": \"310000\",\n    \"forRent\": \"0\",\n    \"url\": \"http://www.zillow.com/homedetails/6825-Mulholland-Dr-Los-Angeles-CA-90068/2109065822_zpid/\",\n    \"type\": \"Residential\",\n    \"bedrooms\": \"0\",\n    \"bathrooms\": null,\n    \"area\": null,\n    \"lot\": null\n  },\n  \"propertySearch\": {\n    \"type\": \"Residential\",\n    \"neighborhood\": \"Hollywood\",\n    \"city\": \"Los Angeles\",\n    \"state\": \"CA\",\n    \"code\": \"90068\",\n    \"minPrice\": 300000,\n    \"maxPrice\": 500000,\n    \"minBedrooms\": 0,\n    \"maxBedrooms\": 2,\n    \"minBathrooms\": 1,\n    \"maxBathrooms\": 2,\n    \"minArea\": 100,\n    \"maxArea\": 1200,\n    \"forRent\": 0,\n    \"action\": \"ADD\",\n    \"maxHoaFee\": 0,\n    \"zillowSsid\": \"1234\",\n    \"keywordList\": [\"Downtown\"],\n    \"statusTypes\": [\n        \"pending\",\n        \"recently closed\"\n    ],\n    \"minYearBuilt\": 1930,\n    \"minParkingSpot\": 1\n  }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":132,"default":0},"created":{"type":"string","example":"2014-05-05T19:38:27Z"},"updated":{"type":"string","example":"2014-05-05T19:38:27Z"},"personId":{"type":"integer","example":12264,"default":0},"message":{"type":"string","example":"I am interested in 6825 Mulholland Dr, ..."},"description":{"type":"string","example":"Move-in: 12/28/2013"},"noteId":{"type":"integer","example":32,"default":0},"source":{"type":"string","example":"Zillow"},"type":{"type":"string","example":"Property Inquiry"},"property":{"type":"object","properties":{"street":{"type":"string","example":"6825 Mulholland Dr"},"city":{"type":"string","example":"Los Angeles"},"state":{"type":"string","example":"CA"},"code":{"type":"string","example":"90068"},"mlsNumber":{"type":"string","example":"14729339"},"price":{"type":"string","example":"310000"},"forRent":{"type":"string","example":"0"},"url":{"type":"string","example":"http://www.zillow.com/homedetails/6825-Mulholland-Dr-Los-Angeles-CA-90068/2109065822_zpid/"},"type":{"type":"string","example":"Residential"},"bedrooms":{"type":"string","example":"0"},"bathrooms":{},"area":{},"lot":{}}},"propertySearch":{"type":"object","properties":{"type":{"type":"string","example":"Residential"},"neighborhood":{"type":"string","example":"Hollywood"},"city":{"type":"string","example":"Los Angeles"},"state":{"type":"string","example":"CA"},"code":{"type":"string","example":"90068"},"minPrice":{"type":"integer","example":300000,"default":0},"maxPrice":{"type":"integer","example":500000,"default":0},"minBedrooms":{"type":"integer","example":0,"default":0},"maxBedrooms":{"type":"integer","example":2,"default":0},"minBathrooms":{"type":"integer","example":1,"default":0},"maxBathrooms":{"type":"integer","example":2,"default":0},"minArea":{"type":"integer","example":100,"default":0},"maxArea":{"type":"integer","example":1200,"default":0},"forRent":{"type":"integer","example":0,"default":0},"action":{"type":"string","example":"ADD"},"maxHoaFee":{"type":"integer","example":0,"default":0},"zillowSsid":{"type":"string","example":"1234"},"keywordList":{"type":"array","items":{"type":"string","example":"Downtown"}},"statusTypes":{"type":"array","items":{"type":"string","example":"pending"}},"minYearBuilt":{"type":"integer","example":1930,"default":0},"minParkingSpot":{"type":"integer","example":1,"default":0}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/people":{"get":{"summary":"/people","description":"Search for people.","operationId":"people-get","parameters":[{"name":"id","in":"query","description":"The ID(s) of a person or people. (e.g., \"123,456\")","schema":{"type":"string"}},{"name":"sort","in":"query","description":"The sort order, can be one of the following: `id`, `created`, `updated`, `name`, `firstName`, `lastName`, `price`, `stage`, `lastActivity`, `lastCommunication`, `lastReceivedEmail`, `lastSentEmail`, `lastEmail`, `emailsReceived`, `emailsSent`, `lastIncomingCall`, `lastOutgoingCall`, `lastCall`, `firstCall`, `callsIncoming`, `callsOutgoing`, `callsDuration`, `lastReceivedText`, `lastSentText`, `lastText`, `lastLeadActivity`, `lastEmEventActivity`, `lastIdxVisit`, `textsReceived`, `textsSent`, `propertiesViewed`, `propertiesSaved`, `pagesViewed` or `nextTask`. <br /><br />Custom Fields (e.g. `customClosePrice`) can also be used in sorting.","schema":{"type":"string","default":"created"}},{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip, before starting to return results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"fields","in":"query","description":"Comma separated list of fields to return or use `allFields` to return all fields. (e.g., `firstName,lastName,timeframeId,timeframeUpdated,timeframeStatus,customFieldName`).  Note: All custom fields should be prefixed with `custom` (i.e. customBirthday, customField).   <br><br> Special values include `allCustom` (returns all custom fields) and `allFields` (returns all fields, including custom fields).  <br><br> When using the `fields` parameter to filter the response, the `id` field will be included (even when not specified explicitly).","schema":{"type":"string"}},{"name":"lastActivityAfter","in":"query","description":"Search for last activity after a given time. (e.g., \"2016-11-23 01:02:03\")","schema":{"type":"string"}},{"name":"lastActivityBefore","in":"query","description":"Search for last activity before a given time. (e.g., \"2016-11-23 01:02:03\")","schema":{"type":"string"}},{"name":"name","in":"query","description":"Search for person with a name like what is given. (e.g., If you search for \"drew\", it might return a contact like \"Andrew\".)","schema":{"type":"string"}},{"name":"firstName","in":"query","description":"Search for person with a first name like what is given. (e.g., If you search for \"drew\", it might return a contact like \"Andrew\".)","schema":{"type":"string"}},{"name":"lastName","in":"query","description":"Search for person with a last name like what is given. (e.g., If you search for \"drew\", it might return a contact like \"Andrew\".)","schema":{"type":"string"}},{"name":"email","in":"query","description":"Search for a person by email address.","schema":{"type":"string"}},{"name":"phone","in":"query","description":"Search for a person by phone number.","schema":{"type":"string"}},{"name":"stage","in":"query","description":"Search for person by stage name. (e.g., \"Lead\" or \"Trash\". See [stages API endpoint](ref:stages-get) for available stages.)","schema":{"type":"string"}},{"name":"source","in":"query","description":"Search for a person by lead source.","schema":{"type":"string"}},{"name":"assignedTo","in":"query","description":"Search for a person by the user that is assigned to them. (e.g., Passing \"William Riker\" would return any person assigned to them.)","schema":{"type":"string"}},{"name":"assignedUserId","in":"query","description":"Search for people by the assigned user ID.","schema":{"type":"integer","format":"int32"}},{"name":"assignedPondId","in":"query","description":"Search for a person by the assigned pond id.","schema":{"type":"integer","format":"int32"}},{"name":"assignedLenderName","in":"query","description":"Search for people by the assigned lender name.","schema":{"type":"string"}},{"name":"assignedLenderId","in":"query","description":"Search for people by the assigned lender user ID.","schema":{"type":"integer","format":"int32"}},{"name":"contacted","in":"query","description":"Search for people by whether or not they have been contacted.","schema":{"type":"boolean"}},{"name":"priceAbove","in":"query","description":"Search for people who have specified a price above a given value.","schema":{"type":"integer","format":"int32"}},{"name":"priceBelow","in":"query","description":"Search for people who have specified a price below a given value.","schema":{"type":"integer","format":"int32"}},{"name":"smartListId","in":"query","description":"Search for people that match a smart list with given ID.","schema":{"type":"integer","format":"int32"}},{"name":"includeTrash","in":"query","description":"Set whether to include people in the \"trash\" stage. (By default responses from /people will not include any people with a \"trash\" stage.)","schema":{"type":"boolean","default":false}},{"name":"includeUnclaimed","in":"query","description":"Set to include unclaimed leads offered to the current user.","schema":{"type":"boolean","default":false}},{"name":"tags","in":"query","description":"Search for people that match one or more tags. (e.g., \"Foo,Bar\" will match contacts with tags that include Foo OR Bar.)","schema":{"type":"string"}},{"name":"custom*","in":"query","description":"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](doc:custom-fields-get) for more about Custom Fields.","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"people\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 35\n  },\n  \"people\": [\n    {\n      \"id\": 10763,\n      \"created\": \"2013-10-31T23:04:30Z\",\n      \"updated\": \"2014-06-27T13:11:23Z\",\n      \"createdVia\": \"API\",\n      \"lastActivity\": \"2014-06-27T13:11:23Z\",\n      \"name\": \"Tom Minch\",\n      \"firstName\": \"Tom\",\n      \"lastName\": \"Minch\",\n      \"stage\": \"Lead\",\n      \"source\": \"MyAwesomeWebsite.com\",\n      \"sourceUrl\": \"\",\n      \"contacted\": 0,\n      \"price\": 500000,\n      \"timeframeId\": 1,\n      \"assignedLenderId\": null,\n      \"assignedLenderName\": null,\n      \"assignedUserId\": 8,\n      \"assignedTo\": \"Agent White\",\n      \"collaborators\": [\n        {\n           \"id\": 8,\n           \"name\": \"Tom Minch\",\n           \"assigned\": true,\n           \"role\": \"Broker\"\n         }\n      ],\n      \"tags\": [ \"Los Angeles\", \"90003\", \"2014 May\" ],\n      \"emails\": [\n        {\n          \"value\": \"tom.minch@example.com\",\n          \"type\": \"home\",\n          \"isPrimary\": 1,\n          \"status\": \"Valid\"\n        }\n      ],\n      \"phones\": [\n        {\n          \"type\": \"home\",\n          \"value\": \"555-555-1234\",\n          \"status\": \"Invalid\"\n        }\n      ],\n      \"addresses\": [\n        {\n          \"type\": \"work\",\n          \"street\": \"322 S Broadway\",\n          \"city\": \"Los Angeles\",\n          \"state\": \"CA\",\n          \"code\": \"90003\",\n          \"country\": \"United States\"\n        }\n      ],\n      \"picture\": {\n        \"small\": \"https://example.com/pictures/89615e1a7fe.jpg\"\n      }\n    }\n    ...\n  ]\n}"}}}}}},"deprecated":false},"post":{"summary":"/people","description":"Manually add a new person.","operationId":"people-post","parameters":[{"name":"deduplicate","in":"query","description":"By default new people will be created even if there are existing people with the same email or phone. By passing true, deduplication logic will be used and, if a person is found, a 200 response will be returned along with response data for that existing person. No changes will be made based on the payload.","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"createdAt":{"type":"string","description":"Will set the creation time for the person, if wanting to create historical leads.","format":"date"},"firstName":{"type":"string","description":"The first/given name of the person."},"lastName":{"type":"string","description":"The last/family name of the person."},"stage":{"type":"string","description":"The stage the person is in. (e.g., \"Lead\" or \"Trash\". See [stage API endpoint](ref:stages-get) for more options.)","default":"Lead"},"source":{"type":"string","description":"The source of the lead."},"sourceUrl":{"type":"string","description":"This is a direct link to the information about a person at the lead provider."},"contacted":{"type":"boolean","description":"Whether the person has been contacted or not."},"price":{"type":"integer","description":"The price of the property of the person's first inquiry, or the estimated sell/buy price for this person.","format":"int32"},"assignedTo":{"type":"string","description":"Full name of the agent assigned to this person."},"assignedUserId":{"type":"integer","description":"ID of the agent assigned to this person.","format":"int32"},"assignedPondId":{"type":"integer","description":"ID of the pond assigned to this person.","format":"int32"},"assignedLenderName":{"type":"string","description":"Full name of the lender assigned to this person."},"assignedLenderId":{"type":"integer","description":"ID of the lender assigned to this person.","format":"int32"},"emails":{"type":"array","description":"A list of email addresses associated with the person. (Specify type and value, isPrimary is not expected. The first email in the list will be the primary email address.)","items":{"properties":{"value":{"type":"string","description":"The email address."},"type":{"type":"string","description":"The type of email address (e.g., \"work\", \"home\")"},"isPrimary":{"type":"boolean","description":"Sets whether the email address is the primary address.","default":false}},"required":["value"],"type":"object"}},"phones":{"type":"array","description":"A list of phone numbers associated with the person. (Specify type and value, isPrimary is not expected. The first phone in the list will be the primary phone number.)","items":{"properties":{"value":{"type":"string","description":"The phone number. (e.g., 888-555-1234)"},"isPrimary":{"type":"boolean","description":"Sets whether this is the primary phone number.","default":false},"type":{"type":"string","description":"Type of number (e.g., \"mobile\", \"home\", \"fax\", etc.)"}},"required":["value"],"type":"object"}},"addresses":{"type":"array","description":"A list of addresses associated with the person. (These are the addresses where this person can be contacted, it is not the address of a property this person may be interested in selling or buying).","items":{"properties":{"type":{"type":"string","description":"The address type. (e.g., \"home\", \"work\", \"mailing\", \"investment\", etc.)","default":"home"},"street":{"type":"string","description":"Street address. (e.g., \"3595 South Higuera St., Suite B\")"},"city":{"type":"string","description":"City name."},"state":{"type":"string","description":"Abbreviated state code. (e.g., \"CA\", \"NY\", etc.)"},"code":{"type":"string","description":"Zipcode. (As a string, not a number.)"},"country":{"type":"string","description":"Country name. (e.g., \"United States\", \"Japan\", etc.)"}},"type":"object"}},"tags":{"type":"array","description":"A list of tags applied to the person.","items":{"type":"string"}},"background":{"type":"string","description":"Background information on the person. (Can be a multi-line string.)"},"collaborators":{"type":"array","description":"List of user ids to set as collaborators on this person. Not including a collaborator's user id in this array will remove them as a collaborator.","items":{"type":"integer","format":"int32"}},"custom*":{"type":"string","description":"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](doc:custom-fields-get) for more about Custom Fields."},"timeframeId":{"type":"integer","description":"ID of the timeframe to move (Refer to the /timeframes endpoint for valid values of timeframeId.)","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/people/{id}":{"get":{"summary":"/people/:id","description":"Retrieve a person by id.","operationId":"people-id-get","parameters":[{"name":"id","in":"path","description":"ID of the person.","schema":{"type":"integer","format":"int32"},"required":true},{"name":"fields","in":"query","description":"Comma separated list of fields to return. (e.g., `firstName,lastName,timeframeId,timeframeUpdated,timeframeStatus,customFieldName`) <br><br> Special values include `allCustom` (returns all custom fields) and `allFields` (returns all fields, including custom fields).","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 14412,\n  \"created\": \"2016-03-31T16:42:27Z\",\n  \"updated\": \"2016-11-17T03:44:00Z\",\n  \"createdVia\": \"API\",\n  \"lastActivity\": \"2016-11-17T05:01:02Z\",\n  \"name\": \"William Riker\",\n  \"firstName\": \"William\",\n  \"lastName\": \"Riker\",\n  \"prequalified\": false,\n  \"stage\": \"Lead\",\n  \"stageId\": 2,\n  \"source\": \"<unspecified>\",\n  \"sourceUrl\": \"\",\n  \"contacted\": 1,\n  \"price\": 310000,\n  \"assignedLenderId\": null,\n  \"assignedLenderName\": null,\n  \"assignedUserId\": 1,\n  \"assignedTo\": \"Gerald Leenerts\",\n  \"collaborators\": [\n    {\n       \"id\": 1,\n       \"name\": \"Gerald Leenerts\",\n       \"assigned\": true,\n       \"role\": \"Broker\"\n    }\n  ],\n  \"tags\": [\n    \"star trek\",\n  ],\n  \"emails\": [\n    {\n      \"value\": \"example@example.com\",\n      \"type\": \"home\",\n      \"isPrimary\": 1,\n      \"status\": \"Valid\",\n    },\n    {\n      \"value\": \"mobile@example.com\",\n      \"type\": \"work\",\n      \"isPrimary\": 0,\n      \"status\": \"Valid\",\n    }\n  ],\n  \"phones\": [\n    {\n      \"value\": \"2345678901\",\n      \"type\": \"home\",\n      \"isPrimary\": 1,\n      \"status\": \"Invalid\",\n    },\n    {\n      \"value\": \"2345678902\",\n      \"type\": \"mobile\",\n      \"isPrimary\": 0,\n      \"status\": \"Not Validated\",\n    }\n  ],\n  \"addresses\": [],\n  \"picture\": {\n    \"small\": \"http://vignette1.wikia.nocookie.net/memoryalpha/images/4/4f/Riker_orders_Worf_to_fire_on_the_Borg_cube.jpg/revision/latest?cb=20130213024734&path-prefix=en\"\n  },\n  \"timeframeId\": 1\n}"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"put":{"summary":"/people/:id","description":"Update a person by id.","operationId":"people-id-put","parameters":[{"name":"id","in":"path","description":"ID of the person.","schema":{"type":"integer","format":"int32"},"required":true},{"name":"mergeTags","in":"query","description":"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.","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","description":"The first/given name of the person."},"lastName":{"type":"string","description":"The last/family name of the person."},"stage":{"type":"string","description":"The stage the person is in. (e.g., \"Lead\" or \"Trash\". See [stage API endpoint](ref:stages-get) for more options.)","default":"Lead"},"contacted":{"type":"boolean","description":"Whether the person has been contacted. (**Note**: Changing the `contacted` field to `true` will pause action plans.)"},"price":{"type":"integer","description":"The price of the property of the person's first inquiry, or the estimated sell/buy price for this person.","format":"int32"},"assignedTo":{"type":"string","description":"Full name of the agent assigned to this person."},"assignedUserId":{"type":"integer","description":"ID of the agent assigned to this person.","format":"int32"},"assignedPondId":{"type":"integer","description":"ID of the pond assigned to this person.","format":"int32"},"assignedLenderName":{"type":"string","description":"Full name of the lender assigned to this person."},"assignedLenderId":{"type":"integer","description":"ID of the lender assigned to this person.","format":"int32"},"emails":{"type":"array","description":"A list of email addresses associated with the person.","items":{"properties":{"value":{"type":"string","description":"The email address."},"type":{"type":"string","description":"The type of email address (e.g., \"work\", \"home\")"},"isPrimary":{"type":"boolean","description":"Sets whether the email address is the primary address.","default":false}},"required":["value"],"type":"object"}},"phones":{"type":"array","description":"A list of phone numbers associated with the person.","items":{"properties":{"value":{"type":"string","description":"The phone number. (e.g., 888-555-1234)"},"isPrimary":{"type":"boolean","description":"Sets whether this is the primary phone number.","default":false},"type":{"type":"string","description":"Type of number (e.g., \"mobile\", \"home\", \"fax\", etc.)"}},"required":["value"],"type":"object"}},"addresses":{"type":"array","description":"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).","items":{"properties":{"type":{"type":"string","description":"The address type. (e.g., \"home\", \"work\", \"mailing\", \"investment\", etc.)","default":"home"},"street":{"type":"string","description":"Street address. (e.g., \"3595 South Higuera St., Suite B\")"},"city":{"type":"string","description":"City name."},"state":{"type":"string","description":"Abbreviated state code. (e.g., \"CA\", \"NY\", etc.)"},"code":{"type":"string","description":"Zipcode. (As a string, not a number.)"},"country":{"type":"string","description":"Country name. (e.g., \"United States\", \"Japan\", etc.)"}},"type":"object"}},"tags":{"type":"array","description":"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.)","items":{"type":"string"}},"background":{"type":"string","description":"Background information on the person. (Can be a multi-line string.)"},"custom*":{"type":"string","description":"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](doc:custom-fields-get) for more about Custom Fields."},"timeframeId":{"type":"integer","description":"ID of the timeframe to move (Refer to the /timeframes endpoint for valid values of timeframeId.)","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"/people/:id","description":"Delete a person by id.","operationId":"people-id-delete","parameters":[{"name":"id","in":"path","description":"ID of person.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/users":{"get":{"summary":"/users","description":"Search for users.","operationId":"users-get","parameters":[{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip before starting to return results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"sort","in":"query","description":"Field to sort by. (Currently only `id`, `name` and `created` are available.)","schema":{"type":"string"}},{"name":"role","in":"query","description":"Find users by a specific role. (e.g., \"Broker\", \"Agent\", \"Lender\")","schema":{"type":"string"}},{"name":"name","in":"query","description":"Find a user by their full name. (Exact matches only, no partial matching available.)","schema":{"type":"string"}},{"name":"email","in":"query","description":"Find a user by their email.","schema":{"type":"string"}},{"name":"fields","in":"query","description":"Comma separated list of fields (e.g., id,name,calling) to return or use allFields to return all fields (except for calling information, unless included like allFields,calling). <br><br> When using the fields parameter to filter the response, the id field will be included (even when not specified explicitly).","schema":{"type":"string"}},{"name":"includeDeleted","in":"query","description":"Setting this to `true` will include users that have been deleted.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"users\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 5,\n    \"next\": null,\n    \"nextLink\": null\n  },\n  \"users\": [\n    {\n      \"id\": 1,\n      \"created\": \"2023-03-06T19:48:47Z\",\n      \"updated\": \"2023-04-24T14:38:13Z\",\n      \"name\": \"Jean-Luc Picard\",\n      \"firstName\": \"Jean-Luc\",\n      \"lastName\": \"Picard\",\n      \"email\": \"jeanluc@enterprise.uss\",\n      \"phone\": \"1234567890\",\n      \"role\": \"Captain\",\n      \"status\": \"Active\",\n      \"timezone\": \"America/New_York\",\n      \"beta\": true,\n      \"picture\": [],\n      \"pauseLeadDistribution\": false,\n      \"lastSeenIos\": null,\n      \"lastSeenAndroid\": null,\n      \"lastSeenFub2\": \"2023-04-24T14:38:14Z\",\n      \"canExport\": true,\n      \"canCreateApiKeys\": true,\n      \"isOwner\": true,\n      \"groups\": [\n        {\n          \"id\": 2,\n          \"name\": \"Seller Leads\"\n        },\n        {\n          \"id\": 1,\n          \"name\": \"Team Integration Test\"\n        }\n      ],\n      \"teamIds\": [\n        1\n      ],\n      \"teamLeaderOf\": [],\n      \"leadEmailAddress\": \"cl.integration.test@followupboss.me\"\n    }\n    ...\n  ]\n}"}}}}}},"deprecated":false}},"/smartLists":{"get":{"summary":"/smartLists","description":"Get a list of Smart Lists.","operationId":"smartlists-get","parameters":[{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip before starting to return results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"fub2","in":"query","description":"By default this endpoint only returns Smart Lists created in the classic version of our UI. To return Smart Lists created in our current version, use this parameter.","schema":{"type":"boolean","default":false}},{"name":"all","in":"query","description":"Use this parameter to show all smart lists, whether from FUB Classic or FUB.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"smartlists\",\n    \"offset\": 0,\n    \"limit\": 100,\n    \"total\": 3\n  },\n  \"smartlists\": [\n        {\n            \"id\": 14,\n            \"name\": \"Stay In Touch\",\n            \"isFub2\": false,\n            \"description\": null,\n            \"defaultSmartListId\": null\n        },\n        {\n            \"id\": 13,\n            \"name\": \"Email Activity\",\n            \"isFub2\": false,\n            \"description\": null,\n            \"defaultSmartListId\": null\n        },\n        {\n            \"id\": 12,\n            \"name\": \"IDX Activity\",\n            \"isFub2\": false,\n            \"description\": null,\n            \"defaultSmartListId\": null\n        }\n  ]\n}"}},"schema":{"type":"object","properties":{"_metadata":{"type":"object","properties":{"collection":{"type":"string","example":"smartlists"},"offset":{"type":"integer","example":0,"default":0},"limit":{"type":"integer","example":100,"default":0},"total":{"type":"integer","example":3,"default":0}}},"smartlists":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":14,"default":0},"name":{"type":"string","example":"Stay In Touch"},"isFub2":{"type":"boolean","example":false,"default":true},"description":{},"defaultSmartListId":{}}}}}}}}}},"deprecated":false}},"/smartLists/{id}":{"get":{"summary":"/smartLists/:id","description":"Retrieve a Smart List by id.","operationId":"smartlist-id-get","parameters":[{"name":"id","in":"path","description":"The ID of the Smart List.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 6,\n  \"name\": \"Pending\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":6,"default":0},"name":{"type":"string","example":"Pending"}}}}}}},"deprecated":false}},"/templates/{id}":{"get":{"summary":"/templates/:id","description":"Retrieve an email template by id, optionally merging fields.","operationId":"templates-id-get","parameters":[{"name":"id","in":"path","description":"The ID of the template.","schema":{"type":"integer","format":"int32"},"required":true},{"name":"mergePersonId","in":"query","description":"When specified, the returned template will have its merge fields filled out with the specified person record and the current user record.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 6,\n  \"created\": \"2014-02-28T08:45:46Z\",\n  \"updated\": \"2014-08-12T17:24:22Z\",\n  \"createdById\": 14,\n  \"updatedById\": 14,\n  \"name\": \"I am here to help\",\n  \"isMobile\": 1,\n  \"isShared\": true,\n  \"body\": \"Hi %contact_first_name%, I am here to help, ...\",\n  \"subject\": \"Your property inquiry from Zillow\",\n  \"isEditable\": true,\n  \"isDeletable\": true,\n  \"actionPlans\": [\n    {\n        \"id\": 1,\n        \"name\": \"Buyers engagement emails\"\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":6,"default":0},"created":{"type":"string","example":"2014-02-28T08:45:46Z"},"updated":{"type":"string","example":"2014-08-12T17:24:22Z"},"createdById":{"type":"integer","example":14,"default":0},"updatedById":{"type":"integer","example":14,"default":0},"name":{"type":"string","example":"I am here to help"},"isMobile":{"type":"integer","example":1,"default":0},"isShared":{"type":"boolean","example":true,"default":true},"body":{"type":"string","example":"Hi %contact_first_name%, I am here to help, ..."},"subject":{"type":"string","example":"Your property inquiry from Zillow"},"isEditable":{"type":"boolean","example":true,"default":true},"isDeletable":{"type":"boolean","example":true,"default":true},"actionPlans":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"Buyers engagement emails"}}}}}}}}}},"deprecated":false},"delete":{"summary":"/templates/:id","description":"Delete an email template.","operationId":"templates-id-delete","parameters":[{"name":"id","in":"path","description":"The ID of the template to delete.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Result":{"value":"{\"errorMessage\":\"This template cannot be deleted.\"}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"This template cannot be deleted."}}}}}}},"deprecated":false},"put":{"summary":"/templates/:id","description":"Update an email template.","operationId":"templates-id-put","parameters":[{"name":"id","in":"path","description":"The ID of the email template.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","subject","body"],"properties":{"name":{"type":"string","description":"The new name for the email template."},"subject":{"type":"string","description":"The new subject for the email template."},"body":{"type":"string","description":"The new body for the email template."}}},"examples":{"Request Example":{"value":{"name":"Beach House promo","subject":"Check out this beach house!","body":"%greeting_time%,&nbsp;%contact_first_name%<br><br>Check out this beach house: <a href=\"https://example.com\">https://example.com</a><br><br>","isShared":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 845,\n  \"name\": \"Beach House promo\",\n  \"subject\": \"Check out this beach house!\",\n  \"body\": \"%greeting_time%,&nbsp;%contact_first_name%<br><br>Check out this beach house: <a href=\\\"https://example.com\\\">https://example.com</a><br><br>\",\n  \"isShared\": true\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":845,"default":0},"name":{"type":"string","example":"Beach House promo"},"subject":{"type":"string","example":"Check out this beach house!"},"body":{"type":"string","example":"%greeting_time%,&nbsp;%contact_first_name%<br><br>Check out this beach house: <a href=\"https://example.com\">https://example.com</a><br><br>"},"isShared":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false}},"/customFields":{"get":{"summary":"/customFields","description":"List all custom fields.","operationId":"customfields-get","parameters":[{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip, before starting to return results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"label","in":"query","description":"Find custom field by label.","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sorts results based on the provided field name. Prepending the field with a minus sign (-) sorts the results in descending order.","schema":{"type":"string","enum":["id","name","orderWeight"],"default":"id (desc)"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"customfields\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": \"4\"\n  },\n  \"customfields\": [\n    {\n      \"id\": 2,\n      \"label\": \"Birthday\",\n      \"name\": \"customBirthday\",\n      \"type\": \"date\",\n      \"isRecurring\": true\n    },\n    {\n      \"id\": 4,\n      \"label\": \"Facebook\",\n      \"name\": \"customFacebook\",\n      \"type\": \"text\"\n    },\n    {\n      \"id\": 6,\n      \"label\": \"Looking for\",\n      \"name\": \"customLookingFor\",\n      \"type\": \"dropdown\",\n      \"choices\": [\n          \"Apartment\",\n          \"Townhouse\",\n          \"Detached House\"\n      ]\n    },\n    {\n      \"id\": 7,\n      \"label\": \"Close price\",\n      \"name\": \"customClosePrice\",\n      \"type\": \"number\"\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"_metadata":{"type":"object","properties":{"collection":{"type":"string","example":"customfields"},"offset":{"type":"integer","example":0,"default":0},"limit":{"type":"integer","example":10,"default":0},"total":{"type":"string","example":"4"}}},"customfields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":2,"default":0},"label":{"type":"string","example":"Birthday"},"name":{"type":"string","example":"customBirthday"},"type":{"type":"string","example":"date"},"isRecurring":{"type":"boolean","example":true,"default":true}}}}}}}}}},"deprecated":false},"post":{"summary":"/customFields","description":"Create a custom field.","operationId":"customfields-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["label","type"],"properties":{"label":{"type":"string","description":"The user-friendly name of the custom field (e.g., \"Anniversary\")."},"type":{"type":"string","description":"The type of custom field.","enum":["text","date","number","dropdown"]},"choices":{"type":"array","description":"Array of options related to a custom field of type `dropdown`.","items":{"type":"string"}},"isRecurring":{"type":"boolean","description":"Whether a date field occurs every year (e.g. birthdays, anniversaries, etc.). (Note: This is only set and returned for `date` custom fields.)","default":false},"hideIfEmpty":{"type":"boolean","description":"When viewing a person, we will hide this field if it is empty.","default":false},"orderWeight":{"type":"integer","description":"A weighted integer for the field to assign values for custom sorting.","default":0,"format":"int32"}}},"examples":{"Request Example":{"value":{"label":"Birthday","name":"customBirthday","type":"date","isRecurring":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 2,\n  \"label\": \"Birthday\",\n  \"name\": \"customBirthday\",\n  \"type\": \"date\",\n  \"isRecurring\": true\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":2,"default":0},"label":{"type":"string","example":"Birthday"},"name":{"type":"string","example":"customBirthday"},"type":{"type":"string","example":"date"},"isRecurring":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false}},"/notes":{"post":{"summary":"/notes","description":"Add a note.","operationId":"notes-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["personId"],"properties":{"personId":{"type":"integer","description":"The ID of a person.","format":"int32"},"subject":{"type":"string","description":"Gives a note a title or subject."},"body":{"type":"string","description":"The content of the note."},"isHtml":{"type":"boolean","description":"If enabled, will render the HTML tags contained within the body on the Follow Up Boss user interface."}}},"examples":{"JSON Example":{"value":{"personId":12235,"subject":"Some note subject","body":"This is the content of the note","isHtml":0}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/users/{id}":{"get":{"summary":"/users/:id","description":"Retrieve a user by id.","operationId":"users-id-get","parameters":[{"name":"id","in":"path","description":"The ID of a user.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 5,\n  \"created\": \"2013-05-05T22:55:19Z\",\n  \"updated\": \"2014-03-06T08:52:25Z\",\n  \"name\": \"Daniel Corkill\",\n  \"firstName\": \"Daniel\",\n  \"lastName\": \"Corkill\",\n  \"email\": \"dan@example.com\",\n  \"phone\": \"\",\n  \"role\": \"Broker\",\n  \"status\": \"Active\",\n  \"timezone\": \"Asia/Beirut\",\n  \"beta\": false,\n  \"isOwner\": false,\n  \"leadEmailAddress\": \"dan.corkill@followupboss.me\",\n  \"groups\": [\n    {\n      \"id\": 1,\n      \"name\": \"Buyer Leads\"\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Seller Leads\"\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":5,"default":0},"created":{"type":"string","example":"2013-05-05T22:55:19Z"},"updated":{"type":"string","example":"2014-03-06T08:52:25Z"},"name":{"type":"string","example":"Daniel Corkill"},"firstName":{"type":"string","example":"Daniel"},"lastName":{"type":"string","example":"Corkill"},"email":{"type":"string","example":"dan@example.com"},"phone":{"type":"string","example":""},"role":{"type":"string","example":"Broker"},"status":{"type":"string","example":"Active"},"timezone":{"type":"string","example":"Asia/Beirut"},"beta":{"type":"boolean","example":false,"default":true},"isOwner":{"type":"boolean","example":false,"default":true},"leadEmailAddress":{"type":"string","example":"dan.corkill@followupboss.me"},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"Buyer Leads"}}}}}}}}}},"deprecated":false},"delete":{"summary":"/users/:id","description":"Delete a user.","operationId":"users-id-delete","parameters":[{"name":"id","in":"path","description":"ID of user to delete.","schema":{"type":"integer","format":"int32"},"required":true},{"name":"assignTo","in":"query","description":"ID of another user to reassign the deleted user's leads to.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/templates":{"get":{"summary":"/templates","description":"Lists all email templates.","operationId":"templates-get","parameters":[{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip before starting to return results.","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"templates\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 5\n  },\n  \"templates\": [\n    {\n      \"id\": 6,\n      \"created\": \"2014-02-28T08:45:46Z\",\n      \"updated\": \"2014-08-12T17:24:22Z\",\n      \"createdById\": 14,\n      \"updatedById\": 14,\n      \"name\": \"I am here to help\",\n      \"isMobile\": 1,\n      \"isShared\": true,\n      \"body\": \"Hi %contact_first_name%, I am here to help, ...\",\n      \"subject\": \"%inquiry_address%\",\n      \"isEditable\": true,\n      \"isDeletable\": true,\n      \"actionPlans\": [\n        {\n            \"id\": 1,\n            \"name\": \"Buyers engagement emails\"\n        }\n      ]\n    }\n    ...\n  ]\n}"}}}}}},"deprecated":false},"post":{"summary":"/templates","description":"Create a new email template.","operationId":"templates-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","subject","body"],"properties":{"name":{"type":"string","description":"The name of the new email template."},"subject":{"type":"string","description":"The email subject used when this email template is selected."},"body":{"type":"string","description":"The HTML body of the email template."},"isShared":{"type":"boolean","description":"Indicates whether this email template should be shared with other users in the same Follow Up Boss account."}}},"examples":{"Request Example":{"value":{"name":"Beach House promo","subject":"Check out this beach house!","body":"%greeting_time%,&nbsp;%contact_first_name%<br><br>Check out this beach house: <a href=\"https://example.com\">https://example.com</a><br><br>","isShared":true}}}}}},"responses":{"201":{"description":"201","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 526,\n  \"created\": \"2021-06-21T21:23:12Z\",\n  \"updated\": \"2021-06-21T21:23:12Z\",\n  \"createdById\": 15,\n  \"updatedById\": 15,\n  \"name\": \"Beach House promo\",\n  \"imported\": 0,\n  \"isMobile\": 0,\n  \"isShared\": true,\n  \"body\": \"%greeting_time%, %contact_first_name%<br /><br />Check out this beach house: <a href=\\\"https://example.com\\\">https://example.com</a><br /><br />\",\n  \"subject\": \"Check out this beach house!\",\n  \"isEditable\": true,\n  \"isDeletable\": true,\n  \"isShareable\": true,\n  \"actionPlans\": [],\n  \"categories\": []\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":526,"default":0},"created":{"type":"string","example":"2021-06-21T21:23:12Z"},"updated":{"type":"string","example":"2021-06-21T21:23:12Z"},"createdById":{"type":"integer","example":15,"default":0},"updatedById":{"type":"integer","example":15,"default":0},"name":{"type":"string","example":"Beach House promo"},"imported":{"type":"integer","example":0,"default":0},"isMobile":{"type":"integer","example":0,"default":0},"isShared":{"type":"boolean","example":true,"default":true},"body":{"type":"string","example":"%greeting_time%, %contact_first_name%<br /><br />Check out this beach house: <a href=\"https://example.com\">https://example.com</a><br /><br />"},"subject":{"type":"string","example":"Check out this beach house!"},"isEditable":{"type":"boolean","example":true,"default":true},"isDeletable":{"type":"boolean","example":true,"default":true},"isShareable":{"type":"boolean","example":true,"default":true},"actionPlans":{"type":"array","items":{"type":"object","properties":{}}},"categories":{"type":"array","items":{"type":"object","properties":{}}}}}}}}},"deprecated":false}},"/actionPlans":{"get":{"summary":"/actionPlans","description":"Get a list of Action Plans.","operationId":"actionplans-get","parameters":[{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip before starting to return results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"sort","in":"query","description":"Sort Action Plans by a given field. (e.g., \"id\" or \"name\")","schema":{"type":"string"}},{"name":"status","in":"query","description":"Search for Action Plans with one of the following statuses: `Active`,`Deleted`, or `Active,Deleted` (if you want both).","schema":{"type":"string"}},{"name":"names","in":"query","description":"Search for Action Plans by `name`. Use array parameters format with encoded values, e.g. `/actionPlans?names[]=Action%20Plan%20Name%201&names[]=Action%20Plan%20Name%202`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"ids","in":"query","description":"Search for Action Plans by `id`. Use a comma separated list, e.g. `/actionPlans?ids=287564,67484,8436437`","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"actionPlans\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 6\n  },\n  \"actionPlans\": [\n    {\n      \"id\": 6,\n      \"created\": \"2014-08-24T22:12:53Z\",\n      \"updated\": \"2014-08-24T22:12:53Z\",\n      \"name\": \"Qualify buyer leads\",\n      \"status\": \"Active\"\n    },\n    ...\n  ]\n}"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/notes/{id}":{"put":{"summary":"/notes/:id","description":"Edit a note.","operationId":"notes-id-put","parameters":[{"name":"id","in":"path","description":"The ID of the note to update.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"integer","description":"The ID of a person associated with this note.","format":"int32"},"subject":{"type":"string","description":"You can give a note a title or subject using this field."},"body":{"type":"string","description":"The content of the note."},"isHtml":{"type":"boolean","description":"If enabled, will render the HTML tags contained within the body on the Follow Up Boss user interface."}}},"examples":{"JSON Example":{"value":{"personId":12235,"subject":"Some note subject","body":"Plans to sell within the next three months.","isHtml":0}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 1819,\n  \"created\": \"2014-06-19T18:32:26Z\",\n  \"updated\": \"2014-06-19T18:32:26Z\",\n  \"createdBy\": \"Agent White\",\n  \"updatedBy\": \"Agent White\",\n  \"personId\": 12235,\n  \"subject\": \"Some note subject\",\n  \"body\": \"Plans to sell within the next three months.\",\n  \"type\": \"\",\n  \"isHtml\": 0\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":1819,"default":0},"created":{"type":"string","example":"2014-06-19T18:32:26Z"},"updated":{"type":"string","example":"2014-06-19T18:32:26Z"},"createdBy":{"type":"string","example":"Agent White"},"updatedBy":{"type":"string","example":"Agent White"},"personId":{"type":"integer","example":12235,"default":0},"subject":{"type":"string","example":"Some note subject"},"body":{"type":"string","example":"Plans to sell within the next three months."},"type":{"type":"string","example":""},"isHtml":{"type":"integer","example":0,"default":0}}}}}}},"deprecated":false},"get":{"summary":"/notes/:id","description":"Retrieve a note by id.","operationId":"notes-id-get","parameters":[{"name":"id","in":"path","description":"The ID of the note.","schema":{"type":"integer","format":"int32"},"required":true},{"name":"includeThreadedReplies","in":"query","description":"When set to true, will include threaded replies attached to the note. Replies may include HTML tags in their bodies.","schema":{"type":"boolean"}},{"name":"includeReactions","in":"query","description":"When set to true, will include the reactions that have been left on the note (as well as the replies if those have also been requested). Reactions are keyed by the emoji reaction. The value is an array of user IDs who have left that reaction.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 12345,\n    \"created\": \"2024-01-01T00:00:00Z\",\n    \"updated\": \"2024-01-01T00:00:00Z\",\n    \"createdById\": 1,\n    \"updatedById\": 1,\n    \"createdBy\": \"Mark Hamill\",\n    \"updatedBy\": \"Mark Hamill\",\n    \"personId\": 15,\n    \"showContent\": true,\n    \"subject\": \"\",\n    \"body\": \"Hello team!\",\n    \"type\": \"\",\n    \"isHtml\": false,\n    \"actionPlanId\": null,\n    \"isExternal\": false,\n    \"systemId\": 1,\n    \"systemName\": \"My System\",\n    \"replies\": [\n        {\n          \"id\": 100,\n          \"refId\": 12345,\n          \"refType\": \"Note\",\n          \"createdById\": 1,\n          \"createdBy\": \"Mark Hamill\",\n          \"created\": \"2024-01-01T00:00:00Z\",\n          \"updated\": \"2024-01-01T00:00:00Z\",\n          \"body\": \"Hello world!\",\n          \"starred\": false,\n          \"reactions\": {\n            \"👍\": [5],\n            \"👾\": [2]\n        \t]\n\t\t\t\t},\n        {\n          \"id\": 107,\n          \"refId\": 12345,\n          \"refType\": \"Note\",\n          \"createdById\": 2,\n          \"createdBy\": \"Carrie Fisher\",\n          \"created\": \"2024-01-02T00:00:00Z\",\n          \"updated\": \"2024-01-02T00:00:00Z\",\n          \"body\": \"Greetings!\",\n          \"starred\": false,\n          \"reactions\": {\n            \"😁\": [4, 1, 3],\n            \"👋\": [1]\n        \t]\n\t\t\t\t},\n    ],\n    \"reactions\": {\n        \"🗼\": [3]\n    }\n}"}}}}}},"deprecated":false},"delete":{"summary":"/notes/:id","description":"Delete a note.","operationId":"notes-id-delete","parameters":[{"name":"id","in":"path","description":"The ID of the note to delete.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/customFields/{id}":{"get":{"summary":"/customFields/:id","description":"Get a custom field by id.","operationId":"customfields-id-get","parameters":[{"name":"id","in":"path","description":"The ID of a custom field.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 6,\n    \"label\": \"Looking for\",\n    \"name\": \"customLookingFor\",\n    \"type\": \"dropdown\",\n    \"choices\": [\n        \"Apartment\",\n        \"Townhouse\",\n        \"Detached House\"\n    ]\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":6,"default":0},"label":{"type":"string","example":"Looking for"},"name":{"type":"string","example":"customLookingFor"},"type":{"type":"string","example":"dropdown"},"choices":{"type":"array","items":{"type":"string","example":"Apartment"}}}}}}}},"deprecated":false},"put":{"summary":"/customFields/:id","description":"Update a custom field.","operationId":"customfields-id-put","parameters":[{"name":"id","in":"path","description":"The ID of the custom field.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","description":"The user-friendly name of the custom field (e.g., \"Anniversary\")."},"choices":{"type":"array","description":"Array of options related to a custom field of type `dropdown`.","items":{"type":"string"}},"isRecurring":{"type":"boolean","description":"Sets whether a date field occurs every year (e.g., birthdays, anniversaries, etc.). (Note: This is only set and returned for `date` custom fields.)","default":false},"hideIfEmpty":{"type":"boolean","description":"When viewing a person, we will hide this field if it is empty.","default":false},"orderWeight":{"type":"integer","description":"A weighted integer for the field to assign values for custom sorting.","default":0,"format":"int32"},"dropdownChoiceMap":{"type":"array","description":"An optional mapping that points previous dropdown choices (keys) to their new positions (values). This is used to track when options get moved or renamed. If items are missing from the keys, they will be removed. If the mapping is not supplied, then this endpoint will try to determine if items have been moved or renamed on its own.","default":[null],"items":{"type":"integer","format":"int32"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 2,\n  \"label\": \"Birthday\",\n  \"name\": \"customBirthday\",\n  \"type\": \"date\",\n  \"isRecurring\": false\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":2,"default":0},"label":{"type":"string","example":"Birthday"},"name":{"type":"string","example":"customBirthday"},"type":{"type":"string","example":"date"},"isRecurring":{"type":"boolean","example":false,"default":true}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"text","code":"{\n  \"label\": \"Birthday\",\n  \"type\": \"date\",\n  \"isRecurring\": false\n}"}],"samples-languages":["text"]}},"delete":{"summary":"/customFields/:id","description":"Delete a custom field.","operationId":"customfields-id-delete","parameters":[{"name":"id","in":"path","description":"The ID of the custom field.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":""}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/me":{"get":{"summary":"/me","description":"Retrieve information about the currently authenticated user.","operationId":"me","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 1,\n  \"name\": \"Gerald Leenerts\",\n  \"role\": \"admin\",\n  \"email\": \"gerald@followupboss.com\",\n  \"phone\": \"(123) 456-7890\",\n  \"timeZone\": \"America/Chicago\",\n  \"signature\": \"<div>Cheers,<br></div><div>-Gerald</div>\",\n  \"rawSignature\": \"<div>Cheers,<br></div><div>-Gerald</div>\",\n  \"apiKey\": \"...\",\n  \"algoliaKey\": \"...\",\n  \"intercomSettings\": {\n    \"app_id\": \"...\",\n    \"created_at\": \"1313236940\",\n    \"user_hash\": \"...\",\n    \"user_id\": \"1234-1\"\n  },\n  \"account\": 1234,\n  \"teamMember\": null,\n  \"beta\": true,\n  \"betaOnly\": false,\n  \"connectedEmail\": {\n    \"email\": \"gerald@followupboss.com\",\n    \"oauthProvider\": \"google\",\n    \"shareEmails\": false,\n    \"imapLeadProcessing\": true,\n    \"hasSmtp\": true\n  },\n  \"leadEmailAddress\": \"gerald@followupboss.me\",\n  \"callingEnabled\": true,\n  \"voicemailEnabled\": false,\n  \"voicemailUrl\": null,\n  \"callingCapabilityToken\": \"\",\n  \"isOwner\": true,\n  \"unreadConversationCount\": 0,\n  \"notifyBy\": \"Email only\",\n  \"features\": [\n    \"action-plans-smtp\",\n    \"call-recording\",\n    \"calling\",\n    \"link-tracking\"\n  ]\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"Gerald Leenerts"},"role":{"type":"string","example":"admin"},"email":{"type":"string","example":"gerald@followupboss.com"},"phone":{"type":"string","example":"(123) 456-7890"},"timeZone":{"type":"string","example":"America/Chicago"},"signature":{"type":"string","example":"<div>Cheers,<br></div><div>-Gerald</div>"},"rawSignature":{"type":"string","example":"<div>Cheers,<br></div><div>-Gerald</div>"},"apiKey":{"type":"string","example":"..."},"algoliaKey":{"type":"string","example":"..."},"intercomSettings":{"type":"object","properties":{"app_id":{"type":"string","example":"..."},"created_at":{"type":"string","example":"1313236940"},"user_hash":{"type":"string","example":"..."},"user_id":{"type":"string","example":"1234-1"}}},"account":{"type":"integer","example":1234,"default":0},"teamMember":{},"beta":{"type":"boolean","example":true,"default":true},"betaOnly":{"type":"boolean","example":false,"default":true},"connectedEmail":{"type":"object","properties":{"email":{"type":"string","example":"gerald@followupboss.com"},"oauthProvider":{"type":"string","example":"google"},"shareEmails":{"type":"boolean","example":false,"default":true},"imapLeadProcessing":{"type":"boolean","example":true,"default":true},"hasSmtp":{"type":"boolean","example":true,"default":true}}},"leadEmailAddress":{"type":"string","example":"gerald@followupboss.me"},"callingEnabled":{"type":"boolean","example":true,"default":true},"voicemailEnabled":{"type":"boolean","example":false,"default":true},"voicemailUrl":{},"callingCapabilityToken":{"type":"string","example":""},"isOwner":{"type":"boolean","example":true,"default":true},"unreadConversationCount":{"type":"integer","example":0,"default":0},"notifyBy":{"type":"string","example":"Email only"},"features":{"type":"array","items":{"type":"string","example":"action-plans-smtp"}}}}}}}},"deprecated":false}},"/calls":{"get":{"summary":"/calls","description":"Search for calls.","operationId":"calls-get","parameters":[{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip before starting to return results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"personId","in":"query","description":"Filter calls by a person ID.","schema":{"type":"integer","format":"int32"}},{"name":"phone","in":"query","description":"Filter calls based on the phone number of a specific person or lead. This will finds calls regardless of whether they were incoming or outgoing.","schema":{"type":"string"}},{"name":"toNumber","in":"query","description":"Filter calls based on the number that the call was to.","schema":{"type":"string"}},{"name":"fromNumber","in":"query","description":"Filter calls based on the number that the call was from.","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"calls\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 5\n  },\n  \"calls\": [\n    {\n      \"id\": 18,\n      \"created\": \"2014-06-20T23:28:51Z\",\n      \"updated\": \"2014-08-12T17:24:22Z\",\n      \"createdById\": 4,\n      \"updatedById\": 4,\n      \"phone\": \"555-405-0815\",\n      \"personId\": 12254,\n      \"userId\": 4,\n      \"userName\": \"Agent White\",\n      \"note\": \"A note about the call\",\n      \"outcome\": \"Left Message\",\n      \"isIncoming\": false,\n      \"duration\": 63,\n      \"ringDuration\": 5,\n      \"recordingUrl:\": \"Content is hidden for privacy reasons.\"\n    },\n    ...\n  ]\n}"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"post":{"summary":"/calls","description":"Add a call.","operationId":"calls-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["personId","phone","isIncoming"],"properties":{"personId":{"type":"integer","description":"The ID of a person associated with this call.","format":"int32"},"phone":{"type":"string","description":"The phone number this call was made to or from."},"isIncoming":{"type":"boolean","description":"Sets this as an incoming or outgoing call."},"note":{"type":"string","description":"The log message entered for this call."},"outcome":{"type":"string","description":"The outcome of the call, which can be one of `Interested`, `Not Interested`, `Left Message`, `No Answer`, `Busy` or `Bad Number`."},"duration":{"type":"integer","description":"Length of the call in seconds.","format":"int32"},"toNumber":{"type":"string","description":"The phone number this call was made to."},"fromNumber":{"type":"string","description":"The phone number this call was made from."},"userId":{"type":"integer","description":"The ID of the user that made or received a call. (This can only be set by administrators, otherwise the currently logged in user's ID is used.)","format":"int32"},"recordingUrl":{"type":"string","description":"The URL for the call recording."}}},"examples":{"JSON Example":{"value":{"phone":"555-405-0815","personId":12254,"note":"John didn't have time to talk, call back on friday","outcome":"Interested","isIncoming":0,"duration":63}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/actionPlansPeople/{id}":{"put":{"summary":"/actionPlansPeople/:id","description":"Update the status of an Action Plan to Person relationship.","operationId":"actionplanspeople-id-put","parameters":[{"name":"id","in":"path","description":"The ID of the Action Plan People object.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"The desired state of the applied action plan. Either `Running` or `Paused`."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/calls/{id}":{"get":{"summary":"/calls/:id","description":"Retrieve a call by id.","operationId":"calls-id-get","parameters":[{"name":"id","in":"path","description":"The ID of a call.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 18,\n  \"created\": \"2014-06-20T23:28:51Z\",\n  \"updated\": \"2014-08-12T17:24:22Z\",\n  \"createdById\": 4,\n  \"updatedById\": 4,\n  \"phone\": \"555-405-0815\",\n  \"personId\": 12254,\n  \"userId\": 4,\n  \"userName\": \"Agent White\",\n  \"note\": \"A note about the call\",\n  \"outcome\": \"Left Message\",\n  \"isIncoming\": false,\n  \"duration\": 63,\n  \"ringDuration\": 5,\n  \"recordingUrl\": \"Content is hidden for privacy reasons.\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":18,"default":0},"created":{"type":"string","example":"2014-06-20T23:28:51Z"},"updated":{"type":"string","example":"2014-08-12T17:24:22Z"},"createdById":{"type":"integer","example":4,"default":0},"updatedById":{"type":"integer","example":4,"default":0},"phone":{"type":"string","example":"555-405-0815"},"personId":{"type":"integer","example":12254,"default":0},"userId":{"type":"integer","example":4,"default":0},"userName":{"type":"string","example":"Agent White"},"note":{"type":"string","example":"A note about the call"},"outcome":{"type":"string","example":"Left Message"},"isIncoming":{"type":"boolean","example":false,"default":true},"duration":{"type":"integer","example":63,"default":0},"ringDuration":{"type":"integer","example":5,"default":0},"recordingUrl":{"type":"string","example":"Content is hidden for privacy reasons."}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"put":{"summary":"/calls/:id","description":"Update a call.","operationId":"calls-id-put","parameters":[{"name":"id","in":"path","description":"The ID of a call.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"integer","description":"The ID of a person associated with this call.","format":"int32"},"phone":{"type":"string","description":"The phone number this call was made to or from."},"isIncoming":{"type":"boolean","description":"Sets this as an incoming or outgoing call."},"note":{"type":"string","description":"The log message entered for this call."},"outcome":{"type":"string","description":"The outcome of the call, which can be one of `Interested`, `Not Interested`, `Left Message`, `No Answer`, `Busy` or `Bad Number`."},"duration":{"type":"integer","description":"Length of the call in seconds.","format":"int32"},"toNumber":{"type":"string","description":"The phone number this call was made to."},"fromNumber":{"type":"string","description":"The phone number this call was made from."},"userId":{"type":"integer","description":"The ID of the user that made or received a call. (This can only be set by administrators, otherwise the currently logged in user's ID is used.)","format":"int32"},"recordingUrl":{"type":"string","description":"The URL for the call recording."}}},"examples":{"JSON Example":{"value":{"phone":"555-405-0815","personId":12254,"note":"John didn't have time to talk, call back on friday","outcome":"Interested","isIncoming":0,"duration":63}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/actionPlansPeople":{"get":{"summary":"/actionPlansPeople","description":"List Action Plans applied to a particular person or list people on a particular Action Plan.","operationId":"actionplanspeople-get","parameters":[{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip before starting to return results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"personId","in":"query","description":"List Action Plans applied to a specified person.","schema":{"type":"integer","format":"int32"}},{"name":"actionPlanId","in":"query","description":"List People on the specified Action Plan.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"actionPlansPeople\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 2\n  },\n  \"actionPlansPeople\": [\n    {\n      \"id\": 2,\n      \"created\": \"2014-08-19T18:31:43Z\",\n      \"updated\": \"2014-08-19T18:31:43Z\",\n      \"personId\": 10810,\n      \"actionPlanId\": 2,\n      \"status\": \"Running\"\n    },\n    ...\n  ]\n}\n  "}}}}}},"deprecated":false},"post":{"summary":"/actionPlansPeople","description":"Apply an Action Plan to a person.","operationId":"actionplanspeople-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["personId","actionPlanId"],"properties":{"personId":{"type":"integer","description":"The ID of the person to whom you would like to apply the action plan.","format":"int32"},"actionPlanId":{"type":"integer","description":"The ID of the action plan to apply","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/emEvents":{"get":{"summary":"/emEvents","description":"List email marketing events.","operationId":"emevents-get","parameters":[{"name":"type","in":"query","description":"Find email marketing events based on type. Options include `delivered`, `open`, `click`, `bounced`, `soft-bounce`, `hard-bounce`, `unsubscribe`, `spamreport` and `dropped`.","schema":{"type":"string"}},{"name":"personId","in":"query","description":"Find email marketing events by person ID.","schema":{"type":"integer","format":"int32"}},{"name":"updatedAfter","in":"query","description":"Find email marketing events that have been created or updated after the specified time.","schema":{"type":"string","format":"date-time"}},{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip before starting to return results.","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"emEvents\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 102938\n  },\n  \"emEvents\": [\n    {\n      \"count\": 2,\n      \"type\": \"open\",\n      \"personId\": 10911,\n      \"campaignId\": 102,\n      \"campaignName\": \"Can I help\",\n      \"created\": \"2017-01-03T19:20:49Z\",\n      \"updated\": \"2017-01-03T19:20:49Z\"\n    },\n    ...\n  ]\n}"}}}}}},"deprecated":false},"post":{"summary":"/emEvents","description":"Notify Follow Up Boss about marketing emails sent, opens, clicks, bounces, unsubscribes and spam reports.","operationId":"emevents-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"emEvents":{"type":"array","description":"Array of email marketing events in the following format: [{\"type\": \"delivered\", \"occurred\": \"2017-04-09T16:10:59Z\", \"recipient\": \"john.smith@gmail.com\", \"personId\" : 1, \"campaignId\": 141, \"userId\": 3}, ...]","items":{"properties":{"type":{"type":"string","description":"Type of event. Options include `delivered`, `open`, `click`, `bounced`, `soft-bounce`, `hard-bounce`, `unsubscribe`, `spamreport` and `dropped`."},"occurred":{"type":"string","description":"Date/time of the event.","format":"date"},"recipient":{"type":"string","description":"Email address of the recipient."},"personId":{"type":"integer","description":"ID of the recipient.","format":"int32"},"campaignId":{"type":"string","description":"ID of the campaign."},"userId":{"type":"integer","description":"Follow Up Boss ID of the user that email was sent from.","format":"int32"},"url":{"type":"string","description":"URL for the campaign."}},"type":"object"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"emEventIds\": [\n        193928,\n        193929,\n        ...\n    ]\n    \"recipientsNotFound\": [\n        \"email.not.in.fub@example.com\",\n        \"another.missing.email@example.com\"\n    ]\n}"}}}}}},"deprecated":false}},"/stages":{"get":{"summary":"/stages","description":"Retrieve a list of stages.","operationId":"stages-get","parameters":[{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip before starting to return results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"sort","in":"query","description":"Sorts the stages by `orderWeight`, `id` or `name`.","schema":{"type":"string","default":"orderWeight"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"stages\",\n    \"offset\": 0,\n    \"limit\": 20,\n    \"total\": 8\n  },\n  \"stages\": [\n    {\n      \"id\": 1,\n      \"name\": \"Contact\",\n      \"orderWeight\": 1000,\n      \"isProtected\": false,\n      \"peopleCount\": 16\n    },\n    {\n      \"id\": 5,\n      \"name\": \"Buyer\",\n      \"orderWeight\": 2000,\n      \"isProtected\": false,\n      \"peopleCount\": 40\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Lead\",\n      \"orderWeight\": 3000,\n      \"isProtected\": true,\n      \"peopleCount\": 12077\n    },\n    {\n      \"id\": 4,\n      \"name\": \"Nurture\",\n      \"orderWeight\": 4000,\n      \"isProtected\": false,\n      \"peopleCount\": 66\n    },\n    {\n      \"id\": 8,\n      \"name\": \"Closed\",\n      \"orderWeight\": 5000,\n      \"isProtected\": true,\n      \"peopleCount\": 15\n    },\n    {\n      \"id\": 9,\n      \"name\": \"Past Client\",\n      \"orderWeight\": 6000,\n      \"isProtected\": false,\n      \"peopleCount\": 98\n    },\n    {\n      \"id\": 10,\n      \"name\": \"Sphere\",\n      \"orderWeight\": 7000,\n      \"isProtected\": false,\n      \"peopleCount\": 17\n    },\n    {\n      \"id\": 11,\n      \"name\": \"Trash\",\n      \"orderWeight\": 8000,\n      \"isProtected\": true,\n      \"peopleCount\": 892\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"_metadata":{"type":"object","properties":{"collection":{"type":"string","example":"stages"},"offset":{"type":"integer","example":0,"default":0},"limit":{"type":"integer","example":20,"default":0},"total":{"type":"integer","example":8,"default":0}}},"stages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"Contact"},"orderWeight":{"type":"integer","example":1000,"default":0},"isProtected":{"type":"boolean","example":false,"default":true},"peopleCount":{"type":"integer","example":16,"default":0}}}}}}}}}},"deprecated":false},"post":{"summary":"/stages","description":"Create a new stage.","operationId":"stages-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the stage."},"orderWeight":{"type":"integer","description":"Set this value to enforce a specific sort order.","default":1000,"format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 7,\n  \"name\": \"Pending\",\n  \"orderWeight\": 7000,\n  \"isProtected\": false,\n  \"peopleCount\": 10\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":7,"default":0},"name":{"type":"string","example":"Pending"},"orderWeight":{"type":"integer","example":7000,"default":0},"isProtected":{"type":"boolean","example":false,"default":true},"peopleCount":{"type":"integer","example":10,"default":0}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/stages/{id}":{"put":{"summary":"/stages/:id","description":"Update a stage.","operationId":"stages-id-put","parameters":[{"name":"id","in":"path","description":"The id of the stage to update.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the stage"},"orderWeight":{"type":"integer","description":"Helps to set a specific sort order.","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 7,\n  \"name\": \"Pending\",\n  \"orderWeight\": 7000,\n  \"isProtected\": false,\n  \"peopleCount\": 10\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":7,"default":0},"name":{"type":"string","example":"Pending"},"orderWeight":{"type":"integer","example":7000,"default":0},"isProtected":{"type":"boolean","example":false,"default":true},"peopleCount":{"type":"integer","example":10,"default":0}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"get":{"summary":"/stages/:id","description":"Get a stage by id.","operationId":"stages-id-get","parameters":[{"name":"id","in":"path","description":"The id of the stage to retrieve.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 7,\n  \"name\": \"Pending\",\n  \"orderWeight\": 7000,\n  \"isProtected\": false,\n  \"peopleCount\": 10\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":7,"default":0},"name":{"type":"string","example":"Pending"},"orderWeight":{"type":"integer","example":7000,"default":0},"isProtected":{"type":"boolean","example":false,"default":true},"peopleCount":{"type":"integer","example":10,"default":0}}}}}}},"deprecated":false},"delete":{"summary":"/stages/:id","description":"Delete a stage.","operationId":"stage-id-delete","parameters":[{"name":"id","in":"path","description":"The id of the stage to delete.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"assignStageId","in":"query","description":"The stage id to assign to action plans referencing the deleted stage.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/webhooks/{id}":{"delete":{"summary":"/webhooks/:id","description":"Delete a webhook.","operationId":"webhooks-id-delete","parameters":[{"name":"id","in":"path","description":"The ID of the webhook.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"X-System","in":"header","description":"The name of the registered system.","required":true,"schema":{"type":"string"}},{"name":"X-System-Key","in":"header","description":"The key of the registered system.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":""}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"put":{"summary":"/webhooks/:id","description":"Update a webhook.","operationId":"webhooks-id-put","parameters":[{"name":"X-System","in":"header","description":"The name of the registered system.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The id of the webhook.","schema":{"type":"integer","format":"int32"},"required":true},{"name":"X-System-Key","in":"header","description":"The key of the registered system.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"event":{"type":"string","description":"The event the webook responds to. Should be one of the following: `peopleCreated`, `peopleUpdated`, `peopleDeleted`, `notesCreated`, `notesUpdated`, `notesDeleted`, `emEventsOpened`, `emEventsClicked`, `emEventsUnsubscribed`, `tasksCreated`, `tasksUpdated`, `tasksDeleted`, `appointmentsCreated`, `appointmentsUpdated`, `appointmentsDeleted`, `textMessagesCreated`, `textMessagesUpdated`, `textMessagesDeleted`, `callsCreated`, `callsUpdated`, `callsDeleted`, `emailsCreated`, `emailsUpdated`, `emailsDeleted` or `eventsCreated`","enum":["peopleCreated","peopleUpdated","peopleDeleted","peopleTagsCreated","peopleStageUpdated","peopleRelationshipCreated","peopleRelationshipUpdated","peopleRelationshipDeleted","notesCreated","notesUpdated","notesDeleted","emEventsOpened","emEventsClicked","emEventsUnsubscribed","tasksCreated","tasksUpdated","tasksDeleted","appointmentsCreated","appointmentsUpdated","appointmentsDeleted","textMessagesCreated","textMessagesUpdated","textMessagesDeleted","callsCreated","callsUpdated","callsDeleted","dealsCreated","dealsUpdated","dealsDeleted","emailsCreated","emailsUpdated","emailsDeleted","eventsCreated"]},"url":{"type":"string","description":"The url of the webhook. Must be a secure endpoint (https)."},"status":{"type":"string","description":"The status of the webhook. Can be `Active` or `Disabled`","enum":["Active","Disabled"]}}},"examples":{"Request Example":{"value":{"status":"Disabled","event":"peopleCreated","url":"https://acmeLeadProvider.com/callbacks/followupboss/peopleCreated"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 1004,\n  \"status\": \"Disabled\",\n  \"event\": \"peopleCreated\",\n  \"url\": \"https://acmeLeadProvider.com/callbacks/followupboss/peopleCreated\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":1004,"default":0},"status":{"type":"string","example":"Disabled"},"event":{"type":"string","example":"peopleCreated"},"url":{"type":"string","example":"https://acmeLeadProvider.com/callbacks/followupboss/peopleCreated"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"get":{"summary":"/webhooks/:id","description":"Get details of a specific webhook.","operationId":"webhooks-id-get","parameters":[{"name":"id","in":"path","description":"The ID of the webhook.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"X-System","in":"header","description":"The name of the registered system.","required":true,"schema":{"type":"string"}},{"name":"X-System-Key","in":"header","description":"The key of the registered system.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"id\": 1004,\n  \"status\": \"Active\",\n  \"event\": \"peopleCreated\",\n  \"url\": \"https://acmeLeadProvider.com/callbacks/followupboss/peopleCreated\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":1004,"default":0},"status":{"type":"string","example":"Active"},"event":{"type":"string","example":"peopleCreated"},"url":{"type":"string","example":"https://acmeLeadProvider.com/callbacks/followupboss/peopleCreated"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/webhooks":{"get":{"summary":"/webhooks","description":"Get a list of webhooks.","operationId":"webhooks-get","parameters":[{"name":"sort","in":"query","description":"The sort order. Can be one of the following: `id`, `created`, `updated`, `status` or `event`.","schema":{"type":"string","default":"created"}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip before starting to return results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}},{"name":"event","in":"query","description":"Search for webhooks by event. (e.g., `peopleCreated` or `peopleUpdated`)","schema":{"type":"string"}},{"name":"status","in":"query","description":"Search for webhooks by status. Status can be `Active` or `Disabled`.","schema":{"type":"string","enum":["Active","Disabled"]}},{"name":"X-System","in":"header","description":"The name of the registered system.","required":true,"schema":{"type":"string"}},{"name":"X-System-Key","in":"header","description":"The key of the registered system.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"webhooks\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 3\n  },\n  \"webhooks\": [\n    {\n      \"id\": 1001,\n      \"event\": \"peopleCreated\",\n      \"status\": \"Active\",\n      \"url\": \"https://acmeLeadProvider.com/callbacks/peopleCreated\"\n    },\n    {\n      \"id\": 1002,\n      \"event\": \"peopleUpdated\",\n      \"status\": \"Active\",\n      \"url\": \"https://acmeLeadProvider.com/callbacks/peopleUpdated\"\n    },\n    {\n      \"id\": 1003,\n      \"event\": \"peopleDeleted\",\n      \"status\": \"Active\",\n      \"url\": \"https://acmeLeadProvider.com/callbacks/peopleDeleted\"\n    },\n  ]\n}"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"post":{"summary":"/webhooks","description":"Subscribe to a new webhook.","operationId":"webhooks-post","parameters":[{"name":"X-System","in":"header","description":"The name of the registered system.","required":true,"schema":{"type":"string"}},{"name":"X-System-Key","in":"header","description":"The key of the registered system.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["event","url"],"properties":{"event":{"type":"string","description":"The event the webook responds to. This should be one of the following: `peopleCreated`, `peopleUpdated`, `peopleDeleted`, `peopleTagsCreated`, `peopleStageUpdated`, `peopleRelationshipCreated`,`peopleRelationshipUpdated`,`peopleRelationshipDeleted`, `notesCreated`, `notesUpdated`, `notesDeleted`, `emEventsOpened`, `emEventsClicked`, `emEventsUnsubscribed`, `tasksCreated`, `tasksUpdated`, `tasksDeleted`, `appointmentsCreated`, `appointmentsUpdated`, `appointmentsDeleted`, `textMessagesCreated`, `textMessagesUpdated`, `textMessagesDeleted`, `callsCreated`, `callsUpdated`, `callsDeleted`,  `dealsCreated`, `dealsUpdated`, `dealsDeleted`, `emailsCreated`, `emailsUpdated`, `emailsDeleted`, `eventsCreated`, `stageCreated`, `stageUpdated`, or `stageDeleted`","enum":["peopleCreated","peopleUpdated","peopleDeleted","peopleTagsCreated","peopleStageUpdated","peopleRelationshipCreated","peopleRelationshipUpdated","peopleRelationshipDeleted","notesCreated","notesUpdated","notesDeleted","emEventsOpened","emEventsClicked","emEventsUnsubscribed","tasksCreated","tasksUpdated","tasksDeleted","appointmentsCreated","appointmentsUpdated","appointmentsDeleted","textMessagesCreated","textMessagesUpdated","textMessagesDeleted","callsCreated","callsUpdated","callsDeleted","dealsCreated","dealsUpdated","dealsDeleted","emailsCreated","emailsUpdated","emailsDeleted","eventsCreated","stageCreated","stageUpdated","stageDeleted"]},"url":{"type":"string","description":"The url of the webhook. Must be a secure endpoint (https)."}}},"examples":{"Request Example":{"value":{"event":"peopleCreated","url":"https://acmeLeadProvider.com/callbacks/followupboss/peopleCreated"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 1004,\n  \"status\": \"Active\",\n\t\"event\": \"peopleCreated\",\n  \"url\": \"https://acmeLeadProvider.com/callbacks/followupboss/peopleCreated\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":1004,"default":0},"status":{"type":"string","example":"Active"},"event":{"type":"string","example":"peopleCreated"},"url":{"type":"string","example":"https://acmeLeadProvider.com/callbacks/followupboss/peopleCreated"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/webhookEvents/:id":{"get":{"summary":"/webhookEvents/:id","description":"Get a list of events for a given webhook.","operationId":"webhookevents-get","parameters":[{"name":"X-System","in":"header","description":"The name of the registered system.","required":true,"schema":{"type":"string"}},{"name":"X-System-Key","in":"header","description":"The key of the registered system.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": \"db36048a6b06d80e7f9d3440233ae915\",\n  \"eventCreated\": \"2016-12-12T18:36:26Z\",\n  \"event\": \"peopleUpdated\",\n  \"resourceIds\": [1234,3422,4343],\n  \"uri\": \"https://api.followupboss.com/v1/people?id=1234,3422,4343\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"db36048a6b06d80e7f9d3440233ae915"},"eventCreated":{"type":"string","example":"2016-12-12T18:36:26Z"},"event":{"type":"string","example":"peopleUpdated"},"resourceIds":{"type":"array","items":{"type":"integer","example":1234,"default":0}},"uri":{"type":"string","example":"https://api.followupboss.com/v1/people?id=1234,3422,4343"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/tasks":{"get":{"summary":"/tasks","description":"Get a list of tasks.","operationId":"tasks-get","parameters":[{"name":"personId","in":"query","description":"Find tasks by a person's id.","schema":{"type":"integer","format":"int32"}},{"name":"assignedTo","in":"query","description":"Find tasks assigned to a specific user using their full name.","schema":{"type":"string"}},{"name":"assignedUserId","in":"query","description":"Find tasks assigned to a specific user by id.","schema":{"type":"integer","format":"int32"}},{"name":"name","in":"query","description":"Find tasks where the name is like what you pass in. (e.g., \"world\" would find a task named \"hello world\")","schema":{"type":"string"}},{"name":"type","in":"query","description":"Find tasks by the following types: `Follow Up`, `Call`, `Email`, `Text`, `Appointment`, `Showing`, `Closing`, `Open House` or `Thank You`. (Note: A comma separated list of types is accepted.)","schema":{"type":"string"}},{"name":"isCompleted","in":"query","description":"Find tasks that have been completed or not completed.","schema":{"type":"boolean"}},{"name":"due","in":"query","description":"Find tasks that fall into the following ranges: `today`, `overdue` and `upcoming`.","schema":{"type":"string"}},{"name":"dueStart","in":"query","description":"Finds tasks that are due from this time forward.","schema":{"type":"string","format":"date-time"}},{"name":"dueEnd","in":"query","description":"Find tasks that are due from this time and before.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"tasks\",\n    \"offset\": 0,\n    \"limit\": 1,\n    \"total\": 126\n  },\n  \"tasks\": [\n    {\n      \"id\": 4066,\n      \"created\": \"2016-12-07T15:50:47Z\",\n      \"updated\": \"2016-12-07T15:50:47Z\",\n      \"completed\": \"2017-01-24T17:20:49Z\",\n      \"createdBy\": \"Gerald Leenerts\",\n      \"updatedBy\": \"Gerald Leenerts\",\n      \"personId\": 15013,\n      \"AssignedTo\": \"Gerald Leenerts\",\n      \"assignedUserId\": 1,\n      \"name\": \"Follow Up\",\n      \"type\": \"Follow Up\",\n      \"isCompleted\": 1,\n      \"dueDate\": \"2017-01-31\",\n      \"dueDateTime\": \"2017-01-31T21:00:00Z\",\n      \"externalTaskLink\": null,\n      \"externalCalendarId\": null,\n      \"remindSecondsBefore\": null,\n   \t},\n  ]\n}"}}}}}},"deprecated":false},"post":{"summary":"/tasks","description":"Create a new task.","operationId":"tasks-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["personId"],"properties":{"personId":{"type":"integer","description":"The id of the person this task is related to.","format":"int32"},"assignedTo":{"type":"string","description":"The full name of the agent to assign this task. (Note: This is required if `assignedUserId` is empty.)"},"assignedUserId":{"type":"integer","description":"The id of the user to assign to this task. (Note: This is required if `assignedTo` is empty.)","format":"int32"},"name":{"type":"string","description":"The name of the task."},"type":{"type":"string","description":"Type can be one of the following: `Follow Up`, `Call`, `Text`, `Email`, `Appointment`, `Showing`, `Closing`, `Open House` or `Thank You`","enum":["Follow Up","Call","Text","Email","Appointment","Showing","Closing","Open House","Thank You"]},"isCompleted":{"type":"boolean","description":"Sets whether the task is completed or not."},"dueDate":{"type":"string","description":"Due date for this task in YYYY-MM-DD format.","format":"date"},"dueDateTime":{"type":"string","description":"Due date for this task with a time included that also supports timezone suffixes. (e.g., 2004-11-16T03:00:00 -05:00)","format":"date"},"remindSecondsBefore":{"type":"integer","description":"Set a reminder for the task to be sent via email and desktop notification. This is only available for tasks with a due time set.","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 4066,\n  \"created\": \"2016-12-07T15:50:47Z\",\n  \"updated\": \"2016-12-07T15:50:47Z\",\n  \"createdBy\": \"Gerald Leenerts\",\n  \"updatedBy\": \"Gerald Leenerts\",\n  \"personId\": 15013,\n  \"AssignedTo\": \"Gerald Leenerts\",\n  \"assignedUserId\": 1,\n  \"name\": \"Follow Up\",\n  \"type\": \"Follow Up\",\n  \"isCompleted\": 0,\n  \"dueDate\": null,\n  \"dueDateTime\": null,\n  \"completed\": null,\n  \"person\": {\n    \"id\": 15013,\n    \"name\": \"William Riker\"\n  }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":4066,"default":0},"created":{"type":"string","example":"2016-12-07T15:50:47Z"},"updated":{"type":"string","example":"2016-12-07T15:50:47Z"},"createdBy":{"type":"string","example":"Gerald Leenerts"},"updatedBy":{"type":"string","example":"Gerald Leenerts"},"personId":{"type":"integer","example":15013,"default":0},"AssignedTo":{"type":"string","example":"Gerald Leenerts"},"assignedUserId":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"Follow Up"},"type":{"type":"string","example":"Follow Up"},"isCompleted":{"type":"integer","example":0,"default":0},"dueDate":{},"dueDateTime":{},"completed":{},"person":{"type":"object","properties":{"id":{"type":"integer","example":15013,"default":0},"name":{"type":"string","example":"William Riker"}}}}}}}}},"deprecated":false}},"/tasks/{id}":{"put":{"summary":"/tasks/:id","description":"Update a task.","operationId":"tasks-id-put","parameters":[{"name":"id","in":"path","description":"The id of the task to update.","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"integer","description":"The id of the person this task is related to.","format":"int32"},"assignedTo":{"type":"string","description":"The full name of the agent to assign to this task."},"assignedUserId":{"type":"integer","description":"The id of the user to assign to this task.","format":"int32"},"name":{"type":"string","description":"The name of the task."},"type":{"type":"string","description":"Type can be one of the following: `Follow Up`, `Call`, `Email`, `Appointment`, `Showing`, `Closing`, `Open House` or `Thank You`","enum":["Follow Up","Call","Text","Email","Appointment","Showing","Closing","Open House","Thank You"]},"isCompleted":{"type":"boolean","description":"Sets whether the task is completed or not."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 4066,\n  \"created\": \"2016-12-07T15:50:47Z\",\n  \"updated\": \"2016-12-07T15:50:47Z\",\n  \"completed:\" null,\n  \"createdBy\": \"Gerald Leenerts\",\n  \"updatedBy\": \"Gerald Leenerts\",\n  \"personId\": 15013,\n  \"AssignedTo\": \"Gerald Leenerts\",\n  \"assignedUserId\": 1,\n  \"name\": \"Follow Up\",\n  \"type\": \"Follow Up\",\n  \"isCompleted\": 0,\n  \"dueDate\": null,\n  \"dueDateTime\": null,\n  \"person\": {\n    \"id\": 15013,\n    \"name\": \"William Riker\"\n  }\n}"}}}}}},"deprecated":false},"get":{"summary":"/tasks/:id","description":"Get a task by id.","operationId":"tasks-id-get","parameters":[{"name":"id","in":"path","description":"The ID of the task to get.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 4066,\n  \"created\": \"2016-12-07T15:50:47Z\",\n  \"updated\": \"2016-12-07T15:50:47Z\",\n  \"completed\": null,\n  \"createdBy\": \"Gerald Leenerts\",\n  \"updatedBy\": \"Gerald Leenerts\",\n  \"personId\": 15013,\n  \"AssignedTo\": \"Gerald Leenerts\",\n  \"assignedUserId\": 1,\n  \"name\": \"Follow Up\",\n  \"type\": \"Follow Up\",\n  \"isCompleted\": 0,\n  \"dueDate\": null,\n  \"dueDateTime\": null,\n  \"person\": {\n    \"id\": 15013,\n    \"name\": \"William Riker\"\n  }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":4066,"default":0},"created":{"type":"string","example":"2016-12-07T15:50:47Z"},"updated":{"type":"string","example":"2016-12-07T15:50:47Z"},"completed":{},"createdBy":{"type":"string","example":"Gerald Leenerts"},"updatedBy":{"type":"string","example":"Gerald Leenerts"},"personId":{"type":"integer","example":15013,"default":0},"AssignedTo":{"type":"string","example":"Gerald Leenerts"},"assignedUserId":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"Follow Up"},"type":{"type":"string","example":"Follow Up"},"isCompleted":{"type":"integer","example":0,"default":0},"dueDate":{},"dueDateTime":{},"person":{"type":"object","properties":{"id":{"type":"integer","example":15013,"default":0},"name":{"type":"string","example":"William Riker"}}}}}}}}},"deprecated":false},"delete":{"summary":"/tasks/:id","description":"Delete a task.","operationId":"tasks-id-delete","parameters":[{"name":"id","in":"path","description":"The id of the task to delete.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/emCampaigns":{"get":{"summary":"/emCampaigns","description":"List email marketing campaigns.","operationId":"emcampaigns-get","parameters":[{"name":"origin","in":"query","description":"Search for campaigns from a specific origin.","schema":{"type":"string"}},{"name":"originId","in":"query","description":"Search for campaigns with a specific ID from the originating system.","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"emCampaigns\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 97\n  },\n  \"emCampaigns\": [\n    {\n      \"id\": 102,\n      \"origin\": \"Curaytor\",\n      \"originId\": \"912\",\n      \"name\": \"Can I help\",\n      \"subject\": \"Can I help?\",\n      \"bodyHtml\": \"I saw you're browsing our website, can I help with...\"\n    },\n    ...\n  ]\n}"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"post":{"summary":"/emCampaigns","description":"Create an email marketing campaign.","operationId":"emcampaigns-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"origin":{"type":"string","description":"Name of the email marketing system where this campaign originated from."},"originId":{"type":"string","description":"Internal ID of the new campaign or email in the origin system."},"name":{"type":"string","description":"Name of the email campaign or template."},"subject":{"type":"string","description":"Email subject line."},"bodyHtml":{"type":"string","description":"Email body in HTML."}}},"examples":{"Request Example":{"value":{"origin":"Curaytor","originId":"912","name":"Can I help","subject":"Can I help?","bodyHtml":"I saw you're browsing our website, can I help with..."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 102,\n    \"origin\": \"Curaytor\",\n    \"originId\": \"912\",\n    \"name\": \"Can I help\",\n    \"subject\": \"Can I help?\",\n    \"bodyHtml\": \"I saw you're browsing our website, can I help with...\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":102,"default":0},"origin":{"type":"string","example":"Curaytor"},"originId":{"type":"string","example":"912"},"name":{"type":"string","example":"Can I help"},"subject":{"type":"string","example":"Can I help?"},"bodyHtml":{"type":"string","example":"I saw you're browsing our website, can I help with..."}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/emCampaigns/{id}":{"put":{"summary":"/emCampaigns/:id","description":"Update an email marketing campaign.","operationId":"emcampaigns-id-put","parameters":[{"name":"id","in":"path","description":"Follow Up Boss ID of the email campaign.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the email campaign or template."},"subject":{"type":"string","description":"Email subject line."},"bodyHtml":{"type":"string","description":"Email body in HTML."}}},"examples":{"Request Example":{"value":{"name":"How can I help","subject":"How can I help?","bodyHtml":"I saw you're browsing our website, how can I help with..."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 102,\n    \"origin\": \"Curaytor\",\n    \"originId\": \"912\",\n    \"name\": \"How can I help\",\n    \"subject\": \"How can I help?\",\n    \"bodyHtml\": \"I saw you're browsing our website, how can I help with...\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":102,"default":0},"origin":{"type":"string","example":"Curaytor"},"originId":{"type":"string","example":"912"},"name":{"type":"string","example":"How can I help"},"subject":{"type":"string","example":"How can I help?"},"bodyHtml":{"type":"string","example":"I saw you're browsing our website, how can I help with..."}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/deals/{id}":{"get":{"summary":"/deals/:id","description":"Retrieve a deal by id.","operationId":"deals-id-get","parameters":[{"name":"id","in":"path","description":"The id of the deal.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n      \"pipelineId\": 100,\n      \"stageId\": 16,\n      \"enteredStageAt\": \"2017-04-14T18:31:20Z\",\n      \"id\": 2146,\n      \"name\": \"adding deal\",\n      \"type\": 0,\n      \"status\": \"Active\",\n      \"price\": 216000,\n      \"createdAt\": \"2017-04-14T18:31:19Z\",\n      \"orderWeight\": 6000,\n      \"description\": \"A deal for an example\",\n      \"projectedCloseDate\": null,\n      \"people\": [\n        {\n          \"id\": 10,\n          \"name\": \"Yolanda Smith\",\n          \"avatar\": \"\"\n        }\n      ],\n      \"users\": [\n    \t\t{\n     \t\t \t\"id\": 1,\n      \t\t\"name\": \"John Smith\"\n    \t\t}\n  \t\t],\n      \"customField1\": \"A sample custom field.\",\n      \"customField2\": \"2021-04-01T18:48:19Z\",\n      \"customField3\": 3,\n      \"customField4\": \"A sample dropdown selection.\",\n  \t\t\"agentCommission\": 50,\n  \t\t\"teamCommission\": 50\n    }"}},"schema":{"type":"object","properties":{"pipelineId":{"type":"integer","example":100,"default":0},"stageId":{"type":"integer","example":16,"default":0},"enteredStageAt":{"type":"string","example":"2017-04-14T18:31:20Z"},"id":{"type":"integer","example":2146,"default":0},"name":{"type":"string","example":"adding deal"},"type":{"type":"integer","example":0,"default":0},"status":{"type":"string","example":"Active"},"price":{"type":"integer","example":216000,"default":0},"createdAt":{"type":"string","example":"2017-04-14T18:31:19Z"},"orderWeight":{"type":"integer","example":6000,"default":0},"description":{"type":"string","example":"A deal for an example"},"projectedCloseDate":{},"people":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":10,"default":0},"name":{"type":"string","example":"Yolanda Smith"},"avatar":{"type":"string","example":""}}}},"users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"John Smith"}}}},"customField1":{"type":"string","example":"A sample custom field."},"customField2":{"type":"string","example":"2021-04-01T18:48:19Z"},"customField3":{"type":"integer","example":3,"default":0},"customField4":{"type":"string","example":"A sample dropdown selection."},"agentCommission":{"type":"integer","example":50,"default":0},"teamCommission":{"type":"integer","example":50,"default":0}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"/deals/:id","description":"Delete a deal.","operationId":"deals-id-delete","parameters":[{"name":"id","in":"path","description":"The id of the deal.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"put":{"summary":"/deals/:id","description":"Update a deal.","operationId":"deals-id-put","parameters":[{"name":"id","in":"path","description":"The id of the deal.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the deal."},"stageId":{"type":"integer","description":"The stage that this deal should be assigned to.","format":"int32"},"description":{"type":"string","description":"Description of the deal."},"peopleIds":{"type":"array","description":"A list of person ids that should be part of this deal.","items":{"type":"integer","format":"int32"}},"userIds":{"type":"array","description":"A list of user ids that should be part of this deal.","items":{"type":"integer","format":"int32"}},"price":{"type":"integer","description":"The price associated with this deal.","format":"int32"},"projectedCloseDate":{"type":"string","description":"Projected close date of this deal.","format":"date"},"commissionValue":{"type":"integer","description":"Commission value to assign to this deal.","format":"int32"},"agentCommision":{"type":"integer","description":"Commission value for an agent split.","format":"int32"},"teamComission":{"type":"integer","description":"Commission value for a team split.","format":"int32"},"earnestMoneyDueDate":{"type":"string","description":"Earnest Money Due Date for this deal.","format":"date"},"mutualAcceptanceDate":{"type":"string","description":"Mutual Acceptance Date for this deal.","format":"date"},"dueDiligenceDate":{"type":"string","description":"Due Diligence Date for this deal.","format":"date"},"finalWalkThroughDate":{"type":"string","description":"Final Walk Through Date for this deal.","format":"date"},"possessionDate":{"type":"string","description":"Possession Date for this deal.","format":"date"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"name\": \"New Deal\",\n\t\"stageId\": 2,\n  \"description\": \"The best deal\",\n  \"projectedCloseDate\": \"2001-01-02\",\n\t\"earnestMoneyDueDate\": \"2001-01-01T05:00:00.000Z\",\n  \"mutualAcceptanceDate\": \"2001-01-01T05:00:00.000Z\",\n  \"dueDiligenceDate\": \"2001-01-01T05:00:00.000Z\",\n  \"finalWalkThroughDate\": \"2001-01-01T05:00:00.000Z\",\n  \"possessionDate\": \"2001-01-01T05:00:00.000Z\",\n  \"price\": 30,\n  \"peopleIds\": [\n    2,\n    5,\n    6\n  ],\n  \"userIds\": [\n    208,\n    210\n  ],\n  \"customField1\": \"A sample custom field.\",\n  \"customField2\": \"2021-04-01T18:48:19Z\",\n  \"customField3\": 3,\n  \"customField4\": \"A sample dropdown selection.\",  \n  \"agentCommission\": 50,\n  \"teamCommission\": 50\n}"}},"schema":{"type":"object","properties":{"name":{"type":"string","example":"New Deal"},"stageId":{"type":"integer","example":2,"default":0},"description":{"type":"string","example":"The best deal"},"projectedCloseDate":{"type":"string","example":"2001-01-02"},"earnestMoneyDueDate":{"type":"string","example":"2001-01-01T05:00:00.000Z"},"mutualAcceptanceDate":{"type":"string","example":"2001-01-01T05:00:00.000Z"},"dueDiligenceDate":{"type":"string","example":"2001-01-01T05:00:00.000Z"},"finalWalkThroughDate":{"type":"string","example":"2001-01-01T05:00:00.000Z"},"possessionDate":{"type":"string","example":"2001-01-01T05:00:00.000Z"},"price":{"type":"integer","example":30,"default":0},"peopleIds":{"type":"array","items":{"type":"integer","example":2,"default":0}},"userIds":{"type":"array","items":{"type":"integer","example":208,"default":0}},"customField1":{"type":"string","example":"A sample custom field."},"customField2":{"type":"string","example":"2021-04-01T18:48:19Z"},"customField3":{"type":"integer","example":3,"default":0},"customField4":{"type":"string","example":"A sample dropdown selection."},"agentCommission":{"type":"integer","example":50,"default":0},"teamCommission":{"type":"integer","example":50,"default":0}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/pipelines/{id}":{"get":{"summary":"/pipelines/:id","description":"Retrieve a pipeline by id.","operationId":"pipelines-id-get","parameters":[{"name":"id","in":"path","description":"The id of the pipeline.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 1,\n  \"name\": \"Contact Pipeline\",\n  \"description\": \"A pipeline for contacts\",\n  \"orderWeight\": 1000,\n  \"stages\": [\n    {\n      \"id\": 1,\n      \"name\": \"Contact\",\n      \"description\": \"\",\n      \"orderWeight\": 3000,\n      \"color\": \"#FFFFFF\"\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Lead\",\n      \"description\": \"\",\n      \"orderWeight\": 4000,\n      \"color\": \"\"\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"Contact Pipeline"},"description":{"type":"string","example":"A pipeline for contacts"},"orderWeight":{"type":"integer","example":1000,"default":0},"stages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"Contact"},"description":{"type":"string","example":""},"orderWeight":{"type":"integer","example":3000,"default":0},"color":{"type":"string","example":"#FFFFFF"}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"/pipelines/:id","description":"Delete a pipeline.","operationId":"pipelines-id-delete","parameters":[{"name":"id","in":"path","description":"The id of the pipeline.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"put":{"summary":"/pipelines/:id","description":"Update a pipeline.","operationId":"pipelines-id-put","parameters":[{"name":"id","in":"path","description":"The id of the pipeline.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the pipeline."},"description":{"type":"string","description":"Description of the pipeline."},"stages":{"type":"array","description":"An array of stage objects that should be associated with the pipeline.","items":{"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"orderWeight":{"type":"integer","format":"int32"},"color":{"type":"string"},"closedStage":{"type":"boolean","default":false}},"required":["name","closedStage"],"type":"object"}},"orderWeight":{"type":"integer","description":"Set this value to enforce a specific sort order.","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"name\": \"Buyer pipeline\",\n  \"description\": \"A pipeline for buyers\",\n  \"orderWeight\": 1000,\n  \"stages\": [\n    {\n      \"id\": 17,\n      \"name\": \"First Stage\",\n      \"description\": \"\",\n      \"orderWeight\": 1000,\n      \"color\": \"#FFFFFF\",\n      \"closedStage\": false\n    },\n    {\n      \"id\": 18,\n      \"name\": \"Second Stage\",\n      \"description\": \"\",\n      \"orderWeight\": 2000,\n      \"color\": \"#000000\",\n      \"closedStage\": false\n    },\n    {\n      \"name\": \"Third Stage\",\n      \"description\": \"\",\n      \"orderWeight\": 3000,\n      \"color\": \"#FF00FF\",\n      \"closedStage\": true\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"name":{"type":"string","example":"Buyer pipeline"},"description":{"type":"string","example":"A pipeline for buyers"},"orderWeight":{"type":"integer","example":1000,"default":0},"stages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":17,"default":0},"name":{"type":"string","example":"First Stage"},"description":{"type":"string","example":""},"orderWeight":{"type":"integer","example":1000,"default":0},"color":{"type":"string","example":"#FFFFFF"},"closedStage":{"type":"boolean","example":false,"default":true}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/deals":{"get":{"summary":"/deals","description":"Search for deals.","operationId":"deals-get","parameters":[{"name":"pipelineId","in":"query","description":"Return deals for a specific pipeline only.","schema":{"type":"integer","format":"int32"}},{"name":"userId","in":"query","description":"Return a list of deals for a specific user.","schema":{"type":"integer","format":"int32"}},{"name":"personId","in":"query","description":"Return a list of deals for a specific person.","schema":{"type":"integer","format":"int32"}},{"name":"includeDeleted","in":"query","description":"Set to `1` to include deals with a status of `Deleted` in the results.","schema":{"type":"integer","format":"int32"}},{"name":"includeArchived","in":"query","description":"Set to `1` to include deals with a status of `Archived` in the results.","schema":{"type":"integer","format":"int32"}},{"name":"status","in":"query","description":"Only return deals with a status of `Active`, `Archived`, or `Deleted`.","schema":{"type":"string","enum":["Active","Archived","Deleted"]}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"deals\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 1,\n    \"totalByStageId\": {\n      \"5\": 1\n    }\n  },\n  \"deals\": [\n    {\n      \"pipelineId\": 100,\n      \"stageId\": 5,\n      \"enteredStageAt\": \"2017-04-14T18:31:20Z\",\n      \"id\": 2146,\n      \"name\": \"adding deal\",\n      \"type\": 0,\n      \"status\": \"Active\",\n      \"price\": 216000,\n      \"createdAt\": \"2017-04-14T18:31:19Z\",\n      \"orderWeight\": 6000,\n      \"description\": \"A deal for an example\",\n      \"projectedCloseDate\": null,\n      \"people\": [\n        {\n          \"id\": 10,\n          \"name\": \"Yolanda Smith\",\n          \"avatar\": \"\"\n        }\n      ],\n      \"users\": [\n        {\n          \"id\": 1,\n          \"name\": \"John Smith\"\n        }\n      ],\n      \"customField1\": \"A sample custom field.\",\n      \"customField2\": \"2021-04-01T18:48:19Z\",\n      \"customField3\": 3,\n      \"customField4\": \"A sample dropdown selection.\",\n      \"agentCommission\": 50,\n  \t\t\"teamCommission\": 50\n    },\n  ]\n}"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"post":{"summary":"/deals","description":"Add a deal.","operationId":"deals-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","stageId"],"properties":{"name":{"type":"string","description":"Name of the deal."},"stageId":{"type":"integer","description":"The stage that this deal should be assigned to.","format":"int32"},"description":{"type":"string","description":"Description of the deal."},"peopleIds":{"type":"array","description":"A list of person ids that should be part of this deal.","items":{"type":"integer","format":"int32"}},"userIds":{"type":"array","description":"A list of user ids that should be part of this deal.","items":{"type":"integer","format":"int32"}},"price":{"type":"integer","description":"The price associated with this deal.","format":"int32"},"projectedCloseDate":{"type":"string","description":"Projected close date of this deal.","format":"date"},"orderWeight":{"type":"integer","description":"Set this value to enforce a specific sort order.","format":"int32"},"commissionValue":{"type":"integer","description":"Commission value to assign to this deal.","format":"int32"},"agentCommission":{"type":"integer","description":"Commission split for the agent split.","format":"int32"},"teamCommission":{"type":"integer","description":"Commission split for the team split.","format":"int32"},"earnestMoneyDueDate":{"type":"string","description":"Earnest Money Due Date for this deal.","format":"date"},"mutualAcceptanceDate":{"type":"string","description":"Mutual Acceptance Date for this deal.","format":"date"},"dueDiligenceDate":{"type":"string","description":"Due Diligence Date for this deal.","format":"date"},"finalWalkThroughDate":{"type":"string","description":"Final Walk Through Date for this deal.","format":"date"},"possessionDate":{"type":"string","description":"Possession Date for this deal.","format":"date"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"name\": \"Deal\",\n\t\"description\": \"A seller deal\",\n\t\"stageId\": 1,\n  \"projectedCloseDate\": \"2022-01-27T05:00:00.000Z\",\n  \"earnestMoneyDueDate\": \"2022-01-22T05:00:00.000Z\",\n  \"mutualAcceptanceDate\": \"2022-01-23T05:00:00.000Z\",\n  \"dueDiligenceDate\": \"2022-01-17T05:00:00.000Z\",\n  \"finalWalkThroughDate\": \"2022-01-25T05:00:00.000Z\",\n  \"possessionDate\": \"2022-01-27T05:00:00.000Z\",\n  \"price\": 30,\n  \"peopleIds\": [\n    2,\n    5,\n    6\n  ],\n  \"userIds\": [\n    208,\n    210\n  ],\n  \"customField1\": \"A sample custom field.\",\n  \"customField2\": \"2021-04-01T18:48:19Z\",\n  \"customField3\": 3,\n  \"customField4\": \"A sample dropdown selection.\",  \n  \"agentCommission\": 50,\n  \"teamCommission\": 50\n}"}},"schema":{"type":"object","properties":{"name":{"type":"string","example":"Deal"},"description":{"type":"string","example":"A seller deal"},"stageId":{"type":"integer","example":1,"default":0},"projectedCloseDate":{"type":"string","example":"2022-01-27T05:00:00.000Z"},"earnestMoneyDueDate":{"type":"string","example":"2022-01-22T05:00:00.000Z"},"mutualAcceptanceDate":{"type":"string","example":"2022-01-23T05:00:00.000Z"},"dueDiligenceDate":{"type":"string","example":"2022-01-17T05:00:00.000Z"},"finalWalkThroughDate":{"type":"string","example":"2022-01-25T05:00:00.000Z"},"possessionDate":{"type":"string","example":"2022-01-27T05:00:00.000Z"},"price":{"type":"integer","example":30,"default":0},"peopleIds":{"type":"array","items":{"type":"integer","example":2,"default":0}},"userIds":{"type":"array","items":{"type":"integer","example":208,"default":0}},"customField1":{"type":"string","example":"A sample custom field."},"customField2":{"type":"string","example":"2021-04-01T18:48:19Z"},"customField3":{"type":"integer","example":3,"default":0},"customField4":{"type":"string","example":"A sample dropdown selection."},"agentCommission":{"type":"integer","example":50,"default":0},"teamCommission":{"type":"integer","example":50,"default":0}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/pipelines":{"get":{"summary":"/pipelines","description":"Search for pipelines.","operationId":"pipelines-get","parameters":[{"name":"name","in":"query","description":"The pipeline name to lookup. (Must be an exact match.)","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"pipelines\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 1\n  },\n  \"pipelines\": [\n    {\n      \"id\": 1,\n      \"name\": \"My Pipeline\",\n      \"description\": \"A very cool pipeline\",\n      \"orderWeight\": 1000,\n      \"stages\": [\n        {\n          \"id\": 10,\n          \"name\": \"Prospect\",\n          \"description\": \"Prospective deals\",\n          \"orderWeight\": 1000\n        },\n        {\n          \"id\": 11,\n          \"name\": \"In Progress\",\n          \"description\": \"Deals in progress\",\n          \"orderWeight\": 2000\n        }\n      ]\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"_metadata":{"type":"object","properties":{"collection":{"type":"string","example":"pipelines"},"offset":{"type":"integer","example":0,"default":0},"limit":{"type":"integer","example":10,"default":0},"total":{"type":"integer","example":1,"default":0}}},"pipelines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"My Pipeline"},"description":{"type":"string","example":"A very cool pipeline"},"orderWeight":{"type":"integer","example":1000,"default":0},"stages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":10,"default":0},"name":{"type":"string","example":"Prospect"},"description":{"type":"string","example":"Prospective deals"},"orderWeight":{"type":"integer","example":1000,"default":0}}}}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"post":{"summary":"/pipelines","description":"Add a pipeline.","operationId":"pipelines-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the pipeline."},"description":{"type":"string","description":"Description of the pipeline."},"stages":{"type":"array","description":"An array of stage objects that should be associated with the pipeline.","items":{"properties":{"name":{"type":"string"},"description":{"type":"string"},"orderWeight":{"type":"integer","format":"int32"},"color":{"type":"string"},"closedStage":{"type":"boolean","default":false}},"required":["name","closedStage"],"type":"object"}},"orderWeight":{"type":"integer","description":"Set this value to enforce a specific sort order.","format":"int32"}}},"examples":{"Request Example":{"value":{"name":"Buyer pipeline","description":"A pipeline for buyers","orderWeight":1000,"stages":[{"name":"First Stage","description":"","orderWeight":1000,"color":"#FFFFFF","closedStage":false},{"name":"Second Stage","description":"","orderWeight":2000,"closedStage":true}]}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"name\": \"Buyer pipeline\",\n\t\"description\": \"A pipeline for buyers\",\n  \"orderWeight\": 1000,\n  \"stages\": [\n        {\n          \"name\": \"First Stage\",\n          \"description\": \"\",\n          \"orderWeight\": 1000,\n          \"color\": \"#FFFFFF\",\n          \"closedStage\": false\n        },\n        {\n          \"name\": \"Second Stage\",\n          \"description\": \"\",\n          \"orderWeight\": 2000,\n          \"closedStage\": true\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"name":{"type":"string","example":"Buyer pipeline"},"description":{"type":"string","example":"A pipeline for buyers"},"orderWeight":{"type":"integer","example":1000,"default":0},"stages":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"First Stage"},"description":{"type":"string","example":""},"orderWeight":{"type":"integer","example":1000,"default":0},"color":{"type":"string","example":"#FFFFFF"},"closedStage":{"type":"boolean","example":false,"default":true}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/identity":{"get":{"summary":"/identity","description":"Get identity and authentication information.","operationId":"identity","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"account\": {\n        \"id\": 1234567,\n        \"domain\": \"example\",\n        \"owner\": {\n            \"name\": \"John Doe\",\n            \"email\": \"j.doe@example.com\"\n        }\n    },\n    \"user\": {\n        \"id\": 2,\n        \"name\": \"Louis Tully\",\n        \"email\": \"louis@example.com\"\n    }\n}"}},"schema":{"type":"object","properties":{"account":{"type":"object","properties":{"id":{"type":"integer","example":1234567,"default":0},"domain":{"type":"string","example":"example"},"owner":{"type":"object","properties":{"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"j.doe@example.com"}}}}},"user":{"type":"object","properties":{"id":{"type":"integer","example":2,"default":0},"name":{"type":"string","example":"Louis Tully"},"email":{"type":"string","example":"louis@example.com"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/textMessages":{"get":{"summary":"/textMessages","description":"List text messages for a person or phone number.","operationId":"textmessages-get","parameters":[{"name":"personId","in":"query","description":"Filter text messages for a specific person id only.","schema":{"type":"integer","format":"int32"}},{"name":"toNumber","in":"query","description":"Filter text messages sent to a specific recipient's phone number.","schema":{"type":"string"}},{"name":"fromNumber","in":"query","description":"Filter text messages sent from a specific sender's phone number.","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"_metadata\": {\n        \"collection\": \"textmessages\",\n        \"offset\": 0,\n        \"limit\": 10,\n        \"total\": 1,\n        \"next\": null,\n        \"nextLink\": null\n    },\n    \"textmessages\": [\n        {\n            \"id\": 14,\n            \"created\": \"2020-08-06T21:07:51Z\",\n            \"updated\": \"2020-08-06T21:07:51Z\",\n            \"createdById\": 1,\n            \"updatedById\": 1,\n            \"personId\": 3,\n            \"name\": \"Tom Minch\",\n            \"firstName\": \"Tom\",\n            \"lastName\": \"Minch\",\n            \"picture\": null,\n            \"userId\": 1,\n            \"userName\": \"Steven Wade\",\n            \"status\": \"Received\",\n            \"message\": \"Content is hidden for privacy reasons.\",\n            \"fromNumber\": \"8885551234\",\n            \"toNumber\": \"8885559876\",\n            \"sent\": \"2020-08-06T21:07:51Z\",\n            \"isIncoming\": false,\n            \"archived\": false,\n            \"read\": false,\n            \"sharedInboxId\": 0,\n            \"actionPlanId\": 0,\n            \"groupTextId\": null,\n            \"isExternal\": true,\n            \"externalUrl\": null,\n            \"externalLabel\": null,\n            \"media\": [],\n            \"participants\": [\n              {\n                \"name\": null,\n                \"phone\": \"+12345678900\",\n                \"sender\": true,\n                \"canReply\": false,\n                \"phoneLabel\": \"\",\n                \"type\": \"person\",\n                \"personId\": 0,\n                \"relationshipId\": 0,\n                \"avatar\": null,\n                \"summaryAccessOnly\": false\n              },\n              {\n                \"name\": null,\n                \"phone\": \"+19876543210\",\n                \"sender\": true,\n                \"canReply\": false,\n                \"phoneLabel\": \"\",\n                \"type\": \"person\",\n                \"personId\": 0,\n                \"relationshipId\": 0,\n                \"avatar\": null,\n                \"summaryAccessOnly\": false\n              }\n            ],\n            \"systemName\": \"SwadeBook Pro\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"_metadata":{"type":"object","properties":{"collection":{"type":"string","example":"textmessages"},"offset":{"type":"integer","example":0,"default":0},"limit":{"type":"integer","example":10,"default":0},"total":{"type":"integer","example":1,"default":0},"next":{},"nextLink":{}}},"textmessages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":14,"default":0},"created":{"type":"string","example":"2020-08-06T21:07:51Z"},"updated":{"type":"string","example":"2020-08-06T21:07:51Z"},"createdById":{"type":"integer","example":1,"default":0},"updatedById":{"type":"integer","example":1,"default":0},"personId":{"type":"integer","example":3,"default":0},"name":{"type":"string","example":"Tom Minch"},"firstName":{"type":"string","example":"Tom"},"lastName":{"type":"string","example":"Minch"},"picture":{},"userId":{"type":"integer","example":1,"default":0},"userName":{"type":"string","example":"Steven Wade"},"status":{"type":"string","example":"Received"},"message":{"type":"string","example":"Content is hidden for privacy reasons."},"fromNumber":{"type":"string","example":"8885551234"},"toNumber":{"type":"string","example":"8885559876"},"sent":{"type":"string","example":"2020-08-06T21:07:51Z"},"isIncoming":{"type":"boolean","example":false,"default":true},"archived":{"type":"boolean","example":false,"default":true},"read":{"type":"boolean","example":false,"default":true},"sharedInboxId":{"type":"integer","example":0,"default":0},"actionPlanId":{"type":"integer","example":0,"default":0},"groupTextId":{},"isExternal":{"type":"boolean","example":true,"default":true},"externalUrl":{},"externalLabel":{},"media":{"type":"array","items":{"type":"object","properties":{}}},"participants":{"type":"array","items":{"type":"object","properties":{"name":{},"phone":{"type":"string","example":"+12345678900"},"sender":{"type":"boolean","example":true,"default":true},"canReply":{"type":"boolean","example":false,"default":true},"phoneLabel":{"type":"string","example":""},"type":{"type":"string","example":"person"},"personId":{"type":"integer","example":0,"default":0},"relationshipId":{"type":"integer","example":0,"default":0},"avatar":{},"summaryAccessOnly":{"type":"boolean","example":false,"default":true}}}},"systemName":{"type":"string","example":"SwadeBook Pro"}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"post":{"summary":"/textMessages","description":"Create a record of an externally sent text message.","operationId":"textmessages-post","parameters":[{"name":"X-System","in":"header","description":"The name of the registered system sending the API request.","required":true,"schema":{"type":"string"}},{"name":"X-System-Key","in":"header","description":"The secret key of the registered system sending the API request.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["personId","message","toNumber","fromNumber"],"properties":{"personId":{"type":"integer","description":"The id of the person associated with the text message.","format":"int32"},"message":{"type":"string","description":"The body of the text message."},"toNumber":{"type":"string","description":"The phone number the text message was sent to (e.g., 888-555-1234)."},"fromNumber":{"type":"string","description":"The phone number the text messages was sent from (e.g., 888-555-9876)."},"isIncoming":{"type":"boolean","description":"Set whether the text was outgoing to a person or incoming from a person.","default":false},"externalLabel":{"type":"string","description":"An optional descriptive text that appears in the byline of the text message record on the person's timeline."},"externalUrl":{"type":"string","description":"An optional link that will appear in the byline of the text message record in the timeline."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 752,\n    \"created\": \"2020-08-07T20:28:31Z\",\n    \"updated\": \"2020-08-07T20:28:31Z\",\n    \"createdById\": 1,\n    \"updatedById\": 1,\n    \"personId\": 1,\n    \"name\": \"William Riker\",\n    \"firstName\": \"William\",\n    \"lastName\": \"Riker\",\n    \"picture\": null,\n    \"userId\": 1,\n    \"userName\": \"Tom Minch\",\n    \"status\": \"Sent\",\n    \"message\": \"Free for coffee?\",\n    \"fromNumber\": \"8885551234\",\n    \"toNumber\": \"8885559876\",\n    \"sent\": \"2020-08-07T20:28:31Z\",\n    \"isIncoming\": false,\n    \"archived\": true,\n    \"read\": true,\n    \"sharedInboxId\": 0,\n    \"actionPlanId\": 0,\n    \"groupTextId\": null,\n    \"isExternal\": true,\n    \"externalUrl\": null,\n    \"externalLabel\": null,\n    \"systemId\": null,\n    \"media\": [],\n    \"systemName\": null\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":752,"default":0},"created":{"type":"string","example":"2020-08-07T20:28:31Z"},"updated":{"type":"string","example":"2020-08-07T20:28:31Z"},"createdById":{"type":"integer","example":1,"default":0},"updatedById":{"type":"integer","example":1,"default":0},"personId":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"William Riker"},"firstName":{"type":"string","example":"William"},"lastName":{"type":"string","example":"Riker"},"picture":{},"userId":{"type":"integer","example":1,"default":0},"userName":{"type":"string","example":"Tom Minch"},"status":{"type":"string","example":"Sent"},"message":{"type":"string","example":"Free for coffee?"},"fromNumber":{"type":"string","example":"8885551234"},"toNumber":{"type":"string","example":"8885559876"},"sent":{"type":"string","example":"2020-08-07T20:28:31Z"},"isIncoming":{"type":"boolean","example":false,"default":true},"archived":{"type":"boolean","example":true,"default":true},"read":{"type":"boolean","example":true,"default":true},"sharedInboxId":{"type":"integer","example":0,"default":0},"actionPlanId":{"type":"integer","example":0,"default":0},"groupTextId":{},"isExternal":{"type":"boolean","example":true,"default":true},"externalUrl":{},"externalLabel":{},"systemId":{},"media":{"type":"array","items":{"type":"object","properties":{}}},"systemName":{}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/textMessages/{id}":{"get":{"summary":"/textMessages/:id","description":"Retrieve a text message by id.","operationId":"textmessages-id-get","parameters":[{"name":"id","in":"path","description":"The id of the text message record.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 752,\n    \"created\": \"2020-08-07T20:28:31Z\",\n    \"updated\": \"2020-08-07T20:28:31Z\",\n    \"createdById\": 1,\n    \"updatedById\": 1,\n    \"personId\": 1,\n    \"name\": \"William Riker\",\n    \"firstName\": \"William\",\n    \"lastName\": \"Riker\",\n    \"picture\": null,\n    \"userId\": 1,\n    \"userName\": \"Tom Minch\",\n    \"status\": \"Sent\",\n    \"message\": \"Content is hidden for privacy reasons.\",\n    \"fromNumber\": \"8885551234\",\n    \"toNumber\": \"8885559876\",\n    \"sent\": \"2020-08-07T20:28:31Z\",\n    \"isIncoming\": false,\n    \"archived\": true,\n    \"read\": true,\n    \"sharedInboxId\": 0,\n    \"actionPlanId\": 0,\n    \"groupTextId\": null,\n    \"isExternal\": true,\n    \"externalUrl\": null,\n    \"externalLabel\": null,\n    \"systemId\": null,\n    \"media\": [],\n    \"systemName\": null\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":752,"default":0},"created":{"type":"string","example":"2020-08-07T20:28:31Z"},"updated":{"type":"string","example":"2020-08-07T20:28:31Z"},"createdById":{"type":"integer","example":1,"default":0},"updatedById":{"type":"integer","example":1,"default":0},"personId":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"William Riker"},"firstName":{"type":"string","example":"William"},"lastName":{"type":"string","example":"Riker"},"picture":{},"userId":{"type":"integer","example":1,"default":0},"userName":{"type":"string","example":"Tom Minch"},"status":{"type":"string","example":"Sent"},"message":{"type":"string","example":"Content is hidden for privacy reasons."},"fromNumber":{"type":"string","example":"8885551234"},"toNumber":{"type":"string","example":"8885559876"},"sent":{"type":"string","example":"2020-08-07T20:28:31Z"},"isIncoming":{"type":"boolean","example":false,"default":true},"archived":{"type":"boolean","example":true,"default":true},"read":{"type":"boolean","example":true,"default":true},"sharedInboxId":{"type":"integer","example":0,"default":0},"actionPlanId":{"type":"integer","example":0,"default":0},"groupTextId":{},"isExternal":{"type":"boolean","example":true,"default":true},"externalUrl":{},"externalLabel":{},"systemId":{},"media":{"type":"array","items":{"type":"object","properties":{}}},"systemName":{}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/appointments":{"get":{"summary":"/appointments","description":"Search for appointments.","operationId":"appointments-get","parameters":[{"name":"personId","in":"query","description":"Find all appointments related to a person. (Note: This can be comma separated list to search multiple users.)","schema":{"type":"integer","format":"int32"}},{"name":"userId","in":"query","description":"Find all appointments related to a user by id.","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip before starting to return results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"start","in":"query","description":"Date and time representing the start of a date/time range for which to search (must be combined with the `end` argument).","schema":{"type":"string","format":"date"}},{"name":"end","in":"query","description":"Date and time representing the end of a date/time range for which to search (must be combined with the `start` argument).","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"_metadata\": {\n        \"collection\": \"appointments\",\n        \"offset\": 0,\n        \"limit\": 10,\n        \"total\": 1,\n        \"next\": null,\n        \"nextLink\": null\n    },\n    \"appointments\": [\n        {\n            \"id\": 123,\n            \"created\": \"2020-05-04T14:45:13Z\",\n            \"updated\": \"2020-05-04T14:45:13Z\",\n            \"createdById\": 1,\n            \"updatedById\": 1,\n            \"title\": \"Call mom\",\n            \"description\": \"Wish mom a happy Mother's Day\",\n            \"start\": \"2020-05-10T17:00:00Z\",\n            \"end\": \"2020-05-10T18:00:00Z\",\n            \"allDay\": false,\n            \"originFub\": true,\n            \"location\": \"\",\n            \"invitees\": [\n                {\n                    \"userId\": 1,\n                    \"personId\": null,\n                    \"name\": \"Tom Minch\",\n                    \"email\": \"tom@example.com\",\n                    \"picture\": \"https://placekitten.com/408/287\"\n                }\n            ],\n            \"typeId\": null,\n            \"type\": null,\n            \"outcomeId\": null,\n            \"outcome\": null,\n            \"externalEventLink\": null,\n            \"externalCalendarId\": null,\n            \"isEditable\": true,\n            \"detailsVisible\": true\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"_metadata":{"type":"object","properties":{"collection":{"type":"string","example":"appointments"},"offset":{"type":"integer","example":0,"default":0},"limit":{"type":"integer","example":10,"default":0},"total":{"type":"integer","example":1,"default":0},"next":{},"nextLink":{}}},"appointments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":123,"default":0},"created":{"type":"string","example":"2020-05-04T14:45:13Z"},"updated":{"type":"string","example":"2020-05-04T14:45:13Z"},"createdById":{"type":"integer","example":1,"default":0},"updatedById":{"type":"integer","example":1,"default":0},"title":{"type":"string","example":"Call mom"},"description":{"type":"string","example":"Wish mom a happy Mother's Day"},"start":{"type":"string","example":"2020-05-10T17:00:00Z"},"end":{"type":"string","example":"2020-05-10T18:00:00Z"},"allDay":{"type":"boolean","example":false,"default":true},"originFub":{"type":"boolean","example":true,"default":true},"location":{"type":"string","example":""},"invitees":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"integer","example":1,"default":0},"personId":{},"name":{"type":"string","example":"Tom Minch"},"email":{"type":"string","example":"tom@example.com"},"picture":{"type":"string","example":"https://placekitten.com/408/287"}}}},"typeId":{},"type":{},"outcomeId":{},"outcome":{},"externalEventLink":{},"externalCalendarId":{},"isEditable":{"type":"boolean","example":true,"default":true},"detailsVisible":{"type":"boolean","example":true,"default":true}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"post":{"summary":"/appointments","description":"Create an appointment.","operationId":"appointments-post","parameters":[{"name":"sendInvitation","in":"query","description":"Send an invitation email to invitees. (Note: If the \"appointment reminders\" is enabled, an SMS reminder will also be sent.)","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["title","start","end"],"properties":{"title":{"type":"string","description":"Title of the appointment."},"description":{"type":"string","description":"Description of the appointment or event."},"invitees":{"type":"string","description":"Array of users and/or people to invite to the appointment. (e.g., User object: `{userId: 1, name: \"Tom Minch\"}`, People object: `{personId: \"123\", name: \"John Q Customer\", email: \"johnq@example.com\"}`)","format":"json"},"allDay":{"type":"boolean","description":"Sets whether the appointment is an all day event or not.","default":false},"start":{"type":"string","description":"The beginning date and time of the appointment (in UTC, also supports time zone suffix)."},"end":{"type":"string","description":"The ending date and time of the appointment (in UTC, also supports time zone suffix)."},"location":{"type":"string","description":"The location or address of the appointment."},"createdById":{"type":"integer","description":"The id of the user that created the appointment. (Note: This can only be set by admins, otherwise the currently logged in user's ID is used.)","format":"int32"},"typeId":{"type":"integer","description":"The Follow Up Boss appointment type identifier.","format":"int32"},"outcomeId":{"type":"integer","description":"The Follow Up Boss appointment outcome identifier.","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n   \"id\":13854,\n   \"created\":\"2020-09-04T15:13:18Z\",\n   \"updated\":\"2020-09-04T15:13:18Z\",\n   \"createdById\":1,\n   \"updatedById\":1,\n   \"title\":\"Lunch\",\n   \"description\":\"Tom and John Q. are having lunch. Gotta try the new \\\"impossible\\\" burger\",\n   \"start\":\"2020-09-04T16:00:00Z\",\n   \"end\":\"2020-09-04T17:00:00Z\",\n   \"allDay\":false,\n   \"originFub\":true,\n   \"location\":\"\",\n   \"invitees\":[\n      {\n         \"userId\":1,\n         \"personId\":null,\n         \"name\":\"Tom Minch\",\n         \"email\":\"tom@example.com\",\n         \"picture\":\"https://placekitten.com/408/287\"\n      },\n      {\n         \"userId\":null,\n         \"personId\":44673,\n         \"name\":\"John Q Customer\",\n         \"email\":\"johnq@example.com\"\n      }\n   ],\n   \"typeId\": null,\n   \"type\": null,\n   \"outcomeId\": null,\n   \"outcome\": null,\n   \"externalEventLink\":null,\n   \"externalCalendarId\":null,\n   \"isEditable\":true,\n   \"detailsVisible\":true\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":13854,"default":0},"created":{"type":"string","example":"2020-09-04T15:13:18Z"},"updated":{"type":"string","example":"2020-09-04T15:13:18Z"},"createdById":{"type":"integer","example":1,"default":0},"updatedById":{"type":"integer","example":1,"default":0},"title":{"type":"string","example":"Lunch"},"description":{"type":"string","example":"Tom and John Q. are having lunch. Gotta try the new \"impossible\" burger"},"start":{"type":"string","example":"2020-09-04T16:00:00Z"},"end":{"type":"string","example":"2020-09-04T17:00:00Z"},"allDay":{"type":"boolean","example":false,"default":true},"originFub":{"type":"boolean","example":true,"default":true},"location":{"type":"string","example":""},"invitees":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"integer","example":1,"default":0},"personId":{},"name":{"type":"string","example":"Tom Minch"},"email":{"type":"string","example":"tom@example.com"},"picture":{"type":"string","example":"https://placekitten.com/408/287"}}}},"typeId":{},"type":{},"outcomeId":{},"outcome":{},"externalEventLink":{},"externalCalendarId":{},"isEditable":{"type":"boolean","example":true,"default":true},"detailsVisible":{"type":"boolean","example":true,"default":true}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/appointments/{id}":{"get":{"summary":"/appointments/:id","description":"Retrieve an appointment by id.","operationId":"appointments-id-get","parameters":[{"name":"id","in":"path","description":"The id of the appointment.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n   \"id\":123,\n   \"created\":\"2020-05-04T14:45:13Z\",\n   \"updated\":\"2020-05-04T14:45:13Z\",\n   \"createdById\":1,\n   \"updatedById\":1,\n   \"title\":\"Call mom\",\n   \"description\":\"Wish mom a happy Mother's Day\",\n   \"start\":\"2020-05-10T17:00:00Z\",\n   \"end\":\"2020-05-10T18:00:00Z\",\n   \"allDay\":false,\n   \"originFub\":true,\n   \"location\":\"\",\n   \"invitees\":[\n      {\n         \"userId\":1,\n         \"personId\":null,\n         \"name\":\"Tom Minch\",\n         \"email\":\"tom@example.com\",\n         \"picture\":\"https://placekitten.com/408/287\"\n      }\n   ],\n   \"typeId\": null,\n   \"type\": null,\n   \"outcomeId\": null,\n   \"outcome\": null,\n   \"externalEventLink\":null,\n   \"externalCalendarId\":null,\n   \"isEditable\":true,\n   \"detailsVisible\":true\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":123,"default":0},"created":{"type":"string","example":"2020-05-04T14:45:13Z"},"updated":{"type":"string","example":"2020-05-04T14:45:13Z"},"createdById":{"type":"integer","example":1,"default":0},"updatedById":{"type":"integer","example":1,"default":0},"title":{"type":"string","example":"Call mom"},"description":{"type":"string","example":"Wish mom a happy Mother's Day"},"start":{"type":"string","example":"2020-05-10T17:00:00Z"},"end":{"type":"string","example":"2020-05-10T18:00:00Z"},"allDay":{"type":"boolean","example":false,"default":true},"originFub":{"type":"boolean","example":true,"default":true},"location":{"type":"string","example":""},"invitees":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"integer","example":1,"default":0},"personId":{},"name":{"type":"string","example":"Tom Minch"},"email":{"type":"string","example":"tom@example.com"},"picture":{"type":"string","example":"https://placekitten.com/408/287"}}}},"typeId":{},"type":{},"outcomeId":{},"outcome":{},"externalEventLink":{},"externalCalendarId":{},"isEditable":{"type":"boolean","example":true,"default":true},"detailsVisible":{"type":"boolean","example":true,"default":true}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"/appointments/:id","description":"Delete an appointment.","operationId":"appointments-id-delete","parameters":[{"name":"id","in":"path","description":"The id of appointment to delete.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"204":{"description":"204","content":{"text/plain":{"examples":{"Result":{"value":""}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"put":{"summary":"/appointments/:id","description":"Update an appointment.","operationId":"appointments-id-put","parameters":[{"name":"sendInvitation","in":"query","description":"Send an invitation email to invitees. (Note: If the \"appointment reminders\" is enabled, an SMS reminder will also be sent.)","schema":{"type":"boolean","default":false}},{"name":"id","in":"path","description":"The id of the appointment to update.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["title","start","end"],"properties":{"title":{"type":"string","description":"Title of the appointment."},"description":{"type":"string","description":"Description of the appointment or event."},"invitees":{"type":"string","description":"Array of users and/or people to invite to the appointment. (e.g., User object: `{userId: 1, name: \"Tom Minch\"}`, People object: `{personId: \"123\", name: \"John Q Customer\", email: \"johnq@example.com\"}`)","format":"json"},"allDay":{"type":"boolean","description":"Sets whether the appointment is an all day event or not.","default":false},"start":{"type":"string","description":"The beginning date and time of the appointment (in UTC, also supports time zone suffix)."},"end":{"type":"string","description":"The ending date and time of the appointment (in UTC, also supports time zone suffix)."},"location":{"type":"string","description":"The location or address of the appointment."},"typeId":{"type":"integer","description":"The Follow Up Boss appointment type identifier.","format":"int32"},"outcomeId":{"type":"integer","description":"The Follow Up Boss appointment outcome identifier.","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n   \"id\":13854,\n   \"created\":\"2020-09-04T15:13:18Z\",\n   \"updated\":\"2020-09-04T15:13:18Z\",\n   \"createdById\":1,\n   \"updatedById\":1,\n   \"title\":\"Lunch\",\n   \"description\":\"Tom and John Q. are having lunch. Gotta try the new \\\"impossible\\\" burger\",\n   \"start\":\"2020-09-04T16:00:00Z\",\n   \"end\":\"2020-09-04T17:00:00Z\",\n   \"allDay\":false,\n   \"originFub\":true,\n   \"location\":\"\",\n   \"invitees\":[\n      {\n         \"userId\":1,\n         \"personId\":null,\n         \"name\":\"Tom Minch\",\n         \"email\":\"tom@example.com\",\n         \"picture\":\"https://placekitten.com/408/287\"\n      },\n      {\n         \"userId\":null,\n         \"personId\":44673,\n         \"name\":\"John Q Customer\",\n         \"email\":\"johnq@example.com\"\n      }\n   ],\n   \"typeId\": 1,\n   \"type\": \"Buyer consultation\",\n   \"outcomeId\": 2,\n   \"outcome\": \"Working with buyers\",\n   \"externalEventLink\":null,\n   \"externalCalendarId\":null,\n   \"isEditable\":true,\n   \"detailsVisible\":true\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":13854,"default":0},"created":{"type":"string","example":"2020-09-04T15:13:18Z"},"updated":{"type":"string","example":"2020-09-04T15:13:18Z"},"createdById":{"type":"integer","example":1,"default":0},"updatedById":{"type":"integer","example":1,"default":0},"title":{"type":"string","example":"Lunch"},"description":{"type":"string","example":"Tom and John Q. are having lunch. Gotta try the new \"impossible\" burger"},"start":{"type":"string","example":"2020-09-04T16:00:00Z"},"end":{"type":"string","example":"2020-09-04T17:00:00Z"},"allDay":{"type":"boolean","example":false,"default":true},"originFub":{"type":"boolean","example":true,"default":true},"location":{"type":"string","example":""},"invitees":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"integer","example":1,"default":0},"personId":{},"name":{"type":"string","example":"Tom Minch"},"email":{"type":"string","example":"tom@example.com"},"picture":{"type":"string","example":"https://placekitten.com/408/287"}}}},"typeId":{"type":"integer","example":1,"default":0},"type":{"type":"string","example":"Buyer consultation"},"outcomeId":{"type":"integer","example":2,"default":0},"outcome":{"type":"string","example":"Working with buyers"},"externalEventLink":{},"externalCalendarId":{},"isEditable":{"type":"boolean","example":true,"default":true},"detailsVisible":{"type":"boolean","example":true,"default":true}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/peopleRelationships":{"get":{"summary":"/peopleRelationships","description":"Get relationships between people in Follow Up Boss.","operationId":"peoplerelationships","parameters":[{"name":"sort","in":"query","description":"The sort order. Can be one of the following: `id`, `created`, `updated`, `name`, `firstName`, `lastName`, `personId`.","schema":{"type":"string"}},{"name":"personId","in":"query","description":"Filter relationships by a person ID.","schema":{"type":"integer","format":"int32"}},{"name":"name","in":"query","description":"Searches for person with a name like what is given. (e.g., If you search for `drew`, it might return a contact like `Andrew`.)","schema":{"type":"string"}},{"name":"firstName","in":"query","description":"Searches for person with a first name like what is given. (e.g., If you search for `drew`, it might return a contact like `Andrew.`)","schema":{"type":"string"}},{"name":"lastName","in":"query","description":"Searches for person with a last name like what is given. (e.g., If you search for `drew`, it might return a contact like `Andrew.`)","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 423,\n    \"created\": \"2021-02-19T14:12:36Z\",\n    \"updated\": \"2021-02-19T14:12:41Z\",\n    \"createdById\": 41,\n    \"updatedById\": 41,\n    \"personId\": 46977,\n    \"name\": \"Bily Bob\",\n    \"firstName\": \"Billy\",\n    \"lastName\": \"Bob\",\n    \"type\": \"Husband\",\n    \"isPriority\": true,\n    \"emails\": [],\n    \"phones\": [\n        {\n            \"value\": \"5551113333\",\n            \"type\": \"mobile\",\n            \"status\": \"Valid\",\n            \"isPrimary\": 1,\n            \"normalized\": \"5551113333\"\n        }\n    ],\n    \"addresses\": [],\n    \"picture\": null,\n    \"socialData\": []\n},\n{\n    \"id\": 422,\n    \"created\": \"2021-02-19T11:01:31Z\",\n    \"updated\": \"2021-02-19T14:12:18Z\",\n    \"createdById\": 41,\n    \"updatedById\": 41,\n    \"personId\": 44498,\n    \"name\": \"Breanne Sanders\",\n    \"firstName\": \"Breanne\",\n    \"lastName\": \"Sanders\",\n    \"type\": \"\",\n    \"isPriority\": false,\n    \"emails\": [],\n    \"phones\": [\n        {\n            \"value\": \"5551113334\",\n            \"type\": \"mobile\",\n            \"status\": \"Valid\",\n            \"isPrimary\": 1,\n            \"normalized\": \"5551113334\"\n        }\n    ],\n    \"addresses\": [],\n    \"picture\": null,\n    \"socialData\": []\n},"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"post":{"summary":"/peopleRelationships","description":"Create a new relationship for a person.","operationId":"peoplerelationships-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"integer","description":"Person ID this relationship is associated with.","default":null,"format":"int32"},"firstName":{"type":"string","description":"The first/given name of the relationship."},"lastName":{"type":"string","description":"The last/family name of the relationship."},"type":{"type":"string","description":"The type of relationship, e.g. `Spouse`, `Brother`, `Partner` , etc."},"emails":{"type":"array","description":"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.)","items":{"properties":{"value":{"type":"string","description":"The email address."},"type":{"type":"string","description":"The type of email address (e.g., \"work\", \"home\")"},"isPrimary":{"type":"boolean","description":"Sets whether the email address is the primary address.","default":false}},"required":["value"],"type":"object"}},"phones":{"type":"array","description":"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.)","items":{"properties":{"value":{"type":"string","description":"The phone number. (e.g., 888-555-1234)"},"isPrimary":{"type":"boolean","description":"Sets whether this is the primary phone number.","default":false},"type":{"type":"string","description":"Type of number (e.g., \"mobile\", \"home\", \"fax\", etc.)"}},"required":["value"],"type":"object"}},"addresses":{"type":"array","description":"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).","items":{"properties":{"type":{"type":"string","description":"The address type. (e.g., \"home\", \"work\", \"mailing\", \"investment\", etc.)","default":"home"},"street":{"type":"string","description":"Street address. (e.g., \"3595 South Higuera St., Suite B\")"},"city":{"type":"string","description":"City name."},"state":{"type":"string","description":"Abbreviated state code. (e.g., \"CA\", \"NY\", etc.)"},"code":{"type":"string","description":"Zipcode. (As a string, not a number.)"},"country":{"type":"string","description":"Country name. (e.g., \"United States\", \"Japan\", etc.)"}},"type":"object"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/peopleRelationships/{id}":{"get":{"summary":"/peopleRelationships/:id","description":"Get a specific relationship.","operationId":"peoplerelationships-id-get","parameters":[{"name":"id","in":"path","description":"The ID of a given relationship.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 423,\n    \"created\": \"2021-02-19T14:12:36Z\",\n    \"updated\": \"2021-02-19T14:12:41Z\",\n    \"createdById\": 41,\n    \"updatedById\": 41,\n    \"personId\": 46977,\n    \"name\": \"Billy Bob\",\n    \"firstName\": \"Billy\",\n    \"lastName\": \"Bob\",\n    \"type\": \"\",\n    \"isPriority\": false,\n    \"emails\": [],\n    \"phones\": [\n        {\n            \"value\": \"5551113333\",\n            \"type\": \"mobile\",\n            \"status\": \"Valid\",\n            \"isPrimary\": 1,\n            \"normalized\": \"5551113333\"\n        }\n    ],\n    \"addresses\": [],\n    \"picture\": null,\n    \"socialData\": []\n},"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"put":{"summary":"/peopleRelationships/:id","description":"Update details of a specific relationship.","operationId":"peoplerelationships-id-put","parameters":[{"name":"id","in":"path","description":"The ID of a given relationship.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","description":"The first/given name of the relationship."},"lastName":{"type":"string","description":"The last/family name of the relationship."},"type":{"type":"string","description":"The type of relationship. (e.g., `Spouse`, `Brother`, `Partner` , etc.)"},"emails":{"type":"array","description":"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.)","items":{"properties":{"value":{"type":"string","description":"The email address."},"type":{"type":"string","description":"The type of email address (e.g., \"work\", \"home\")"},"isPrimary":{"type":"boolean","description":"Sets whether the email address is the primary address.","default":false}},"required":["value"],"type":"object"}},"phones":{"type":"array","description":"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.)","items":{"properties":{"value":{"type":"string","description":"The phone number. (e.g., 888-555-1234)"},"isPrimary":{"type":"boolean","description":"Sets whether this is the primary phone number.","default":false},"type":{"type":"string","description":"Type of number (e.g., \"mobile\", \"home\", \"fax\", etc.)"}},"required":["value"],"type":"object"}},"addresses":{"type":"array","description":"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).","items":{"properties":{"type":{"type":"string","description":"The address type. (e.g., \"home\", \"work\", \"mailing\", \"investment\", etc.)","default":"home"},"street":{"type":"string","description":"Street address. (e.g., \"3595 South Higuera St., Suite B\")"},"city":{"type":"string","description":"City name."},"state":{"type":"string","description":"Abbreviated state code. (e.g., \"CA\", \"NY\", etc.)"},"code":{"type":"string","description":"Zipcode. (As a string, not a number.)"},"country":{"type":"string","description":"Country name. (e.g., \"United States\", \"Japan\", etc.)"}},"type":"object"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"/peopleRelationships/:id","description":"Delete a relationship.","operationId":"peoplerelationships-id-delete","parameters":[{"name":"id","in":"path","description":"The relationship ID to delete.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/templates/merge":{"post":{"summary":"/templates/merge","description":"Merge an email template with multiple recipients.","operationId":"templates-merge","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"templateId":{"type":"integer","description":"The ID of the email template.","format":"int32"},"mergePersonId":{"type":"integer","description":"Person ID to use for merge fields like %contact_name%.","format":"int32"},"recipients":{"type":"object","description":"List of recipients in the To: field of this email.","properties":{"to":{"type":"array","items":{"properties":{"name":{"type":"string"},"email":{"type":"string"}},"type":"object"}}}}}},"examples":{"Example request body":{"value":{"templateId":31,"mergePersonId":1213,"recipients":{"to":[{"name":"Bob Alvarez","email":"bob@example.com"},{"name":"Alice Alvarez","email":"alice@example.com"},{"name":"Carol Alvarez","email":"carol@example.com"},{"email":"other@example.com"}]}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 6,\n  \"created\": \"2014-02-28T08:45:46Z\",\n  \"updated\": \"2021-08-15T17:24:22Z\",\n  \"createdById\": 14,\n  \"updatedById\": 14,\n  \"name\": \"I am here to help\",\n  \"isMobile\": 1,\n  \"isShared\": true,\n  \"body\": \"Hi Bob, I am here to help, ...\",\n  \"subject\": \"Your property inquiry from Zillow\",\n  \"isEditable\": true,\n  \"isDeletable\": true\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":6,"default":0},"created":{"type":"string","example":"2014-02-28T08:45:46Z"},"updated":{"type":"string","example":"2021-08-15T17:24:22Z"},"createdById":{"type":"integer","example":14,"default":0},"updatedById":{"type":"integer","example":14,"default":0},"name":{"type":"string","example":"I am here to help"},"isMobile":{"type":"integer","example":1,"default":0},"isShared":{"type":"boolean","example":true,"default":true},"body":{"type":"string","example":"Hi Bob, I am here to help, ..."},"subject":{"type":"string","example":"Your property inquiry from Zillow"},"isEditable":{"type":"boolean","example":true,"default":true},"isDeletable":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false}},"/textMessageTemplates/merge":{"post":{"summary":"/textMessageTemplates/merge","description":"Merge a text message template with multiple recipients.","operationId":"textmessagetemplates-merge","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["templateId"],"properties":{"templateId":{"type":"integer","description":"The ID of the text message template.","format":"int32"},"personId":{"type":"integer","description":"Person ID to use for merge fields like %contact_name%.","format":"int32"},"recipients":{"type":"object","description":"List of recipients of this text message.","properties":{"to":{"type":"array","items":{"properties":{"name":{"type":"string"},"phone":{"type":"string"}},"type":"object"}}}}}},"examples":{"Request Body":{"value":{"templateId":31,"mergePersonId":1213,"recipients":{"to":[{"name":"Bob Alvarez","phone":"+14075558075"},{"name":"Alice Alvarez","phone":"+14075558710"},{"name":"Carol Alvarez","phone":"+14075551643"},{"phone":"+14075556097"}]}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"mergedTemplate\"; \"Hey Bob, Alice and Carol...\"\n}"}}}}}},"deprecated":false}},"/people/checkDuplicate":{"get":{"summary":"/people/checkDuplicate","description":"Check whether a person exists in Follow Up Boss.","operationId":"people-checkduplicate","parameters":[{"name":"email","in":"query","description":"The email address to search for.","schema":{"type":"string"}},{"name":"phone","in":"query","description":"The phone number to search for.","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"found\": true,\n  \"matchedBy\": \"email\",\n  \"assignedTo\": \"Agent Smith\"\n}"},"OK (not found)":{"value":"{\"found\": false}"}},"schema":{"oneOf":[{"type":"object","properties":{"found":{"type":"boolean","example":true,"default":true},"matchedBy":{"type":"string","example":"email"},"assignedTo":{"type":"string","example":"Agent Smith"}}},{"title":"OK (not found)","type":"object","properties":{"found":{"type":"boolean","example":false,"default":true}}}]}}}}},"deprecated":false}},"/people/unclaimed":{"get":{"summary":"/people/unclaimed","description":"Get unclaimed leads.","operationId":"peopleunclaimed","parameters":[{"name":"limit","in":"query","description":"Number of results to return. (Max 100.)","schema":{"type":"integer","format":"int32","default":10}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip before starting to return results.","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"people\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 1,\n    \"next\": null,\n    \"nextLink\": null,\n  },\n  \"people\": [\n    {\n      \"id\": 47362,\n      \"created\": \"2021-04-23T15:22:29Z\",\n      \"name\": \"Toribio Sinaluisa\",\n      \"firstName\": \"Toribio\",\n      \"lastName\": \"Sinaluisa\",\n      \"source\": \"Zillow\",\n      \"sourceId\": 730,\n      \"delayed\": false,\n       \"picture\": {\n        \"small\": \"https://example.com/avatar.jpg\"\n      }\n      \"claimed\": true\n    },\n    {\n      \"id\": 47364,\n      \"created\": \"2021-04-23T15:24:26Z\",\n      \"name\": \"Itamar Llore\",\n      \"firstName\": \"Itamar\",\n      \"lastName\": \"Llore\",\n      \"source\": \"Zillow\",\n      \"sourceId\": 730,\n      \"delayed\": false,\n      \"picture\": null,\n      \"claimed\": false\n    }\n  ]\n}"}}}}}},"deprecated":false}},"/people/claim":{"post":{"summary":"/people/claim","description":"Claim a lead.","operationId":"people-claim","parameters":[{"name":"personId","in":"path","description":"Include the person ID of the lead you want to claim either like this or in the POST body","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"integer","description":"Include the person ID of the lead you want to claim either like this or as part of the path itself.","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 31227,\n  \"created\": \"2017-07-17T14:29:40Z\",\n  \"updated\": \"2017-07-17T14:45:44Z\",\n  \"createdVia\": \"API\",\n  \"lastActivity\": \"2017-07-17T14:45:47Z\",\n  \"name\": \"Sergio Pared\",\n  \"firstName\": \"Sergio\",\n  \"lastName\": \"Pared\",\n  \"stage\": \"Sphere\",\n  \"stageId\": 10,\n  \"source\": \"Zillow\",\n  \"sourceUrl\": \"https://example.com/lead/123\",\n  \"contacted\": 0,\n  \"price\": 15000,\n  \"assignedLenderId\": null,\n  \"assignedLenderName\": null,\n  \"assignedUserId\": 15,\n  \"assignedTo\": \"Agent Smith\",\n  \"tags\": [\n    \"60652\",\n    \"Chicago\"\n  ],\n  \"emails\": [\n    {\n      \"value\": \"sergio.pared@example.com\",\n      \"type\": \"home\",\n      \"isPrimary\": 1\n    }\n  ],\n  \"phones\": [\n    {\n      \"value\": \"(929) 555-2938\",\n      \"type\": \"home\",\n      \"status\": \"valid\",\n      \"isPrimary\": 1\n    }\n  ],\n  \"addresses\": [\n    {\n      \"type\": \"work\",\n      \"street\": \"850 West Eastman\",\n      \"city\": \"Chicago\",\n      \"state\": \"IL\",\n      \"code\": \"60642\",\n      \"country\": \"United States\"\n    }\n  ],\n  \"picture\": {\n    \"small\": \"https://example.com/avatar/123.jpg\"\n  }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":31227,"default":0},"created":{"type":"string","example":"2017-07-17T14:29:40Z"},"updated":{"type":"string","example":"2017-07-17T14:45:44Z"},"createdVia":{"type":"string","example":"API"},"lastActivity":{"type":"string","example":"2017-07-17T14:45:47Z"},"name":{"type":"string","example":"Sergio Pared"},"firstName":{"type":"string","example":"Sergio"},"lastName":{"type":"string","example":"Pared"},"stage":{"type":"string","example":"Sphere"},"stageId":{"type":"integer","example":10,"default":0},"source":{"type":"string","example":"Zillow"},"sourceUrl":{"type":"string","example":"https://example.com/lead/123"},"contacted":{"type":"integer","example":0,"default":0},"price":{"type":"integer","example":15000,"default":0},"assignedLenderId":{},"assignedLenderName":{},"assignedUserId":{"type":"integer","example":15,"default":0},"assignedTo":{"type":"string","example":"Agent Smith"},"tags":{"type":"array","items":{"type":"string","example":"60652"}},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","example":"sergio.pared@example.com"},"type":{"type":"string","example":"home"},"isPrimary":{"type":"integer","example":1,"default":0}}}},"phones":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","example":"(929) 555-2938"},"type":{"type":"string","example":"home"},"status":{"type":"string","example":"valid"},"isPrimary":{"type":"integer","example":1,"default":0}}}},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"work"},"street":{"type":"string","example":"850 West Eastman"},"city":{"type":"string","example":"Chicago"},"state":{"type":"string","example":"IL"},"code":{"type":"string","example":"60642"},"country":{"type":"string","example":"United States"}}}},"picture":{"type":"object","properties":{"small":{"type":"string","example":"https://example.com/avatar/123.jpg"}}}}}}}},"409":{"description":"409","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 31227,\n  \"created\": \"2017-07-17T14:29:40Z\",\n  \"name\": \"Sergio Pared\",\n  \"firstName\": \"Sergio\",\n  \"lastName\": \"Pared\",\n  \"source\": \"Zillow\",\n  \"sourceId\": 99,\n  \"picture\": {\n    \"small\": \"https://example.com/avatar/123.jpg\"\n  },\n  \"claimed\": true\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":31227,"default":0},"created":{"type":"string","example":"2017-07-17T14:29:40Z"},"name":{"type":"string","example":"Sergio Pared"},"firstName":{"type":"string","example":"Sergio"},"lastName":{"type":"string","example":"Pared"},"source":{"type":"string","example":"Zillow"},"sourceId":{"type":"integer","example":99,"default":0},"picture":{"type":"object","properties":{"small":{"type":"string","example":"https://example.com/avatar/123.jpg"}}},"claimed":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false}},"/people/ignoreUnclaimed":{"post":{"summary":"/people/ignoreUnclaimed","description":"Ignore a lead.","operationId":"people-ignoreunclaimed","parameters":[{"name":"personId","in":"path","description":"Include the person ID of the lead you want to ignore either like this or in the POST body.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"integer","description":"Include the person ID of the lead you want to ignore either like this or as part of the path.","format":"int32"}}}}}},"responses":{"204":{"description":"204","content":{"application/json":{"examples":{"Result":{"value":""}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"errorMessage\": \"Requested resource was not found.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"Requested resource was not found."}}}}}}},"deprecated":false}},"/textMessageTemplates":{"get":{"summary":"/textMessageTemplates","description":"Lists all text message templates.","operationId":"textmessagetemplates-get","parameters":[{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"string","default":"10"}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip before starting to return results.","schema":{"type":"string","default":"0"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"textmessagetemplates\",\n    \"offset\": 0,\n    \"limit\": 2,\n    \"total\": 24,\n    \"next\": \"eyJvZmZzZXQiOjN9\",\n    \"nextLink\": \"https://api.followupboss.com/v1/textMessageTemplates?limit=3&next=eyJvZmZzZXQiOjN9\"\n  },\n  \"textmessagetemplates\": [\n    {\n      \"id\": 110,\n      \"name\": \"Agent > Client + Lender intro\",\n      \"totalSent\": 1,\n      \"totalReplies\": 1,\n      \"message\": \"%lender_first_name% - %contact_first_name% is a client of mine who's going to be buying a property shortly. Can you please take point on getting them pre-approved?\",\n      \"isShared\": true,\n      \"createdBy\": -1,\n      \"isEditable\": true,\n      \"isDeletable\": true,\n      \"isShareable\": false,\n      \"sentPeopleIds\": [\n        34663\n      ],\n      \"actionPlans\": []\n    },\n    {\n      \"id\": 98,\n      \"name\": \"Buyer Appointment\",\n      \"totalSent\": 3,\n      \"totalReplies\": 0,\n      \"message\": \"%contact_first_name%, are you free this week to take a quick tour of a home I picked out for you?\",\n      \"isShared\": true,\n      \"createdBy\": -1,\n      \"isEditable\": true,\n      \"isDeletable\": true,\n      \"isShareable\": false,\n      \"sentPeopleIds\": [\n        39984,\n        40867\n      ],\n      \"actionPlans\": []\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"_metadata":{"type":"object","properties":{"collection":{"type":"string","example":"textmessagetemplates"},"offset":{"type":"integer","example":0,"default":0},"limit":{"type":"integer","example":2,"default":0},"total":{"type":"integer","example":24,"default":0},"next":{"type":"string","example":"eyJvZmZzZXQiOjN9"},"nextLink":{"type":"string","example":"https://api.followupboss.com/v1/textMessageTemplates?limit=3&next=eyJvZmZzZXQiOjN9"}}},"textmessagetemplates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":110,"default":0},"name":{"type":"string","example":"Agent > Client + Lender intro"},"totalSent":{"type":"integer","example":1,"default":0},"totalReplies":{"type":"integer","example":1,"default":0},"message":{"type":"string","example":"%lender_first_name% - %contact_first_name% is a client of mine who's going to be buying a property shortly. Can you please take point on getting them pre-approved?"},"isShared":{"type":"boolean","example":true,"default":true},"createdBy":{"type":"integer","example":-1,"default":0},"isEditable":{"type":"boolean","example":true,"default":true},"isDeletable":{"type":"boolean","example":true,"default":true},"isShareable":{"type":"boolean","example":false,"default":true},"sentPeopleIds":{"type":"array","items":{"type":"integer","example":34663,"default":0}},"actionPlans":{"type":"array","items":{"type":"object","properties":{}}}}}}}}}}}},"deprecated":false}},"/textMessageTemplates/{id}":{"get":{"summary":"/textMessageTemplates/:id","description":"Retrieve a text message template by id.","operationId":"textmessagetemplates-id-get","parameters":[{"name":"id","in":"path","description":"The ID of the template.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 110,\n  \"name\": \"Agent > Client + Lender intro\",\n  \"totalSent\": 1,\n  \"totalReplies\": 1,\n  \"message\": \"%lender_first_name% - %contact_first_name% is a client of mine who's going to be buying a property shortly. Can you please take point on getting them pre-approved?\",\n  \"isShared\": true,\n  \"createdBy\": -1,\n  \"isEditable\": true,\n  \"isDeletable\": true,\n  \"isShareable\": false,\n  \"sentPeopleIds\": [\n    34663\n  ],\n  \"actionPlans\": []\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":110,"default":0},"name":{"type":"string","example":"Agent > Client + Lender intro"},"totalSent":{"type":"integer","example":1,"default":0},"totalReplies":{"type":"integer","example":1,"default":0},"message":{"type":"string","example":"%lender_first_name% - %contact_first_name% is a client of mine who's going to be buying a property shortly. Can you please take point on getting them pre-approved?"},"isShared":{"type":"boolean","example":true,"default":true},"createdBy":{"type":"integer","example":-1,"default":0},"isEditable":{"type":"boolean","example":true,"default":true},"isDeletable":{"type":"boolean","example":true,"default":true},"isShareable":{"type":"boolean","example":false,"default":true},"sentPeopleIds":{"type":"array","items":{"type":"integer","example":34663,"default":0}},"actionPlans":{"type":"array","items":{"type":"object","properties":{}}}}}}}}},"deprecated":false},"put":{"summary":"/textMessageTemplates/:id","description":"Update a text message template.","operationId":"textmessagetemplates-id-put","parameters":[{"name":"id","in":"path","description":"The ID of the text message template to update.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","message"],"properties":{"name":{"type":"string","description":"The name of your text message template."},"message":{"type":"string","description":"The body of your text message template."},"isShared":{"type":"boolean","description":"Set to true if this template should be shared with other users in the same Follow Up Boss account."}}},"examples":{"Request Example":{"value":{"name":"Beach House promo","message":"%greeting_time%, %contact_first_name%\n\nCheck out this beach house: https://example.com","isShared":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 182,\n  \"name\": \"Beach House promo\",\n  \"totalSent\": 0,\n  \"totalReplies\": 0,\n  \"message\": \"%greeting_time%, %contact_first_name%\\n\\nCheck out this beach house: https://example.com\",\n  \"isShared\": true,\n  \"createdBy\": 15,\n  \"isEditable\": true,\n  \"isShareable\": true,\n  \"isDeletable\": true,\n  \"categories\": [],\n  \"sentPeopleCount\": 0,\n  \"actionPlans\": [],\n  \"effectivenessScore\": null,\n  \"windowedSent\": 0,\n  \"windowedReplies\": 0,\n  \"windowedOptOutRate\": null,\n  \"totalOptOutRate\": null\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":182,"default":0},"name":{"type":"string","example":"Beach House promo"},"totalSent":{"type":"integer","example":0,"default":0},"totalReplies":{"type":"integer","example":0,"default":0},"message":{"type":"string","example":"%greeting_time%, %contact_first_name%\n\nCheck out this beach house: https://example.com"},"isShared":{"type":"boolean","example":true,"default":true},"createdBy":{"type":"integer","example":15,"default":0},"isEditable":{"type":"boolean","example":true,"default":true},"isShareable":{"type":"boolean","example":true,"default":true},"isDeletable":{"type":"boolean","example":true,"default":true},"categories":{"type":"array","items":{"type":"object","properties":{}}},"sentPeopleCount":{"type":"integer","example":0,"default":0},"actionPlans":{"type":"array","items":{"type":"object","properties":{}}},"effectivenessScore":{},"windowedSent":{"type":"integer","example":0,"default":0},"windowedReplies":{"type":"integer","example":0,"default":0},"windowedOptOutRate":{},"totalOptOutRate":{}}}}}}},"deprecated":false},"delete":{"summary":"/textMessageTemplates/:id","description":"","operationId":"textmessagetemplates-id-delete","parameters":[{"name":"id","in":"path","description":"The ID of the text message template to delete.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/groups":{"get":{"summary":"/groups","description":"List groups.","operationId":"groups-get","parameters":[{"name":"type","in":"query","description":"`Agent` groups allow admins and agents and `Lender` groups allow lender role users.","schema":{"type":"string","enum":["Agent","Lender"]}},{"name":"sort","in":"query","description":"Sorts results based on the provided field name. Prepending the field with a minus sign (-) sorts the results in descending order.","schema":{"type":"string","enum":["id","name"]}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"groups\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 41,\n    \"next\": \"eyJzaW5jZUlkIjo1ND0\",\n    \"nextLink\": \"https://api.followupboss.com/v1/groups?next=eyJzaW5jZUlkIjo1ND0\"\n  },\n  \"groups\": [\n    {\n      \"id\": 63,\n      \"name\": \"Eastside\",\n      \"type\": \"Agent\",\n      \"distribution\": \"first-to-claim\",\n      \"defaultUserId\": null,\n      \"defaultPondId\": null,\n      \"defaultGroupId\": null,\n      \"claimWindow\": 900,\n      \"nextRoundRobinUser\": null,\n      \"isPrimary\": false,\n      \"users\": [\n        {\n          \"id\": 199,\n          \"name\": \"Daniel Corkill\",\n          \"firstName\": \"Daniel\",\n          \"lastName\": \"Corkill\",\n          \"role\": \"Broker\",\n          \"pauseLeadDistribution\": true\n        },\n        ...\n      ]\n    },\n    ...\n  ]\n}"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"post":{"summary":"/groups","description":"Create a new group.","operationId":"groups-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","users"],"properties":{"name":{"type":"string","description":"The name of the group."},"distribution":{"type":"string","description":"The distribution model to utilize. (Note: Lender groups cannot be set to `first-to-claim`.)","default":"round-robin","enum":["first-to-claim","round-robin"]},"users":{"type":"array","description":"An array of user IDs that will be members of this group.","items":{"type":"integer","format":"int32"}},"type":{"type":"string","description":"`Agent` groups allow admins and agents and `Lender` groups allow lender role users.","default":"Agent","enum":["Agent","Lender"]},"claimWindow":{"type":"integer","description":"Number of seconds to allow someone to claim a lead in a first-to-claim group before reassigning. The default is 30 minutes (1800 seconds) with a minimum of 1 minute and maximum of 30 minutes.","default":1800,"format":"int32"},"defaultGroupId":{"type":"integer","description":"The ID of the group to assign unclaimed first-to-claim leads to after the claim window expires.","format":"int32"},"defaultPondId":{"type":"integer","description":"The ID of the pond to assign unclaimed first-to-claim leads to after the claim window expires.","format":"int32"},"defaultUserId":{"type":"integer","description":"The ID of the user to assign unclaimed first-to-claim leads to after the claim window expires.","format":"int32"}}}}}},"responses":{"201":{"description":"201","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 63,\n  \"name\": \"Westside\",\n  \"type\": \"Agent\",\n  \"distribution\": \"round-robin\",\n  \"defaultUserId\": null,\n  \"defaultPondId\": null,\n  \"defaultGroupId\": null,\n  \"claimWindow\": 900,\n  \"nextRoundRobinUser\": 334,\n  \"isPrimary\": false,\n  \"users\": [\n    {\n      \"id\": 199,\n      \"name\": \"Daniel Corkill\",\n      \"firstName\": \"Daniel\",\n      \"lastName\": \"Corkill\",\n      \"role\": \"Broker\",\n      \"pauseLeadDistribution\": true\n    },\n    ...\n  ]\n}"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/groups/roundRobin":{"get":{"summary":"/groups/roundRobin","description":"Lists groups and includes round-robin data.","operationId":"groups-roundrobin-get","parameters":[{"name":"type","in":"query","description":"`Agent` groups allow admins and agents and `Lender` groups allow lender role users.","schema":{"type":"string","enum":["Agent","Lender"]}},{"name":"sort","in":"query","description":"Sorts results based on the provided field name. Prepending the field with a minus sign (-) sorts the results in descending order.","schema":{"type":"string","enum":["id","name"]}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"groups\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 41,\n    \"next\": \"eyJzaW5jZUlkIjo1ND0\",\n    \"nextLink\": \"https://api.followupboss.com/v1/groups/roundRobin?next=eyJzaW5jZUlkIjo1ND0\"\n  },\n  \"groups\": [\n    {\n      \"id\": 63,\n      \"name\": \"Eastside\",\n      \"type\": \"Agent\",\n      \"distribution\": \"round-robin\",\n      \"defaultUserId\": null,\n      \"defaultPondId\": null,\n      \"defaultGroupId\": null,\n      \"claimWindow\": 900,\n      \"nextRoundRobinUser\": 334,\n      \"isPrimary\": false,\n      \"users\": [\n        {\n          \"id\": 199,\n          \"name\": \"Daniel Corkill\",\n          \"firstName\": \"Daniel\",\n          \"lastName\": \"Corkill\",\n          \"role\": \"Broker\",\n          \"pauseLeadDistribution\": true\n        },\n        ...\n      ]\n    },\n    ...\n  ]\n}"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/groups/{id}":{"get":{"summary":"/groups/:id","description":"Retrieve a group by id.","operationId":"groups-id-get","parameters":[{"name":"id","in":"path","description":"The id of the group.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 63,\n  \"name\": \"Eastside\",\n  \"type\": \"Agent\",\n  \"distribution\": \"first-to-claim\",\n  \"defaultUserId\": null,\n  \"defaultPondId\": null,\n  \"defaultGroupId\": null,\n  \"claimWindow\": 900,\n  \"nextRoundRobinUser\": 334,\n  \"isPrimary\": false,\n  \"users\": [\n    {\n      \"id\": 199,\n      \"name\": \"Daniel Corkill\",\n      \"firstName\": \"Daniel\",\n      \"lastName\": \"Corkill\",\n      \"role\": \"Broker\",\n      \"pauseLeadDistribution\": true\n    },\n    ...\n  ]\n}"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"put":{"summary":"/groups/:id","description":"Update a group.","operationId":"groups-id-put","parameters":[{"name":"id","in":"path","description":"The id of the group.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","users"],"properties":{"name":{"type":"string","description":"The name of the group."},"distribution":{"type":"string","description":"The distribution model to utilize. Lender groups cannot be set to `first-to-claim`.","default":"round-robin","enum":["first-to-claim","round-robin"]},"users":{"type":"array","description":"An array of user IDs that will be members of this group.","items":{"type":"integer","format":"int32"}},"type":{"type":"string","description":"`Agent` groups allow admins and agents and `Lender` groups allow lender role users.","default":"Agent","enum":["Agent","Lender"]},"claimWindow":{"type":"integer","description":"Number of seconds to allow someone to claim a lead in a first-to-claim group before reassigning. The default is 30 minutes (1800 seconds) with a minimum of 1 minute and maximum of 30 minutes.","default":1800,"format":"int32"},"defaultGroupId":{"type":"integer","description":"The ID of the group to assign unclaimed first-to-claim leads to after the claim window expires.","format":"int32"},"defaultPondId":{"type":"integer","description":"The ID of the pond to assign unclaimed first-to-claim leads to after the claim window expires.","format":"int32"},"defaultUserId":{"type":"integer","description":"The ID of the user to assign unclaimed first-to-claim leads to after the claim window expires.","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 63,\n  \"name\": \"Westside\",\n  \"type\": \"Agent\",\n  \"distribution\": \"round-robin\",\n  \"defaultUserId\": null,\n  \"defaultPondId\": null,\n  \"defaultGroupId\": null,\n  \"claimWindow\": 900,\n  \"nextRoundRobinUser\": 334,\n  \"isPrimary\": false,\n  \"users\": [\n    {\n      \"id\": 199,\n      \"name\": \"Daniel Corkill\",\n      \"firstName\": \"Daniel\",\n      \"lastName\": \"Corkill\",\n      \"role\": \"Broker\",\n      \"pauseLeadDistribution\": true\n    },\n    ...\n  ]\n}"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"/groups/:id","description":"Delete a group.","operationId":"groups-id-delete","parameters":[{"name":"id","in":"path","description":"The ID of the group.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/teams":{"get":{"summary":"/teams","description":"Get a list of teams.","operationId":"teams-get","parameters":[{"name":"offset","in":"query","description":"Specifies the number of rows to skip before starting to return results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"teams\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 3,\n    \"next\": null,\n  },\n  \"teams\": [\n    {\n      \"id\": 8,\n      \"name\": \"Palm Beach Team\",\n      \"userIds\": [ 12, 14, 23 ],\n      \"leaderIds\": [ 14 ]\n    },\n    {\n      \"id\": 5,\n      \"name\": \"Orlando Team\",\n      \"userIds\": [ 11, 15 ],\n      \"leaderIds\": [ 11 ]\n    },\n    {\n      \"id\": 1,\n      \"name\": \"Company Team\",\n      \"userIds\": [ 11, 12, 14, 15, 23 ],\n      \"leaderIds\": [ 14 ]\n    }\n  ]\n}\n"}}}}}},"deprecated":false},"post":{"summary":"/teams","description":"Create a new team.","operationId":"teams-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","userIds"],"properties":{"name":{"type":"string","description":"The name of the team."},"userIds":{"type":"array","description":"An array of user IDs that will be member of this team.","items":{"type":"integer","format":"int32"}},"leaderIds":{"type":"array","description":"The complete list of team leaders.","items":{"type":"integer","format":"int32"}}}},"examples":{"Request Example":{"value":{"name":"Miami Team","userIds":[281,301,18]}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 24,\n  \"name\": \"Miami Team\",\n  \"userIds\": [\n    18,\n    281,\n    301\n  ],\n  \"leaderIds\": []\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":24,"default":0},"name":{"type":"string","example":"Miami Team"},"userIds":{"type":"array","items":{"type":"integer","example":18,"default":0}},"leaderIds":{"type":"array","items":{"type":"object","properties":{}}}}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Result":{"value":"{\"errorMessage\":\"You do not have access to teams.\"}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"You do not have access to teams."}}}}}}},"deprecated":false}},"/teams/{id}":{"get":{"summary":"/teams/:id","description":"Get a team by id.","operationId":"teams-id-get","parameters":[{"name":"id","in":"path","description":"The team id.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":" {\n      \"id\": 8,\n      \"name\": \"Palm Beach Team\",\n      \"userIds\": [ 12, 14, 23 ],\n      \"leaderIds\": [ 14 ]\n }"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":8,"default":0},"name":{"type":"string","example":"Palm Beach Team"},"userIds":{"type":"array","items":{"type":"integer","example":12,"default":0}},"leaderIds":{"type":"array","items":{"type":"integer","example":14,"default":0}}}}}}}},"deprecated":false},"put":{"summary":"/teams/:id","description":"Update a team by id.","operationId":"teams-id-put","parameters":[{"name":"id","in":"path","description":"The team id.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The team name."},"userIds":{"type":"array","description":"The complete list of members of this team.","items":{"type":"integer","format":"int32"}},"leaderIds":{"type":"array","description":"The complete list of team leaders.","items":{"type":"integer","format":"int32"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"name\": \"Miami Team\",\n  \"userIds\": [\n    18,\n    23,\n    281,\n    301\n  ],\n  \"leaderIds\": [23 ]\n}"}},"schema":{"type":"object","properties":{"name":{"type":"string","example":"Miami Team"},"userIds":{"type":"array","items":{"type":"integer","example":18,"default":0}},"leaderIds":{"type":"array","items":{"type":"integer","example":23,"default":0}}}}}}}},"deprecated":false},"delete":{"summary":"/teams/:id","description":"Delete a team by id.","operationId":"teams-id-delete","parameters":[{"name":"id","in":"path","description":"The team id.","schema":{"type":"string"},"required":true},{"name":"moveToTeamId","in":"query","description":"If you wish to merge two teams, use this parameter to indicate that all members of the current team should be made a member of the target team before this team is deleted.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/ponds":{"get":{"summary":"/ponds","description":"Get a list of ponds.","operationId":"ponds-get","parameters":[{"name":"offset","in":"query","description":"Specifies the number of rows to skip before starting to return results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"ponds\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 2\n  },\n  \"ponds\": [\n    {\n      \"id\": 23,\n      \"name\": \"Palm Beach Pond\",\n      \"userId\": 14,\n      \"userIds\": [ 14, 23, 24 ]\n    },\n    {\n      \"id\": 79,\n      \"name\": \"Miami Pond\",\n      \"userId\": 15,\n      \"userIds\": [ 26, 23, 15 ]\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"_metadata":{"type":"object","properties":{"collection":{"type":"string","example":"ponds"},"offset":{"type":"integer","example":0,"default":0},"limit":{"type":"integer","example":10,"default":0},"total":{"type":"integer","example":2,"default":0}}},"ponds":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":23,"default":0},"name":{"type":"string","example":"Palm Beach Pond"},"userId":{"type":"integer","example":14,"default":0},"userIds":{"type":"array","items":{"type":"integer","example":14,"default":0}}}}}}}}}}},"deprecated":false},"post":{"summary":"/ponds","description":"Create a pond.","operationId":"ponds-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","userId","userIds"],"properties":{"name":{"type":"string","description":"The name of the pond you want to create"},"userId":{"type":"integer","description":"The Pond Lead Agent","format":"int32"},"userIds":{"type":"array","description":"IDs of all users to add as members of the pond","items":{"type":"integer","format":"int32"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 83,\n  \"name\": \"Orlando Pond\",\n  \"userId\": 327,\n  \"userIds\": [ 281, 301, 327 ]\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":83,"default":0},"name":{"type":"string","example":"Orlando Pond"},"userId":{"type":"integer","example":327,"default":0},"userIds":{"type":"array","items":{"type":"integer","example":281,"default":0}}}}}}}},"deprecated":false}},"/ponds/{id}":{"get":{"summary":"/ponds/:id","description":"Get a pond by id.","operationId":"ponds-id-get","parameters":[{"name":"id","in":"path","description":"The pond id.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":" {\n      \"id\": 23,\n      \"name\": \"Palm Beach Pond\",\n      \"userId\": 14,\n      \"userIds\": [ 14, 23, 24 ]\n }"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":23,"default":0},"name":{"type":"string","example":"Palm Beach Pond"},"userId":{"type":"integer","example":14,"default":0},"userIds":{"type":"array","items":{"type":"integer","example":14,"default":0}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"put":{"summary":"/ponds/:id","description":"Update a pond by id.","operationId":"ponds-id-put","parameters":[{"name":"id","in":"path","description":"The pond id.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Set this value to change the name of the Pond"},"userId":{"type":"string","description":"Set this value to change the Pond Lead Agent"},"userIds":{"type":"string","description":"Set this value to add or remove members from the pond"}}},"examples":{"Request Example":{"value":{"name":"Orlando Pond","userId":281,"userIds":[281,301]}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 83,\n  \"name\": \"Orlando Pond\",\n  \"userId\": 281,\n  \"userIds\": [ 281, 301 ]\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":83,"default":0},"name":{"type":"string","example":"Orlando Pond"},"userId":{"type":"integer","example":281,"default":0},"userIds":{"type":"array","items":{"type":"integer","example":281,"default":0}}}}}}}},"deprecated":false},"delete":{"summary":"/ponds/:id","description":"Delete a pond by id.","operationId":"ponds-id-delete","parameters":[{"name":"assignTo","in":"query","description":"Select which agent should receive any contacts currently in this pond after it is deleted.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"id","in":"path","description":"The pond id.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"//textMessageTemplates":{"post":{"summary":"/textMessageTemplates","description":"Create a text message template.","operationId":"textmessagetemplates-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","message"],"properties":{"name":{"type":"string","description":"The name of your text message template."},"message":{"type":"string","description":"The body of your text message template."},"isShared":{"type":"boolean","description":"Set to true if this template should be shared with other users in the same Follow Up Boss account."}}},"examples":{"Request Example":{"value":{"name":"Beach House promo","message":"%greeting_time%, %contact_first_name%\n\nCheck out this beach house: https://example.com","isShared":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 182,\n  \"name\": \"Beach House promo\",\n  \"totalSent\": 0,\n  \"totalReplies\": 0,\n  \"message\": \"%greeting_time%, %contact_first_name%\\n\\nCheck out this beach house: https://example.com\",\n  \"isShared\": true,\n  \"createdBy\": 15,\n  \"isEditable\": true,\n  \"isShareable\": true,\n  \"isDeletable\": true,\n  \"categories\": [],\n  \"sentPeopleCount\": 0,\n  \"actionPlans\": [],\n  \"effectivenessScore\": null,\n  \"windowedSent\": 0,\n  \"windowedReplies\": 0,\n  \"windowedOptOutRate\": null,\n  \"totalOptOutRate\": null\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":182,"default":0},"name":{"type":"string","example":"Beach House promo"},"totalSent":{"type":"integer","example":0,"default":0},"totalReplies":{"type":"integer","example":0,"default":0},"message":{"type":"string","example":"%greeting_time%, %contact_first_name%\n\nCheck out this beach house: https://example.com"},"isShared":{"type":"boolean","example":true,"default":true},"createdBy":{"type":"integer","example":15,"default":0},"isEditable":{"type":"boolean","example":true,"default":true},"isShareable":{"type":"boolean","example":true,"default":true},"isDeletable":{"type":"boolean","example":true,"default":true},"categories":{"type":"array","items":{"type":"object","properties":{}}},"sentPeopleCount":{"type":"integer","example":0,"default":0},"actionPlans":{"type":"array","items":{"type":"object","properties":{}}},"effectivenessScore":{},"windowedSent":{"type":"integer","example":0,"default":0},"windowedReplies":{"type":"integer","example":0,"default":0},"windowedOptOutRate":{},"totalOptOutRate":{}}}}}}},"deprecated":false}},"/dealCustomFields":{"get":{"summary":"/dealCustomFields","description":"List all deals custom fields available in your account.","operationId":"dealcustomfields-get","parameters":[{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip, before starting to return results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"label","in":"query","description":"Find custom field by label.","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sorts results based on the provided field name. Prepending the field with a minus sign (-) sorts the results in descending order.","schema":{"type":"string","enum":["id","name","orderWeight"],"default":"id (desc)"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"dealCustomfields\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": \"4\"\n  },\n  \"dealCustomfields\": [\n    {\n      \"id\": 2,\n      \"label\": \"Birthday\",\n      \"name\": \"customBirthday\",\n      \"type\": \"date\",\n      \"orderWeight\": 1,\n      \"hideIfEmpty\": true,\n      \"readOnly\": false\n    },\n    {\n      \"id\": 4,\n      \"label\": \"Facebook\",\n      \"name\": \"customFacebook\",\n      \"type\": \"text\",\n      \"orderWeight\": 2,\n      \"hideIfEmpty\": true,\n      \"readOnly\": false\n    },\n    {\n      \"id\": 6,\n      \"label\": \"Looking for\",\n      \"name\": \"customLookingFor\",\n      \"type\": \"dropdown\",\n      \"choices\": [\n          \"Apartment\",\n          \"Townhouse\",\n          \"Detached House\"\n      ],\n      \"orderWeight\": 3,\n      \"hideIfEmpty\": false,\n      \"readOnly\": false\n    },\n    {\n      \"id\": 7,\n      \"label\": \"Close price\",\n      \"name\": \"customClosePrice\",\n      \"type\": \"number\",\n      \"orderWeight\": 4,\n      \"hideIfEmpty\": true,\n      \"readOnly\": false\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"_metadata":{"type":"object","properties":{"collection":{"type":"string","example":"dealCustomfields"},"offset":{"type":"integer","example":0,"default":0},"limit":{"type":"integer","example":10,"default":0},"total":{"type":"string","example":"4"}}},"dealCustomfields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":2,"default":0},"label":{"type":"string","example":"Birthday"},"name":{"type":"string","example":"customBirthday"},"type":{"type":"string","example":"date"},"orderWeight":{"type":"integer","example":1,"default":0},"hideIfEmpty":{"type":"boolean","example":true,"default":true},"readOnly":{"type":"boolean","example":false,"default":true}}}}}}}}}},"deprecated":false},"post":{"summary":"/dealCustomFields","description":"Create a deals custom field.","operationId":"dealcustomfields-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["label","type"],"properties":{"label":{"type":"string","description":"The user-friendly name of the custom field (e.g., \"Anniversary\")."},"type":{"type":"string","description":"The type of deals custom field.","enum":["text","date","number","dropdown"]},"choices":{"type":"array","description":"Array of options related to a deals custom field of type `Dropdown`.","items":{"type":"string"}},"isRecurring":{"type":"boolean","description":"Whether a date field occurs every year (e.g. birthdays, anniversaries, etc.).","default":false},"hideIfEmpty":{"type":"boolean","description":"Sets whether we will hide this field if it is empty.","default":false},"orderWeight":{"type":"integer","description":"A weighted integer for the field to assign values for custom sorting.","default":0,"format":"int32"},"readOnly":{"type":"boolean","description":"Determines whether a deals custom field is read only.","default":false}}},"examples":{"Request Example":{"value":{"label":"Birthday","name":"customBirthday","type":"date","isRecurring":true,"orderWeight":1,"hideIfEmpty":true,"readOnly":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 2,\n  \"label\": \"Birthday\",\n  \"name\": \"customBirthday\",\n  \"type\": \"date\",\n  \"isRecurring\": true,\n  \"orderWeight\": 1,\n  \"hideIfEmpty\": true,\n  \"readOnly\": false\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":2,"default":0},"label":{"type":"string","example":"Birthday"},"name":{"type":"string","example":"customBirthday"},"type":{"type":"string","example":"date"},"isRecurring":{"type":"boolean","example":true,"default":true},"orderWeight":{"type":"integer","example":1,"default":0},"hideIfEmpty":{"type":"boolean","example":true,"default":true},"readOnly":{"type":"boolean","example":false,"default":true}}}}}}},"deprecated":false}},"/dealCustomFields/{id}":{"get":{"summary":"/dealCustomFields/:id","description":"Get a deals custom field by ID.","operationId":"dealcustomfields-id-get","parameters":[{"name":"id","in":"path","description":"The id of a deals custom field.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 6,\n    \"label\": \"Looking for\",\n    \"name\": \"customLookingFor\",\n    \"type\": \"dropdown\",\n    \"choices\": [\n        \"Apartment\",\n        \"Townhouse\",\n        \"Detached House\"\n    ],\n    \"orderWeight\": 1,\n    \"hideIfEmpty\": true,\n    \"readOnly\": false\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":6,"default":0},"label":{"type":"string","example":"Looking for"},"name":{"type":"string","example":"customLookingFor"},"type":{"type":"string","example":"dropdown"},"choices":{"type":"array","items":{"type":"string","example":"Apartment"}},"orderWeight":{"type":"integer","example":1,"default":0},"hideIfEmpty":{"type":"boolean","example":true,"default":true},"readOnly":{"type":"boolean","example":false,"default":true}}}}}}},"deprecated":false},"put":{"summary":"/dealCustomFields/:id","description":"Update a deals custom field.","operationId":"dealcustomfields-id-put","parameters":[{"name":"id","in":"path","description":"The id of the deals custom field.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["label","type"],"properties":{"label":{"type":"string","description":"The user-friendly name of the custom field (e.g., \"Anniversary\")."},"type":{"type":"string","description":"The type of deals custom field.","enum":["text","date","number","dropdown"]},"choices":{"type":"array","description":"Array of options related to a deals custom field of type `Dropdown`.","items":{"type":"string"}},"isRecurring":{"type":"boolean","description":"Whether a date field occurs every year (e.g. birthdays, anniversaries, etc.).","default":false},"hideIfEmpty":{"type":"boolean","description":"Sets whether we will hide this field if it is empty.","default":false},"orderWeight":{"type":"integer","description":"A weighted integer for the field to assign values for custom sorting.","default":0,"format":"int32"},"dropdownChoiceMap":{"type":"array","description":"An optional mapping that points previous dropdown choices (keys) to their new positions (values). This is used to track when options get moved or renamed. If items are missing from the keys, they will be removed. If the mapping is not supplied, then this endpoint will try to determine if items have been moved or renamed on its own.","default":[null],"items":{"type":"integer","format":"int32"}},"readOnly":{"type":"boolean","description":"Sets whether the field is read only or not.","default":false}}},"examples":{"Request Example":{"value":{"label":"Birthday","type":"date","isRecurring":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": 2,\n  \"label\": \"Birthday\",\n  \"name\": \"customBirthday\",\n  \"type\": \"date\",\n  \"isRecurring\": false,\n  \"orderWeight\": 1,\n  \"hideIfEmpty\": true,\n  \"readOnly\": false\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":2,"default":0},"label":{"type":"string","example":"Birthday"},"name":{"type":"string","example":"customBirthday"},"type":{"type":"string","example":"date"},"isRecurring":{"type":"boolean","example":false,"default":true},"orderWeight":{"type":"integer","example":1,"default":0},"hideIfEmpty":{"type":"boolean","example":true,"default":true},"readOnly":{"type":"boolean","example":false,"default":true}}}}}}},"deprecated":false},"delete":{"summary":"/dealCustomFields/:id","description":"Delete a deals custom field.","operationId":"dealcustomfields-id-delete","parameters":[{"name":"id","in":"path","description":"The id of the deals custom field.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":""}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/appointmentTypes":{"get":{"summary":"/appointmentTypes","description":"List appointment types.","operationId":"appointmenttypes-get","parameters":[{"name":"sort","in":"query","description":"The sort order can be one of the following: `id`, `name`, `orderWeight` (Note: Prefix the string with a minus (`-`) to sort in descending order (e.g., `-orderWeight`)).","schema":{"type":"string","default":"orderWeight"}},{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip before starting to return results.","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"appointmenttypes\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 2,\n    \"next\": null,\n    \"nextLink\": null\n  },\n  \"appointmenttypes\": [\n    {\n      \"id\": 1,\n      \"name\": \"Buyer consultation\",\n      \"orderWeight\": 1000\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Listing\",\n      \"orderWeight\": 2000\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"_metadata":{"type":"object","properties":{"collection":{"type":"string","example":"appointmenttypes"},"offset":{"type":"integer","example":0,"default":0},"limit":{"type":"integer","example":10,"default":0},"total":{"type":"integer","example":2,"default":0},"next":{},"nextLink":{}}},"appointmenttypes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"Buyer consultation"},"orderWeight":{"type":"integer","example":1000,"default":0}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Bad Request (Invalid Fields)":{"value":"{\n  \"errorMessage\": \"Invalid field(s) in the fields parameter: [list of invalid fields]\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"Invalid field(s) in the fields parameter: [list of invalid fields]"}}}}}}},"deprecated":false},"post":{"summary":"/appointmentTypes","description":"Create an appointment type.","operationId":"appointmenttypes-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the appointment type."},"orderWeight":{"type":"integer","description":"Set this value to enforce a specific sort order.","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK":{"value":"{\n  \"id\": 3,\n  \"name\": \"Test Type\",\n  \"orderWeight\": 1000\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":3,"default":0},"name":{"type":"string","example":"Test Type"},"orderWeight":{"type":"integer","example":1000,"default":0}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Bad Request (Invalid Body Fields)":{"value":"{\n  \"errorMessage\": \"Invalid fields in the request body: [list of invalid fields]\"\n}"},"Bad Request (Invalid Field Data Type)":{"value":"{\n    \"errorMessage\": \"Expected field '[fieldName]' to be of data type [dataType].\"\n}"}},"schema":{"oneOf":[{"title":"Bad Request (Invalid Body Fields)","type":"object","properties":{"errorMessage":{"type":"string","example":"Invalid fields in the request body: [list of invalid fields]"}}},{"title":"Bad Request (Invalid Field Data Type)","type":"object","properties":{"errorMessage":{"type":"string","example":"Expected field '[fieldName]' to be of data type [dataType]."}}}]}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Forbidden":{"value":"{\n    \"errorMessage\": \"You do not have access to update appointment types.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"You do not have access to update appointment types."}}}}}}},"deprecated":false}},"/appointmentTypes/{id}":{"get":{"summary":"/appointmentTypes/:id","description":"Retrieve an appointment type by ID","operationId":"appointmenttypes-id-get","parameters":[{"name":"id","in":"path","description":"The id of the appointment type.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK":{"value":"{\n  \"id\": 3,\n  \"name\": \"Test Type\",\n  \"orderWeight\": 1000\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":3,"default":0},"name":{"type":"string","example":"Test Type"},"orderWeight":{"type":"integer","example":1000,"default":0}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Bad Request (Invalid Fields)":{"value":"{\n    \"errorMessage\": \"Invalid field(s) in the fields parameter: [list of invalid fields]\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"Invalid field(s) in the fields parameter: [list of invalid fields]"}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Not Found":{"value":"{\n  \"errorMessage\": \"Requested resource was not found.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"Requested resource was not found."}}}}}}},"deprecated":false},"put":{"summary":"/appointmentTypes/:id","description":"Update an appointment type.","operationId":"appointmenttypes-id-put","parameters":[{"name":"id","in":"path","description":"ID of the appointment type.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the appointment type."},"orderWeight":{"type":"integer","description":"Set this value to enforce a specific sort order.","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK":{"value":"{\n  \"id\": 3,\n  \"name\": \"Test Type\",\n  \"orderWeight\": 1000\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":3,"default":0},"name":{"type":"string","example":"Test Type"},"orderWeight":{"type":"integer","example":1000,"default":0}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Bad Request (Invalid Body Fields)":{"value":"{\n  \"errorMessage\": \"Invalid fields in the request body: [list of invalid fields]\"\n}"},"Bad Request (Invalid Field Data Type)":{"value":"{\n    \"errorMessage\": \"Expected field '[fieldName]' to be of data type [dataType].\"\n}"}},"schema":{"oneOf":[{"title":"Bad Request (Invalid Body Fields)","type":"object","properties":{"errorMessage":{"type":"string","example":"Invalid fields in the request body: [list of invalid fields]"}}},{"title":"Bad Request (Invalid Field Data Type)","type":"object","properties":{"errorMessage":{"type":"string","example":"Expected field '[fieldName]' to be of data type [dataType]."}}}]}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Forbidden":{"value":"{\n    \"errorMessage\": \"You do not have access to update appointment types.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"You do not have access to update appointment types."}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Not Found":{"value":"{\n  \"errorMessage\": \"Requested resource was not found.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"Requested resource was not found."}}}}}}},"deprecated":false},"delete":{"summary":"/appointmentTypes/:id","description":"Delete an appointment type.","operationId":"appointmenttypes-id-delete","parameters":[{"name":"id","in":"path","description":"The id of the appointment type.","schema":{"type":"integer","format":"int32"},"required":true},{"name":"assignTypeId","in":"query","description":"The typeId to reassign existing appointments.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK":{"value":"[]"}},"schema":{"type":"array","items":{"type":"object","properties":{}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Bad Request (Missing Fields)":{"value":"{\n  \"errorMessage\": \"Missing 'assignTypeId' field.\"\n}"},"Bad Request (Invalid assignTypeId)":{"value":"{\n  \"errorMessage\": \"No type found for given 'assignTypeId' field.\"\n}"}},"schema":{"oneOf":[{"title":"Bad Request (Missing Fields)","type":"object","properties":{"errorMessage":{"type":"string","example":"Missing 'assignTypeId' field."}}},{"title":"Bad Request (Invalid assignTypeId)","type":"object","properties":{"errorMessage":{"type":"string","example":"No type found for given 'assignTypeId' field."}}}]}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Forbidden":{"value":"{\n  \"errorMessage\": \"You do not have access to delete appointment types.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"You do not have access to delete appointment types."}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Not Found":{"value":"{\n  \"errorMessage\": \"Requested resource was not found.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"Requested resource was not found."}}}}}}},"deprecated":false}},"/appointmentOutcomes":{"get":{"summary":"/appointmentOutcomes","description":"List appointment outcomes.","operationId":"appointmentoutcomes-get","parameters":[{"name":"sort","in":"query","description":"The sort order can be one of the following: `id`, `name`, `orderWeight` (Note: Prefix the string with a minus (`-`) to sort in descending order (e.g., `-orderWeight`)).","schema":{"type":"string","default":"orderWeight"}},{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip before starting to return results.","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK":{"value":"{\n  \"_metadata\": {\n    \"collection\": \"appointmentoutcomes\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 3,\n    \"next\": null,\n    \"nextLink\": null\n  },\n  \"appointmentoutcomes\": [\n    {\n      \"id\": 1,\n      \"name\": \"No show\",\n      \"orderWeight\": 1000\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Working with buyers\",\n      \"orderWeight\": 2000\n    },\n    {\n      \"id\": 3,\n      \"name\": \"Listing obtained\",\n      \"orderWeight\": 3000\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"_metadata":{"type":"object","properties":{"collection":{"type":"string","example":"appointmentoutcomes"},"offset":{"type":"integer","example":0,"default":0},"limit":{"type":"integer","example":10,"default":0},"total":{"type":"integer","example":3,"default":0},"next":{},"nextLink":{}}},"appointmentoutcomes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"No show"},"orderWeight":{"type":"integer","example":1000,"default":0}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Bad Request (Invalid Fields)":{"value":"{\n  \"errorMessage\": \"Invalid field(s) in the fields parameter: [list of invalid fields]\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"Invalid field(s) in the fields parameter: [list of invalid fields]"}}}}}}},"deprecated":false},"post":{"summary":"/appointmentOutcomes","description":"Create an appointment outcome.","operationId":"appointmentoutcomes-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the appointment outcome."},"orderWeight":{"type":"integer","description":"Set this value to enforce a specific sort order.","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK":{"value":"{\n  \"id\": 3,\n  \"name\": \"Test Outcome\",\n  \"orderWeight\": 3000\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":3,"default":0},"name":{"type":"string","example":"Test Outcome"},"orderWeight":{"type":"integer","example":3000,"default":0}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Bad Request (Invalid Body Fields)":{"value":"{\n  \"errorMessage\": \"Invalid fields in the request body: [list of invalid fields]\"\n}"},"Bad Request (Invalid Field Data Type)":{"value":"{\n    \"errorMessage\": \"Expected field '[fieldName]' to be of data type [dataType].\"\n}"}},"schema":{"oneOf":[{"title":"Bad Request (Invalid Body Fields)","type":"object","properties":{"errorMessage":{"type":"string","example":"Invalid fields in the request body: [list of invalid fields]"}}},{"title":"Bad Request (Invalid Field Data Type)","type":"object","properties":{"errorMessage":{"type":"string","example":"Expected field '[fieldName]' to be of data type [dataType]."}}}]}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Forbidden":{"value":"{\n    \"errorMessage\": \"You do not have access to update appointment outcomes.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"You do not have access to update appointment outcomes."}}}}}}},"deprecated":false}},"/appointmentOutcomes/{id}":{"get":{"summary":"/appointmentOutcomes/:id","description":"Retrieve an appointment outcome by ID.","operationId":"appointmentoutcomes-id-get","parameters":[{"name":"id","in":"path","description":"The id of the appointment outcome.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK":{"value":"{\n  \"id\": 3,\n  \"name\": \"Test Outcome\",\n  \"orderWeight\": 3000\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":3,"default":0},"name":{"type":"string","example":"Test Outcome"},"orderWeight":{"type":"integer","example":3000,"default":0}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Bad Request (Invalid Fields)":{"value":"{\n    \"errorMessage\": \"Invalid field(s) in the fields parameter: [list of invalid fields]\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"Invalid field(s) in the fields parameter: [list of invalid fields]"}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Not Found":{"value":"{\n  \"errorMessage\": \"Requested resource was not found.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"Requested resource was not found."}}}}}}},"deprecated":false},"put":{"summary":"/appointmentOutcomes/:id","description":"Update an appointment outcome.","operationId":"appointmentoutcomes-id-put","parameters":[{"name":"id","in":"path","description":"The id of the appointment outcome.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the appointment outcome."},"orderWeight":{"type":"integer","description":"Set this value to enforce a specific sort order.","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK":{"value":"{\n  \"id\": 3,\n  \"name\": \"Test Outcome\",\n  \"orderWeight\": 3000\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":3,"default":0},"name":{"type":"string","example":"Test Outcome"},"orderWeight":{"type":"integer","example":3000,"default":0}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Bad Request (Invalid Body Fields)":{"value":"{\n  \"errorMessage\": \"Invalid fields in the request body: [list of invalid fields]\"\n}"},"Bad Request (Invalid Field Data Type)":{"value":"{\n    \"errorMessage\": \"Expected field '[fieldName]' to be of data type [dataType].\"\n}"}},"schema":{"oneOf":[{"title":"Bad Request (Invalid Body Fields)","type":"object","properties":{"errorMessage":{"type":"string","example":"Invalid fields in the request body: [list of invalid fields]"}}},{"title":"Bad Request (Invalid Field Data Type)","type":"object","properties":{"errorMessage":{"type":"string","example":"Expected field '[fieldName]' to be of data type [dataType]."}}}]}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Forbidden":{"value":"{\n    \"errorMessage\": \"You do not have access to update appointment outcomes.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"You do not have access to update appointment outcomes."}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Not Found":{"value":"{\n  \"errorMessage\": \"Requested resource was not found.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"Requested resource was not found."}}}}}}},"deprecated":false},"delete":{"summary":"/appointmentOutcomes/:id","description":"Delete an appointment outcome.","operationId":"appointmentoutcomes-id-delete","parameters":[{"name":"id","in":"path","description":"ID of the appointment outcome.","schema":{"type":"integer","format":"int32"},"required":true},{"name":"assignOutcomeId","in":"query","description":"The outcomeId to reassign existing appointments","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK":{"value":"[]"}},"schema":{"type":"array","items":{"type":"object","properties":{}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Bad Request (Missing Fields)":{"value":"{\n  \"errorMessage\": \"Missing 'assignOutcomeId' field.\"\n}"},"Bad Request (Invalid assignOutcomeId)":{"value":"{\n  \"errorMessage\": \"No type found for given 'assignOutcomeId' field.\"\n}"}},"schema":{"oneOf":[{"title":"Bad Request (Missing Fields)","type":"object","properties":{"errorMessage":{"type":"string","example":"Missing 'assignOutcomeId' field."}}},{"title":"Bad Request (Invalid assignOutcomeId)","type":"object","properties":{"errorMessage":{"type":"string","example":"No type found for given 'assignOutcomeId' field."}}}]}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Forbidden":{"value":"{\n  \"errorMessage\": \"You do not have access to delete appointment outcomes.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"You do not have access to delete appointment outcomes."}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Not Found":{"value":"{\n  \"errorMessage\": \"Requested resource was not found.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"Requested resource was not found."}}}}}}},"deprecated":false}},"/personAttachments":{"post":{"summary":"/personAttachments","description":"Attach a file to a person.","operationId":"personattachments-post","parameters":[{"name":"X-System","in":"header","description":"Registered system name.","required":true,"schema":{"type":"string"}},{"name":"X-System-Key","in":"header","description":"Registered system API key.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["personId","uri","fileName"],"properties":{"personId":{"type":"integer","description":"ID of the person.","format":"int32"},"uri":{"type":"string","description":"URI of an externally hosted file."},"fileName":{"type":"string","description":"Name of the file."},"fileSize":{"type":"integer","description":"Size of the file in bytes.","format":"int32"}}}}}},"responses":{"201":{"description":"201","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"personId\": 1,\n    \"fileName\": \"test.jpg\",\n    \"fileSize\": null,\n    \"id\": 2,\n    \"mimeType\": \"link\",\n    \"uri\": \"https://test.com/myfile\",\n    \"thumbnailUri\": null,\n    \"status\": \"created\",\n    \"createdAt\": \"2022-11-16T03:44:52Z\",\n    \"createdById\": 1,\n    \"createdByName\": \"Olivia Admin\"\n}"}},"schema":{"type":"object","properties":{"personId":{"type":"integer","example":1,"default":0},"fileName":{"type":"string","example":"test.jpg"},"fileSize":{},"id":{"type":"integer","example":2,"default":0},"mimeType":{"type":"string","example":"link"},"uri":{"type":"string","example":"https://test.com/myfile"},"thumbnailUri":{},"status":{"type":"string","example":"created"},"createdAt":{"type":"string","example":"2022-11-16T03:44:52Z"},"createdById":{"type":"integer","example":1,"default":0},"createdByName":{"type":"string","example":"Olivia Admin"}}}}}},"403":{"description":"403","content":{"text/plain":{"examples":{"Result":{"value":"{\n    \"errorMessage\": \"You do not have access to this endpoint.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"You do not have access to this endpoint."}}}}}}},"deprecated":false}},"/dealAttachments":{"post":{"summary":"/dealAttachments","description":"Add an attachment to a deal.","operationId":"dealattachments-post","parameters":[{"name":"X-System","in":"header","description":"Registered system name.","required":true,"schema":{"type":"string"}},{"name":"X-System-Key","in":"header","description":"Registered system API key.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["dealId","uri","fileName"],"properties":{"dealId":{"type":"integer","description":"The id of the deal you want to add an attachment to.","format":"int32"},"uri":{"type":"string","description":"The URI of an **externally** hosted file."},"fileName":{"type":"string","description":"Name of the file."},"fileSize":{"type":"integer","description":"Size of the file in bytes.","format":"int32"}}}}}},"responses":{"201":{"description":"201","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"dealId\": 1,\n    \"fileName\": \"test.jpg\",\n    \"fileSize\": null,\n    \"id\": 10,\n    \"mimeType\": \"link\",\n    \"uri\": \"https://test.com/myfile\",\n    \"thumbnailUri\": null,\n    \"status\": \"created\",\n    \"createdAt\": \"2022-11-16T19:09:45Z\",\n    \"createdById\": 1,\n    \"createdByName\": \"Olivia Admin\"\n}"}},"schema":{"type":"object","properties":{"dealId":{"type":"integer","example":1,"default":0},"fileName":{"type":"string","example":"test.jpg"},"fileSize":{},"id":{"type":"integer","example":10,"default":0},"mimeType":{"type":"string","example":"link"},"uri":{"type":"string","example":"https://test.com/myfile"},"thumbnailUri":{},"status":{"type":"string","example":"created"},"createdAt":{"type":"string","example":"2022-11-16T19:09:45Z"},"createdById":{"type":"integer","example":1,"default":0},"createdByName":{"type":"string","example":"Olivia Admin"}}}}}},"403":{"description":"403","content":{"text/plain":{"examples":{"Result":{"value":"{\n    \"errorMessage\": \"You do not have access to this endpoint.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"You do not have access to this endpoint."}}}}}}},"deprecated":false}},"/personAttachments/{id}":{"get":{"summary":"/personAttachments/:id","description":"Retrieve an attachment by ID.","operationId":"personattachments-id-get","parameters":[{"name":"X-System","in":"header","description":"Registered system name.","required":true,"schema":{"type":"string"}},{"name":"X-System-Key","in":"header","description":"Registered system API key.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"ID of the attachment.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"personId\": 1,\n    \"fileName\": \"test.jpg\",\n    \"fileSize\": null,\n    \"id\": 2,\n    \"mimeType\": \"link\",\n    \"uri\": \"https://test.com/myfile\",\n    \"thumbnailUri\": null,\n    \"status\": \"created\",\n    \"createdAt\": \"2022-11-16T03:44:52Z\",\n    \"createdById\": 1,\n    \"createdByName\": \"Olivia Admin\",\n    \"is_external\": 1,\n    \"system_id\": 123\n}"}},"schema":{"type":"object","properties":{"personId":{"type":"integer","example":1,"default":0},"fileName":{"type":"string","example":"test.jpg"},"fileSize":{},"id":{"type":"integer","example":2,"default":0},"mimeType":{"type":"string","example":"link"},"uri":{"type":"string","example":"https://test.com/myfile"},"thumbnailUri":{},"status":{"type":"string","example":"created"},"createdAt":{"type":"string","example":"2022-11-16T03:44:52Z"},"createdById":{"type":"integer","example":1,"default":0},"createdByName":{"type":"string","example":"Olivia Admin"},"is_external":{"type":"integer","example":1,"default":0},"system_id":{"type":"integer","example":123,"default":0}}}}}},"403":{"description":"403","content":{"text/plain":{"examples":{"Result":{"value":"Third parties are not authorized to upload attachments via the API."}}}}}},"deprecated":false},"put":{"summary":"/personAttachments/:id","description":"Update an attachment by ID.","operationId":"personattachments-id-put","parameters":[{"name":"X-System","in":"header","description":"Registered system name.","required":true,"schema":{"type":"string"}},{"name":"X-System-Key","in":"header","description":"Registered system API key.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"ID of the attachment.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["personId","uri","fileName"],"properties":{"personId":{"type":"integer","description":"ID of the person.","format":"int32"},"uri":{"type":"string","description":"URI of an externally hosted file."},"fileName":{"type":"string","description":"Name of the file."},"fileSize":{"type":"integer","description":"Size of the file in bytes.","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"personId\": 1,\n    \"fileName\": \"test.jpg\",\n    \"fileSize\": null,\n    \"id\": 2,\n    \"mimeType\": \"link\",\n    \"uri\": \"https://test.com/myfile\",\n    \"thumbnailUri\": null,\n    \"status\": \"created\",\n    \"createdAt\": \"2022-11-16T03:44:52Z\",\n    \"createdById\": 1,\n    \"createdByName\": \"Olivia Admin\"\n}"}},"schema":{"type":"object","properties":{"personId":{"type":"integer","example":1,"default":0},"fileName":{"type":"string","example":"test.jpg"},"fileSize":{},"id":{"type":"integer","example":2,"default":0},"mimeType":{"type":"string","example":"link"},"uri":{"type":"string","example":"https://test.com/myfile"},"thumbnailUri":{},"status":{"type":"string","example":"created"},"createdAt":{"type":"string","example":"2022-11-16T03:44:52Z"},"createdById":{"type":"integer","example":1,"default":0},"createdByName":{"type":"string","example":"Olivia Admin"}}}}}},"403":{"description":"403","content":{"text/plain":{"examples":{"Result":{"value":"{\n    \"errorMessage\": \"You do not have access to this API endpoint.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"You do not have access to this API endpoint."}}}}}},"404":{"description":"404","content":{"text/plain":{"examples":{"Result":{"value":"{\n    \"errorMessage\": \"Requested resource was not found.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"Requested resource was not found."}}}}}}},"deprecated":false},"delete":{"summary":"/personAttachments/:id","description":"Delete an attachment by ID.","operationId":"personattachments-id-delete","parameters":[{"name":"X-System","in":"header","description":"Registered system name.","required":true,"schema":{"type":"string"}},{"name":"X-System-Key","in":"header","description":"Registered system API key.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"ID of the attachment.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"403":{"description":"403","content":{"text/plain":{"examples":{"Result":{"value":"{\n    \"errorMessage\": \"You do not have access to this API endpoint.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"You do not have access to this API endpoint."}}}}}},"404":{"description":"404","content":{"text/plain":{"examples":{"Result":{"value":"{\n    \"errorMessage\": \"Requested resource was not found.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"Requested resource was not found."}}}}}}},"deprecated":false}},"/dealAttachments/{id}":{"put":{"summary":"/dealAttachments/:id","description":"Update a deal attachment.","operationId":"dealattachments-id-put","parameters":[{"name":"X-System","in":"header","description":"Registered system name.","required":true,"schema":{"type":"string"}},{"name":"X-System-Key","in":"header","description":"Registered system API key.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The id of the attachment.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["dealId","uri","fileName"],"properties":{"dealId":{"type":"integer","description":"The id of the deal you want to update the attachment to.","format":"int32"},"uri":{"type":"string","description":"The URI of an **externally** hosted file."},"fileName":{"type":"string","description":"Name of the file."},"fileSize":{"type":"integer","description":"Size of the file in bytes.","format":"int32"}}}}}},"responses":{"201":{"description":"201","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"dealId\": 1,\n    \"fileName\": \"test.jpg\",\n    \"fileSize\": null,\n    \"id\": 10,\n    \"mimeType\": \"link\",\n    \"uri\": \"https://test.com/myfile\",\n    \"thumbnailUri\": null,\n    \"status\": \"created\",\n    \"createdAt\": \"2022-11-16T19:09:45Z\",\n    \"createdById\": 1,\n    \"createdByName\": \"Olivia Admin\"\n}"}},"schema":{"type":"object","properties":{"dealId":{"type":"integer","example":1,"default":0},"fileName":{"type":"string","example":"test.jpg"},"fileSize":{},"id":{"type":"integer","example":10,"default":0},"mimeType":{"type":"string","example":"link"},"uri":{"type":"string","example":"https://test.com/myfile"},"thumbnailUri":{},"status":{"type":"string","example":"created"},"createdAt":{"type":"string","example":"2022-11-16T19:09:45Z"},"createdById":{"type":"integer","example":1,"default":0},"createdByName":{"type":"string","example":"Olivia Admin"}}}}}},"403":{"description":"403","content":{"text/plain":{"examples":{"Result":{"value":"{\n    \"errorMessage\": \"You do not have access to this endpoint.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"You do not have access to this endpoint."}}}}}}},"deprecated":false},"get":{"summary":"/dealAttachments/:id","description":"Get a deal attachment by id.","operationId":"dealattachments-id-get","parameters":[{"name":"X-System","in":"header","description":"Registered system name.","required":true,"schema":{"type":"string"}},{"name":"X-System-Key","in":"header","description":"Registered system API key.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The id of the attachment.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"201":{"description":"201","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"dealId\": 1,\n    \"fileName\": \"test.jpg\",\n    \"fileSize\": null,\n    \"id\": 10,\n    \"mimeType\": \"link\",\n    \"uri\": \"https://test.com/myfile\",\n    \"thumbnailUri\": null,\n    \"status\": \"created\",\n    \"createdAt\": \"2022-11-16T19:09:45Z\",\n    \"createdById\": 1,\n    \"createdByName\": \"Olivia Admin\"\n}"}},"schema":{"type":"object","properties":{"dealId":{"type":"integer","example":1,"default":0},"fileName":{"type":"string","example":"test.jpg"},"fileSize":{},"id":{"type":"integer","example":10,"default":0},"mimeType":{"type":"string","example":"link"},"uri":{"type":"string","example":"https://test.com/myfile"},"thumbnailUri":{},"status":{"type":"string","example":"created"},"createdAt":{"type":"string","example":"2022-11-16T19:09:45Z"},"createdById":{"type":"integer","example":1,"default":0},"createdByName":{"type":"string","example":"Olivia Admin"}}}}}},"403":{"description":"403","content":{"text/plain":{"examples":{"Result":{"value":"{\n    \"errorMessage\": \"You do not have access to this endpoint.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"You do not have access to this endpoint."}}}}}}},"deprecated":false},"delete":{"summary":"/dealAttachments/:id","description":"Delete a deal attachment.","operationId":"dealattachments-id-delete","parameters":[{"name":"X-System","in":"header","description":"Registered system name.","required":true,"schema":{"type":"string"}},{"name":"X-System-Key","in":"header","description":"Registered system API key.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The id of the attachment.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"403":{"description":"403","content":{"text/plain":{"examples":{"Result":{"value":"{\n    \"errorMessage\": \"You do not have access to this endpoint.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"You do not have access to this endpoint."}}}}}},"404":{"description":"404","content":{"text/plain":{"examples":{"Result":{"value":"{\n    \"errorMessage\": \"Requested resource was not found.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"Requested resource was not found."}}}}}}},"deprecated":false}},"/automationsPeople":{"get":{"summary":"/automationsPeople","description":"Get a list of pairings of Automations and the People on which they have or will be run.","operationId":"automationspeople","parameters":[{"name":"personId","in":"query","description":"ID of a Person (i.e. to view only pairings for that Person)","schema":{"type":"integer","format":"int32"}},{"name":"automationId","in":"query","description":"ID of an Automation (i.e. to view only pairings for that Automation)","schema":{"type":"integer","format":"int32"}},{"name":"status","in":"query","description":"Automation Status to filter by, i.e. one of \"Initial\", \"Running\", \"Paused\", or \"Completed\"","schema":{"type":"string","enum":["\"Initial\"","\"Running\"","\"Paused\"","\"Completed\""]}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"_metadata\": {\n        \"collection\": \"automationsPeople\",\n        \"offset\": 0,\n        \"limit\": 10,\n        \"total\": 2,\n        \"next\": null,\n        \"nextLink\": null\n    },\n    \"automationsPeople\": [\n        {\n            \"id\": 2,\n            \"created\": \"2023-08-09T21:36:05Z\",\n            \"updated\": \"2023-08-09T21:36:05Z\",\n            \"createdById\": -1,\n            \"updatedById\": -1,\n            \"createdBy\": \"Follow Up Boss\",\n            \"updatedBy\": \"Follow Up Boss\",\n            \"personId\": 2,\n            \"automationId\": 1,\n            \"status\": \"Completed\",\n            \"automationName\": \"Test Automation\"\n        },\n        {\n            \"id\": 1,\n            \"created\": \"2023-08-09T21:36:03Z\",\n            \"updated\": \"2023-08-09T21:36:03Z\",\n            \"createdById\": -1,\n            \"updatedById\": -1,\n            \"createdBy\": \"Follow Up Boss\",\n            \"updatedBy\": \"Follow Up Boss\",\n            \"personId\": 1,\n            \"automationId\": 1,\n            \"status\": \"Completed\",\n            \"automationName\": \"Test Automation\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"_metadata":{"type":"object","properties":{"collection":{"type":"string","example":"automationsPeople"},"offset":{"type":"integer","example":0,"default":0},"limit":{"type":"integer","example":10,"default":0},"total":{"type":"integer","example":2,"default":0},"next":{},"nextLink":{}}},"automationsPeople":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":2,"default":0},"created":{"type":"string","example":"2023-08-09T21:36:05Z"},"updated":{"type":"string","example":"2023-08-09T21:36:05Z"},"createdById":{"type":"integer","example":-1,"default":0},"updatedById":{"type":"integer","example":-1,"default":0},"createdBy":{"type":"string","example":"Follow Up Boss"},"updatedBy":{"type":"string","example":"Follow Up Boss"},"personId":{"type":"integer","example":2,"default":0},"automationId":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"Completed"},"automationName":{"type":"string","example":"Test Automation"}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"post":{"summary":"/automationsPeople","description":"Manually trigger an Automation for a specified Person.","operationId":"automationspeople-1","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"automationId":{"type":"integer","description":"ID of an existing Automation to trigger","format":"int32"},"personId":{"type":"integer","description":"ID of an existing Person for which to run the Automation","format":"int32"}}}}}},"responses":{"201":{"description":"201","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 2,\n    \"created\": \"2023-08-09T21:36:05Z\",\n    \"updated\": \"2023-08-09T21:36:05Z\",\n    \"createdById\": -1,\n    \"updatedById\": -1,\n    \"createdBy\": \"Follow Up Boss\",\n    \"updatedBy\": \"Follow Up Boss\",\n    \"personId\": 2,\n    \"automationId\": 1,\n    \"status\": \"Completed\",\n    \"automationName\": \"Test Automation\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":2,"default":0},"created":{"type":"string","example":"2023-08-09T21:36:05Z"},"updated":{"type":"string","example":"2023-08-09T21:36:05Z"},"createdById":{"type":"integer","example":-1,"default":0},"updatedById":{"type":"integer","example":-1,"default":0},"createdBy":{"type":"string","example":"Follow Up Boss"},"updatedBy":{"type":"string","example":"Follow Up Boss"},"personId":{"type":"integer","example":2,"default":0},"automationId":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"Completed"},"automationName":{"type":"string","example":"Test Automation"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\"errorMessage\":\"Invalid value for 'personId' field, no such person or you don't have permission to access this person\"}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"Invalid value for 'personId' field, no such person or you don't have permission to access this person"}}}}}}},"deprecated":false}},"/automationsPeople/{id}":{"put":{"summary":"/automationsPeople/:id","description":"Pause or unpause an Automation for a Person.","operationId":"automationspeopleid","parameters":[{"name":"id","in":"path","description":"ID of the Automation-Person pairing (i.e. as returned by GET /automationsPeople or POST /automationsPeople)","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Automation Status, i.e. \"Paused\" to pause the Automation or \"Running\" to unpause it","enum":["\"Running\"","\"Paused\""]}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 2,\n    \"created\": \"2023-08-09T21:36:05Z\",\n    \"updated\": \"2023-08-09T21:36:05Z\",\n    \"createdById\": -1,\n    \"updatedById\": -1,\n    \"createdBy\": \"Follow Up Boss\",\n    \"updatedBy\": \"Follow Up Boss\",\n    \"personId\": 2,\n    \"automationId\": 1,\n    \"status\": \"Completed\",\n    \"automationName\": \"Test Automation\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":2,"default":0},"created":{"type":"string","example":"2023-08-09T21:36:05Z"},"updated":{"type":"string","example":"2023-08-09T21:36:05Z"},"createdById":{"type":"integer","example":-1,"default":0},"updatedById":{"type":"integer","example":-1,"default":0},"createdBy":{"type":"string","example":"Follow Up Boss"},"updatedBy":{"type":"string","example":"Follow Up Boss"},"personId":{"type":"integer","example":2,"default":0},"automationId":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"Completed"},"automationName":{"type":"string","example":"Test Automation"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\"errorMessage\":\"Invalid value for 'status' field\"}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"Invalid value for 'status' field"}}}}}}},"deprecated":false},"get":{"summary":"/automationsPeople/:id","description":"Retrieve an Automation-Person pairing.","operationId":"automationspeopleid-1","parameters":[{"name":"id","in":"path","description":"ID of the Automation-Person pairing","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 2,\n    \"created\": \"2023-08-09T21:36:05Z\",\n    \"updated\": \"2023-08-09T21:36:05Z\",\n    \"createdById\": -1,\n    \"updatedById\": -1,\n    \"createdBy\": \"Follow Up Boss\",\n    \"updatedBy\": \"Follow Up Boss\",\n    \"personId\": 2,\n    \"automationId\": 1,\n    \"status\": \"Completed\",\n    \"automationName\": \"Test Automation\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":2,"default":0},"created":{"type":"string","example":"2023-08-09T21:36:05Z"},"updated":{"type":"string","example":"2023-08-09T21:36:05Z"},"createdById":{"type":"integer","example":-1,"default":0},"updatedById":{"type":"integer","example":-1,"default":0},"createdBy":{"type":"string","example":"Follow Up Boss"},"updatedBy":{"type":"string","example":"Follow Up Boss"},"personId":{"type":"integer","example":2,"default":0},"automationId":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"Completed"},"automationName":{"type":"string","example":"Test Automation"}}}}}},"404":{"description":"404","content":{"text/plain":{"examples":{"Result":{"value":""}}}}}},"deprecated":false}},"/teamInboxes":{"get":{"summary":"/teamInboxes","description":"Get a list of Team Inboxes","operationId":"teaminboxes","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"_metadata\": {\n        \"collection\": \"teamInboxes\",\n        \"offset\": 0,\n        \"limit\": 10,\n        \"total\": 2,\n        \"next\": \"abc123\",\n        \"nextLink\": \"https://yourdomain.reclients.com/api/v1/teamInboxes?next=abc123\",\n    },\n    \"teamInboxes\": [\n        {\n            \"id\": 123,\n            \"name\": \"My Team Inbox\",\n            \"users\": [\n                {\n                    \"id\": 111,\n                    \"name\": \"User Name\",\n                    \"firstName\": \"User\",\n                    \"lastName\": \"Name\"\n                }\n            ]\n        },\n      {\n            \"id\": 124,\n            \"name\": \"Another Team Inbox\",\n            \"users\": [\n                {\n                    \"id\": 111,\n                    \"name\": \"User Name\",\n                    \"firstName\": \"User\",\n                    \"lastName\": \"Name\"\n                },\n              {\n                    \"id\": 112,\n                    \"name\": \"Another User\",\n                    \"firstName\": \"Another\",\n                    \"lastName\": \"User\"\n                }\n            ]\n        }\n }"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/reactions/{refType}/{refId}":{"post":{"summary":"/reactions/:refType/:refId","description":"Add a reaction to a corresponding reference data object, e.g. \"Note\" or \"ThreadedReply\"","operationId":"reactions-reftype-refid-post","parameters":[{"name":"refType","in":"path","description":"The type of entity that is being reacted to.","schema":{"type":"string","enum":["Note","Call","ThreadedReply"]},"required":true},{"name":"refId","in":"path","description":"The ID of the type of item that is being reacted to.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The single-character emoji reaction."}}},"examples":{"Request Example":{"value":{"body":"🤣"}}}}}},"responses":{"201":{"description":"201","content":{"text/plain":{"examples":{"Result":{"value":"[]"}},"schema":{"type":"array","items":{"type":"object","properties":{}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"/reactions/:refType/:refId","description":"Delete a reaction","operationId":"reactions-reftype-refid-delete","parameters":[{"name":"refType","in":"path","description":"The type of entity that is being reacted to.","schema":{"type":"string","enum":["Note","Call","ThreadedReply"]},"required":true},{"name":"refId","in":"path","description":"The ID of the type of item that is being reacted to.","schema":{"type":"string"},"required":true},{"name":"emoji","in":"query","description":"Single character emoji reaction to delete","schema":{"type":"string"}}],"responses":{"204":{"description":"204","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false,"requestBody":{"content":{"application/json":{"schema":{},"examples":{"Request Example":{"value":{"body":"👏"}}}}}}}},"/inboxApps/{inboxAppId}/message":{"post":{"summary":"Add Message","description":"Adds a message to an existing or new Inbox App conversation.","operationId":"inbox-apps-add-message","parameters":[{"name":"inboxAppId","in":"path","description":"The Inbox App ID adding the message.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["externalConversationId","externalMessageId","message","isIncoming","sender"],"properties":{"externalConversationId":{"type":"string","description":"A unique identifier that references this conversation."},"externalMessageId":{"type":"string","description":"A unique identifier that references this message."},"replyToExternalMessageId":{"type":"string","description":"If this message is a reply to a previous message, specify the external message ID of the message being replied to."},"sentAt":{"type":"string","description":"The timestamp the message was delivered at in ISO8601 UTC format. Defaults to current time if omitted.","format":"date"},"subject":{"type":"string","description":"Sets or updates the subject of the conversation."},"message":{"type":"string","description":"A plaintext message body."},"isIncoming":{"type":"boolean","description":"Indicates if the message was incoming to your system."},"sender":{"type":"object","description":"Who sent the message. Can be a FUB User, a FUB Person, or an unrelated entity such as an AI bot.","properties":{"userId":{"type":"integer","description":"A FUB User ID. Mutually exclusive to other IDs.","format":"int32"},"personId":{"type":"integer","description":"A FUB Person ID. Mutually exclusive to other IDs.","format":"int32"},"relationshipId":{"type":"integer","description":"A FUB Relationship ID. Mutually exclusive to the other ID fields.","format":"int32"},"participantId":{"type":"integer","description":"The ID of a conversation participant returned when adding the sender. Mutually exclusive to other IDs.","format":"int32"},"name":{"type":"string","description":"The sender's name if you do not know the sender's User or Person ID."},"email":{"type":"string","description":"The sender's email if you do not know the sender's User or Person ID."},"phone":{"type":"string","description":"The sender's name if you do not know the sender's User or Person ID."}}},"isAutomation":{"type":"boolean","description":"Whether the sender is an automated system. Defaults to false.","default":false},"person":{"type":"object","description":"The person associated with the conversation. A Person ID is preferred, but name, email, and/or phone are acceptable if the person does not exist in FUB yet. Required on the first message in a conversation.","properties":{"id":{"type":"integer","description":"The FUB Person ID.","format":"int32"},"name":{"type":"string","description":"The person's name if you do not know the person's User ID."},"email":{"type":"string","description":"The person's name if you do not know the person's User ID."},"phone":{"type":"string","description":"The person's name if you do not know the person's User ID."}}},"owner":{"type":"object","description":"The owner of the conversation. Can be a FUB User or FUB Team Inbox. Required on the first message in a conversation.","properties":{"userId":{"type":"integer","description":"The FUB User who this conversation should belong to. The FUB Team Inbox who this conversation should belong to. Mutually exclusive with inboxId.","format":"int32"},"inboxId":{"type":"string","description":"The FUB Team Inbox who this conversation should belong to. Mutually exclusive with userId."}}},"deliveryStatus":{"type":"string","description":"The message's delivery status.","enum":["Sent","Delivered","Read","Not Delivered"]},"deliveryStatusErrorMessage":{"type":"string","description":"Optional user-facing error message for Not Delivered statuses."},"attachments":{"type":"array","items":{"properties":{"filename":{"type":"string","description":"The attachment's filename (for example, \"house.jpg\")"},"url":{"type":"string","description":"The URL to the attachment. Must have a TTL of at least 20 minutes to allow adequate time for FUB to process and download the attachment."}},"type":"object"}},"richObjects":{"type":"array","description":"List of Rich Object URLs.","items":{"type":"string"}}}}}}},"responses":{"201":{"description":"201","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 1,\n    \"created\": \"2024-01-01T12:00:00Z\",\n    \"updated\": \"2024-01-01T12:00:00Z\",\n    \"sentAt\": \"2024-01-01T12:00:00Z\",\n    \"deliveryStatus\": null,\n    \"deliveryStatusErrorMessage\": null,\n    \"createdById\": 1,\n    \"updatedById\": 1,\n    \"isIncoming\": true,\n    \"message\": \"An example message.\",\n    \"userId\": 0,\n    \"personId\": 1,\n    \"sender\": {\n        \"personId\": 1,\n        \"name\": \"John Doe\",\n        \"email\": null,\n        \"phone\": null,\n        \"avatar\": null\n    },\n    \"attachments\": [\n        {\n            \"filename\": \"example-2.jpg\",\n            \"url\": \"https://followupboss.test/example-2.jpg\",\n        },\n        {\n            \"filename\": \"document-1.pdf\",\n            \"url\": \"https://followupboss.test/example.pdf\",\n        }\n    ],\n    \"conversationDeepLinkUrl\": \"https://app.followupboss.com/2/inbox-new/0/inbox/1\"\n}"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"errorMessage\": \"isIncoming must be a boolean.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"isIncoming must be a boolean."}}}}}}},"deprecated":false},"put":{"summary":"Update Message","description":"Update an Inbox App Message.","operationId":"inbox-apps-update-message","parameters":[{"name":"inboxAppId","in":"path","description":"The Inbox App ID updating the message.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"FUB ID of the Inbox App Message. Used to identify which message you are updating.","format":"int32"},"externalMessageId":{"type":"string","description":"Your unique identifier that represents this message. When provided by itself, it is used to identify which message you are updating. When provided alongside an \"id\", the message will be identified by its ID and the \"externalMessageId\" will be updated."},"deliveryStatus":{"type":"string","description":"The message's delivery status.","enum":["Sent","Delivered","Read","Not Delivered"]},"deliveryStatusErrorMessage":{"type":"string","description":"Optional user-facing error message for Not Delivered statuses."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 1,\n    \"created\": \"2024-01-01T12:00:00Z\",\n    \"updated\": \"2024-01-01T12:00:00Z\",\n    \"sentAt\": \"2024-01-01T12:00:00Z\",\n    \"deliveryStatus\": \"Not Delivered\",\n    \"deliveryStatusErrorMessage\": \"Recipient has opted out of communications\",\n    \"createdById\": 1,\n    \"updatedById\": 1,\n    \"isIncoming\": true,\n    \"message\": \"An example message.\",\n    \"userId\": 0,\n    \"personId\": 1,\n    \"sender\": {\n        \"personId\": 1,\n        \"name\": \"John Doe\",\n        \"email\": null,\n        \"phone\": null,\n        \"avatar\": null\n    },\n    \"conversationDeepLinkUrl\": \"https://app.followupboss.com/2/inbox-new/0/inbox/1\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"created":{"type":"string","example":"2024-01-01T12:00:00Z"},"updated":{"type":"string","example":"2024-01-01T12:00:00Z"},"sentAt":{"type":"string","example":"2024-01-01T12:00:00Z"},"deliveryStatus":{"type":"string","example":"Not Delivered"},"deliveryStatusErrorMessage":{"type":"string","example":"Recipient has opted out of communications"},"createdById":{"type":"integer","example":1,"default":0},"updatedById":{"type":"integer","example":1,"default":0},"isIncoming":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"An example message."},"userId":{"type":"integer","example":0,"default":0},"personId":{"type":"integer","example":1,"default":0},"sender":{"type":"object","properties":{"personId":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"John Doe"},"email":{},"phone":{},"avatar":{}}},"conversationDeepLinkUrl":{"type":"string","example":"https://app.followupboss.com/2/inbox-new/0/inbox/1"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"errorMessage\": \"id or externalMessageId is required.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"id or externalMessageId is required."}}}}}}},"deprecated":false}},"/inboxApps/{inboxAppId}/note":{"post":{"summary":"Add Note","description":"Adds a note to an Inbox App conversation.","operationId":"inbox-apps-add-note","parameters":[{"name":"inboxAppId","in":"path","description":"The Inbox App ID adding the note.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["externalConversationId","body","user"],"properties":{"externalConversationId":{"type":"string","description":"The unique identifier that references the conversation you are adding a note for."},"body":{"type":"string","description":"The plaintext body of the note."},"user":{"type":"object","description":"The user adding the note.","properties":{"id":{"type":"string","description":"The User ID that is adding the note. Mutually exclusive with other fields."},"name":{"type":"string","description":"The name of the user that is adding the note, if an ID is not available."},"email":{"type":"string","description":"The email of the user that is adding the note, if an ID is not available."}}}}}}}},"responses":{"201":{"description":"201","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 4,\n    \"created\": \"2024-01-01T12:00:00Z\",\n    \"updated\": \"2024-01-01T12:00:00Z\",\n    \"createdById\": 1,\n    \"updatedById\": 1,\n    \"createdBy\": \"John Doe\",\n    \"updatedBy\": \"John Doe\",\n    \"conversationId\": 1,\n    \"body\": \"An example note.\",\n    \"isHtml\": false,\n    \"type\": \"ConversationNote\",\n    \"conversationDeepLinkUrl\": \"https://app.followupboss.com/2/inbox-new/0/inbox/1\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":4,"default":0},"created":{"type":"string","example":"2024-01-01T12:00:00Z"},"updated":{"type":"string","example":"2024-01-01T12:00:00Z"},"createdById":{"type":"integer","example":1,"default":0},"updatedById":{"type":"integer","example":1,"default":0},"createdBy":{"type":"string","example":"John Doe"},"updatedBy":{"type":"string","example":"John Doe"},"conversationId":{"type":"integer","example":1,"default":0},"body":{"type":"string","example":"An example note."},"isHtml":{"type":"boolean","example":false,"default":true},"type":{"type":"string","example":"ConversationNote"},"conversationDeepLinkUrl":{"type":"string","example":"https://app.followupboss.com/2/inbox-new/0/inbox/1"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"errorMessage\": \"body is required.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"body is required."}}}}}}},"deprecated":false}},"/inboxApps/{inboxAppId}/conversations/{extConversationId}":{"put":{"summary":"Update Conversation","description":"Updates an Inbox App conversation.","operationId":"inbox-apps-update-conversation","parameters":[{"name":"inboxAppId","in":"path","description":"The Inbox App ID sending the message.","schema":{"type":"string"},"required":true},{"name":"extConversationId","in":"path","description":"The unique identifier that references the conversation you are updating.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"subject":{"type":"string","description":"Sets or updates the subject of the conversation if included."},"archived":{"type":"boolean","description":"Archives or unarchives the conversation if included."},"permanentlyArchived":{"type":"boolean","description":"Disables replies/notes and does not allow users to un-archive the conversation."},"person":{"type":"object","description":"Updates the person associated with the conversation. Can only be changed if a Person ID has not been set.","properties":{"id":{"type":"integer","description":"The FUB Person ID.","format":"int32"},"name":{"type":"string","description":"The person's name if you do not know the person's User ID."},"email":{"type":"string","description":"The person's name if you do not know the person's User ID."},"phone":{"type":"string","description":"The person's name if you do not know the person's User ID."}}},"assignedUserId":{"type":"integer","description":"The User ID to reassign the conversation to. Set to 0 to revert back to the conversation owner.","format":"int32"},"assignedInboxId":{"type":"integer","description":"The Team Inbox ID to reassign the conversation to. Set to 0 to revert back to the conversation owner.","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"externalConversationId\": \"\",\n    \"created\": \"2024-01-01T12:00:00Z\",\n    \"updated\": \"2024-01-01T12:00:00Z\",\n    \"createdById\": \"John Doe\",\n    \"updatedById\": \"John Doe\",\n    \"ownerUserId\": 1,\n    \"ownerSharedInboxId\": 0,\n    \"assignedUserId\": 0,\n    \"assignedSharedInboxId\": 1,\n    \"subject\": \"A Conversation Subject\",\n    \"archived\": false,\n    \"person\": {\n        \"id\": 1,\n        \"name\": null,\n        \"email\": null,\n        \"phone\": null\n    },\n    \"conversationDeepLinkUrl\": \"https://app.followupboss.com/2/inbox-new/0/inbox/1\"\n}"}},"schema":{"type":"object","properties":{"externalConversationId":{"type":"string","example":""},"created":{"type":"string","example":"2024-01-01T12:00:00Z"},"updated":{"type":"string","example":"2024-01-01T12:00:00Z"},"createdById":{"type":"string","example":"John Doe"},"updatedById":{"type":"string","example":"John Doe"},"ownerUserId":{"type":"integer","example":1,"default":0},"ownerSharedInboxId":{"type":"integer","example":0,"default":0},"assignedUserId":{"type":"integer","example":0,"default":0},"assignedSharedInboxId":{"type":"integer","example":1,"default":0},"subject":{"type":"string","example":"A Conversation Subject"},"archived":{"type":"boolean","example":false,"default":true},"person":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"name":{},"email":{},"phone":{}}},"conversationDeepLinkUrl":{"type":"string","example":"https://app.followupboss.com/2/inbox-new/0/inbox/1"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"errorMessage\": \"archived must be a boolean.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"archived must be a boolean."}}}}}}},"deprecated":false}},"/reactions/{id}":{"get":{"summary":"/reactions/:id","description":"Fetch a reaction","operationId":"reactionsnoteid","parameters":[{"name":"id","in":"path","description":"The ID of the reaction.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 1363,\n    \"created\": \"2024-03-21T21:14:13Z\",\n    \"createdBy\": \"Tom Minch\",\n    \"createdById\": 1,\n    \"refType\": \"Note\",\n    \"refId\": 2144705,\n    \"body\": \"🤯\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":1363,"default":0},"created":{"type":"string","example":"2024-03-21T21:14:13Z"},"createdBy":{"type":"string","example":"Tom Minch"},"createdById":{"type":"integer","example":1,"default":0},"refType":{"type":"string","example":"Note"},"refId":{"type":"integer","example":2144705,"default":0},"body":{"type":"string","example":"🤯"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/threadedReplies/{id}":{"get":{"summary":"/threadedReplies/:id","description":"Fetches a threaded reply","operationId":"threadedreplies-copy","parameters":[{"name":"id","in":"path","description":"The ID of the reply to return.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 1,\n    \"created\": \"2024-01-11T18:50:12Z\",\n    \"updated\": \"2024-01-26T19:13:27Z\",\n    \"createdById\": 1,\n    \"refType\": \"Note\",\n    \"refId\": 468,\n    \"body\": \"Hello world part 2\",\n    \"reactions\": {\n   \t\t\"id\": 1363,\n      \"created\": \"2024-03-21T21:14:13Z\",\n      \"createdBy\": \"Tom Minch\",\n      \"createdById\": 1,\n      \"refType\": \"Note\",\n      \"refId\": 2144705,\n      \"body\": \"🤯\"\n   \t}\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"created":{"type":"string","example":"2024-01-11T18:50:12Z"},"updated":{"type":"string","example":"2024-01-26T19:13:27Z"},"createdById":{"type":"integer","example":1,"default":0},"refType":{"type":"string","example":"Note"},"refId":{"type":"integer","example":468,"default":0},"body":{"type":"string","example":"Hello world part 2"},"reactions":{"type":"object","properties":{"id":{"type":"integer","example":1363,"default":0},"created":{"type":"string","example":"2024-03-21T21:14:13Z"},"createdBy":{"type":"string","example":"Tom Minch"},"createdById":{"type":"integer","example":1,"default":0},"refType":{"type":"string","example":"Note"},"refId":{"type":"integer","example":2144705,"default":0},"body":{"type":"string","example":"🤯"}}}}}}}}},"deprecated":false}},"/inboxApps/install":{"post":{"summary":"Install Inbox App","description":"Installs your Inbox App for an account.","operationId":"inbox-apps-install","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["publishedInboxAppId","userId","subscriptionUrl"],"properties":{"publishedInboxAppId":{"type":"integer","description":"Your Published Inbox App ID.","format":"int32"},"userId":{"type":"integer","description":"The User ID to scope the Inbox App to, or 0 for account-wide scope.","format":"int32"},"subscriptionUrl":{"type":"string","description":"The webhook URL you will receive Inbox App replies at."}}}}}},"responses":{"201":{"description":"201","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 1,\n    \"created\": \"2024-01-01T12:00:00Z\",\n    \"updated\": \"2024-01-01T12:00:00Z\",\n    \"createdById\": 1,\n    \"updatedById\": 1,\n    \"status\": 10,\n    \"name\": \"Example Inbox App\",\n    \"publishedInboxAppId\": 1,\n    \"userId\": 1,\n    \"canReply\": true\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"created":{"type":"string","example":"2024-01-01T12:00:00Z"},"updated":{"type":"string","example":"2024-01-01T12:00:00Z"},"createdById":{"type":"integer","example":1,"default":0},"updatedById":{"type":"integer","example":1,"default":0},"status":{"type":"integer","example":10,"default":0},"name":{"type":"string","example":"Example Inbox App"},"publishedInboxAppId":{"type":"integer","example":1,"default":0},"userId":{"type":"integer","example":1,"default":0},"canReply":{"type":"boolean","example":true,"default":true}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"errorMessage\": \"publishedInboxAppId is required.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"publishedInboxAppId is required."}}}}}}},"deprecated":false}},"/inboxApps/{inboxAppId}":{"delete":{"summary":"Deactivate Inbox App","description":"Deactivates an installation of your Inbox App. Useful when a customer unsubscribes from your service, or requests that you turn off Inbox App functionality for them.","operationId":"inbox-apps-deactivate","parameters":[{"name":"inboxAppId","in":"path","description":"The Inbox App ID to deactivate.","schema":{"type":"string"},"required":true}],"responses":{"204":{"description":"204","content":{"application/json":{"examples":{"Result":{"value":""}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"errorMessage\": \"inboxAppId is required.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"inboxAppId is required."}}}}}}},"deprecated":false}},"/inboxApps/{inboxAppId}/conversations/{extConversationId}/participants":{"get":{"summary":"Get Participants","description":"Retrieves participants in an Inbox App conversation.","operationId":"inbox-apps-get-participants","parameters":[{"name":"inboxAppId","in":"path","description":"The Inbox App ID sending the message.","schema":{"type":"string"},"required":true},{"name":"extConversationId","in":"path","description":"The unique identifier that references the conversation you are updating.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"[\n    {\n        \"id\": 1,\n        \"status\": \"active\",\n        \"userId\": null,\n        \"personId\": null,\n        \"name\": \"John Doe\",\n        \"phone\": \"+14075550123\",\n        \"email\": \"john@example.com\",\n        \"isAutomation\": false\n    },\n    {\n        \"id\": 2,\n        \"status\": \"active\",\n        \"userId\": 1,\n        \"personId\": null,\n        \"name\": null,\n        \"phone\": null,\n        \"email\": null,\n        \"isAutomation\": false\n    },\n    {\n        \"id\": 3,\n        \"status\": \"deleted\",\n        \"userId\": null,\n        \"personId\": 1,\n        \"name\": null,\n        \"phone\": null,\n        \"email\": null,\n        \"isAutomation\": false\n    }\n]"}},"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"userId":{},"personId":{},"name":{"type":"string","example":"John Doe"},"phone":{"type":"string","example":"+14075550123"},"email":{"type":"string","example":"john@example.com"},"isAutomation":{"type":"boolean","example":false,"default":true}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"errorMessage\": \"externalConversationId is required.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"externalConversationId is required."}}}}}}},"deprecated":false},"post":{"summary":"Add Participant","description":"Adds a participant to an Inbox App conversation.","operationId":"inbox-apps-create-participant","parameters":[{"name":"inboxAppId","in":"path","description":"The Inbox App ID sending the message.","schema":{"type":"string"},"required":true},{"name":"extConversationId","in":"path","description":"The unique identifier that references the conversation you are updating.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"integer","description":"A FUB Person ID. Mutually exclusive to other fields.","format":"int32"},"userId":{"type":"integer","description":"A FUB User ID. Mutually exclusive to other fields.","format":"int32"},"relationshipId":{"type":"integer","description":"A FUB Relationship ID. Mutually exclusive to the other ID fields.","format":"int32"},"name":{"type":"string","description":"The participant's name if you do not know the participant's Person or User ID."},"email":{"type":"string","description":"The participant's email address if you do not know the participant's Person or User ID."},"phone":{"type":"string","description":"The participant's phone number if you do not know the participant's Person or User ID."},"isAutomation":{"type":"boolean","description":"Whether the participant is an automated system. Defaults to false.","default":false}}}}}},"responses":{"201":{"description":"201","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 1,\n    \"status\": \"active\",\n    \"userId\": null,\n    \"personId\": null,\n    \"name\": \"John Doe\",\n    \"phone\": \"+14075550123\",\n    \"email\": \"john@example.com\",\n    \"isAutomation\": false\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"userId":{},"personId":{},"name":{"type":"string","example":"John Doe"},"phone":{"type":"string","example":"+14075550123"},"email":{"type":"string","example":"john@example.com"},"isAutomation":{"type":"boolean","example":false,"default":true}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"errorMessage\": \"externalConversationId is required.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"externalConversationId is required."}}}}}}},"deprecated":false}},"/inboxApps/{inboxAppId}/conversations/{extConversationId}/participants/{participantId}":{"delete":{"summary":"Remove Participant","description":"Deletes an Inbox App conversation participant.","operationId":"inbox-apps-delete-participant","parameters":[{"name":"inboxAppId","in":"path","description":"The Inbox App ID sending the message.","schema":{"type":"string"},"required":true},{"name":"extConversationId","in":"path","description":"The unique identifier that references the conversation you are updating.","schema":{"type":"string"},"required":true},{"name":"participantId","in":"path","description":"The participant's ID","schema":{"type":"string"},"required":true}],"responses":{"204":{"description":"204","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"errorMessage\": \"externalConversationId is required.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"externalConversationId is required."}}}}}}},"deprecated":false}},"/timeframes":{"get":{"summary":"/timeframes","description":"Get a list of timeframes.","operationId":"timeframes-get","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"_metadata\": {\n        \"collection\": \"timeframes\",\n        \"offset\": 0,\n        \"limit\": 10,\n        \"total\": 0,\n        \"next\": null,\n        \"nextLink\": null\n    },\n    \"timeframes\": [\n        {\n            \"id\": 1,\n            \"timeframe\": \"0-3 Months\"\n        },\n        {\n            \"id\": 2,\n            \"timeframe\": \"3-6 Months\"\n        },\n        {\n            \"id\": 3,\n            \"timeframe\": \"6-12 Months\"\n        },\n        {\n            \"id\": 4,\n            \"timeframe\": \"12+ Months\"\n        },\n        {\n            \"id\": 5,\n            \"timeframe\": \"No Plans\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"_metadata":{"type":"object","properties":{"collection":{"type":"string","example":"timeframes"},"offset":{"type":"integer","example":0,"default":0},"limit":{"type":"integer","example":10,"default":0},"total":{"type":"integer","example":0,"default":0},"next":{},"nextLink":{}}},"timeframes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"timeframe":{"type":"string","example":"0-3 Months"}}}}}}}}}},"deprecated":false}},"/automations":{"get":{"summary":"/automations","description":"Get a list of Automations","operationId":"automations","parameters":[{"name":"limit","in":"query","description":"Number of results to return. Max 100.","schema":{"type":"integer","format":"int32","default":10}},{"name":"offset","in":"query","description":"Specifies the number of rows to skip before starting to return results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"status","in":"query","description":"Search for Automations with one of the following statuses: `Active`, `Disabled`, or `Deleted`.","schema":{"type":"string"}},{"name":"enabledOnly","in":"query","description":"Return only automations that are enabled","schema":{"type":"boolean","default":false}},{"name":"manualOnly","in":"query","description":"Return automations that contain a manual trigger","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/automations/{id}":{"get":{"summary":"/automations/:id","description":"Retrieve an Automation by ID.","operationId":"automationsid","parameters":[{"name":"id","in":"path","description":"ID of the Automation to retrieve","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/inboxApps/installedApps/{publishedInboxAppId}":{"get":{"summary":"View Installed Inbox Apps","description":"Lists Inbox App installation(s) and ID(s) for your Published Inbox App on the current FUB account.","operationId":"view-inbox-app-installations","parameters":[{"name":"publishedInboxAppId","in":"path","description":"Your Published Inbox App ID, to display installations of.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"inboxApps\": [\n    {\n      \"inboxAppId\": 1,\n      \"userId\": 0,\n      \"created\": \"2025-01-01T12:12:12Z\"\n    },\n    {\n      \"inboxAppId\": 9,\n      \"userId\": 5,\n      \"created\": \"2025-01-01T12:12:12Z\"\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"inboxApps":{"type":"array","items":{"type":"object","properties":{"inboxAppId":{"type":"integer","example":1,"default":0},"userId":{"type":"integer","example":0,"default":0},"created":{"type":"string","example":"2025-01-01T12:12:12Z"}}}}}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"errorMessage\": \"You do not have permission to view installations for this Published Inbox App.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"You do not have permission to view installations for this Published Inbox App."}}}}}}},"deprecated":false}},"/inboxApps/{inboxAppId}/systemMessage":{"post":{"summary":"Add System Confirmation Message","description":"Adds a system confirmation message to an existing or new Inbox App conversation.","operationId":"inbox-apps-add-system-confirmation-message","parameters":[{"name":"inboxAppId","in":"path","description":"The Inbox App ID adding the message.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["externalConversationId","externalMessageId","message"],"properties":{"externalConversationId":{"type":"string","description":"A unique identifier that references this conversation."},"externalMessageId":{"type":"string","description":"A unique identifier that references this message."},"message":{"type":"string","description":"A plaintext message body."},"type":{"type":"string","description":"The system confirmation message type.","enum":["success","info","error"]},"person":{"type":"object","description":"The person associated with the conversation. A Person ID is preferred, but name, email, and/or phone are acceptable if the person does not exist in FUB yet. Required on the first message in a conversation.","properties":{"id":{"type":"integer","description":"The FUB Person ID.","format":"int32"},"name":{"type":"string","description":"The person's name if you do not know the person's User ID."},"email":{"type":"string","description":"The person's name if you do not know the person's User ID."},"phone":{"type":"string","description":"The person's name if you do not know the person's User ID."}}},"owner":{"type":"object","description":"The owner of the conversation. Can be a FUB User or FUB Team Inbox. Required on the first message in a conversation.","properties":{"userId":{"type":"integer","description":"The FUB User who this conversation should belong to. The FUB Team Inbox who this conversation should belong to. Mutually exclusive with inboxId.","format":"int32"},"inboxId":{"type":"string","description":"The FUB Team Inbox who this conversation should belong to. Mutually exclusive with userId."}}}}}}}},"responses":{"201":{"description":"201","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 1,\n    \"created\": \"2024-01-01T12:00:00Z\",\n    \"updated\": \"2024-01-01T12:00:00Z\",\n    \"sentAt\": \"2024-01-01T12:00:00Z\",\n    \"deliveryStatus\": null,\n    \"deliveryStatusErrorMessage\": null,\n    \"createdById\": 1,\n    \"updatedById\": 1,\n    \"isIncoming\": true,\n    \"message\": \"An example system confirmation message.\",\n    \"isSystem\": true,\n  \t\"systemType\": \"success\",\n\t\t\"userId\": 0,\n    \"personId\": 1,\n    \"sender\": {\n        \"personId\": 1,\n        \"name\": \"John Doe\",\n        \"email\": null,\n        \"phone\": null,\n        \"avatar\": null\n    },\n    \"attachments\": [],\n    \"conversationDeepLinkUrl\": \"https://app.followupboss.com/2/inbox-new/0/inbox/1\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"created":{"type":"string","example":"2024-01-01T12:00:00Z"},"updated":{"type":"string","example":"2024-01-01T12:00:00Z"},"sentAt":{"type":"string","example":"2024-01-01T12:00:00Z"},"deliveryStatus":{},"deliveryStatusErrorMessage":{},"createdById":{"type":"integer","example":1,"default":0},"updatedById":{"type":"integer","example":1,"default":0},"isIncoming":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"An example system confirmation message."},"isSystem":{"type":"boolean","example":true,"default":true},"systemType":{"type":"string","example":"success"},"userId":{"type":"integer","example":0,"default":0},"personId":{"type":"integer","example":1,"default":0},"sender":{"type":"object","properties":{"personId":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"John Doe"},"email":{},"phone":{},"avatar":{}}},"attachments":{"type":"array","items":{"type":"object","properties":{}}},"conversationDeepLinkUrl":{"type":"string","example":"https://app.followupboss.com/2/inbox-new/0/inbox/1"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"errorMessage\": \"type must be one of success, info, error.\"\n}"}},"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":"type must be one of success, info, error."}}}}}}},"deprecated":false}},"/v1/rateLimit/usage":{"get":{"summary":"/rateLimit/usage","description":"24-hour request volume, rate-limit hits, and currently-configured limits for the calling partner system.","operationId":"ratelimit-usage-get","parameters":[{"name":"X-System","in":"header","description":"The name of the registered system.","required":true,"schema":{"type":"string"}},{"name":"X-System-Key","in":"header","description":"The key of the registered system.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"system\": \"your-system\",\n  \"period\": \"last_24h\",\n  \"usage\": {\n    \"total_requests\": 1247,\n    \"rate_limited_requests\": 23,\n    \"rate_limit_percentage\": 1.84,\n    \"peak_hour\": \"2026-05-19T14:00:00Z\",\n    \"current_limits\": {\n      \"across_all_accounts\": { \"default\": 750, \"GET.people\": 100 },\n      \"per_account\": { \"default\": 25 }\n    }\n  }\n}"}},"schema":{"type":"object","properties":{"system":{"type":"string","example":"your-system"},"period":{"type":"string","example":"last_24h"},"usage":{"type":"object","properties":{"total_requests":{"type":"integer","example":1247,"default":0},"rate_limited_requests":{"type":"integer","example":23,"default":0},"rate_limit_percentage":{"type":"number","example":1.84,"default":0},"peak_hour":{"type":"string","example":"2026-05-19T14:00:00Z"},"current_limits":{"type":"object","properties":{"across_all_accounts":{"type":"object","properties":{"default":{"type":"integer","example":750,"default":0},"GET.people":{"type":"integer","example":100,"default":0}}},"per_account":{"type":"object","properties":{"default":{"type":"integer","example":25,"default":0}}}}}}}}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"error\": \"Only registered systems can use this endpoint.\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Only registered systems can use this endpoint."}}}}}}},"deprecated":false}},"/v1/rateLimit/limits":{"get":{"summary":"/rateLimit/limits","description":"Currently-configured rate limits for the calling partner system. Cheaper than /v1/rateLimit/usage (no Redis fan-out).","operationId":"ratelimit-limits-get","parameters":[{"name":"X-System","in":"header","description":"The name of the registered system.","required":true,"schema":{"type":"string"}},{"name":"X-System-Key","in":"header","description":"The key of the registered system.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"system\": \"your-system\",\n  \"current_limits\": {\n    \"across_all_accounts\": { \"default\": 750, \"GET.people\": 100 },\n    \"per_account\": { \"default\": 25 }\n  }\n}"}},"schema":{"type":"object","properties":{"system":{"type":"string","example":"your-system"},"current_limits":{"type":"object","properties":{"across_all_accounts":{"type":"object","properties":{"default":{"type":"integer","example":750,"default":0},"GET.people":{"type":"integer","example":100,"default":0}}},"per_account":{"type":"object","properties":{"default":{"type":"integer","example":25,"default":0}}}}}}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"error\": \"Only registered systems can use this endpoint.\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Only registered systems can use this endpoint."}}}}}}},"deprecated":false}}},"x-readme":{"headers":[],"explorer-enabled":true,"proxy-enabled":true},"x-readme-fauxas":true}