{"info":{"_postman_id":"9852f6aa-dc2d-b08c-f8f3-d0c92f09f86c","name":"Total Expert Public API","description":"

The Total Expert REST API allows you to programmatically create, retrieve, update, and delete information through various endpoints.

Documentation Layout

Each section of this documentation describes a collection of related endpoints that affect a given resource.

Where applicable, at the top of a section you will find a table listing the attributes for the resource and a second showing its relationships with other resources.

NOTE: If an attribute is marked as 'Assignable', its value can be set via a POST/PATCH. You can also modify the data for an 'Assignable' relationship.

Authentication in the TE API

Interaction with the TE API is protected with OAuth 2.0. A client ID/secret pair is required to use the API.

The ID/secret pair is used to request an access token from the '/token' endpoint. This token will need to be present within the header on all calls to the API.

NOTE: See the 'Authentication' endpoint collection for more information. See the 'Heartbeats' endpoint collection for more information on how to test your authentication.

Endpoint Standards

Each endpoint provides interaction with two aspects of an entity:

'Attributes' - Attributes of the entity itself. Includes things like first name, phone number, or birthday of the contact.
E.g. A 'Contact'

'Relationships' - Describe a relationship between that entity and another entity.
E.g. A contact that has an owner in the TE System OR a set of contact groups (separate entities with their own endpoint).

Attributes

Each endpoint returns a JSON object with a set of attributes. Each endpoint collection should describe the names and types of attributes available in each endpoint.

Data Types

Each attribute has a type. There are four data types in the TE API - Numeric, String, Boolean, and Date.

Data Types

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type	Description
Numeric	Integer or floating point numbers. Supplied with no surrounding quotes. e.g. { \"loan_rate\":4.5 }
String	String of characters - supplied surrounded with quotes. e.g. { \"first_name\":\"Clark\" }
Boolean	Truth value - supplied in one of two ways - see Boolean (String) and Boolean (Numeric) for details
Boolean (String)	Truth value - supplied as the word \"True\" or \"False\", surrounded by quotes. e.g. { \"first_time_buyer\":\"True\" }
Boolean (Numeric)	Truth value - supplied as the number 1 or 0, not surrounded by quotes. e.g. { \"first_time_buyer\":0 }
Date	A date and time - preferred supplied in the format \"YYYY-MM-DD hh:mm:ss\". All dates must be provided in UTC timezone. When returned, the value will be expressed in UTC. To clear a field with a date type, use the value \"0000-00-00 00:00:00\".

Phone Numbers

Phone numbers are accepted in any format. For deduplication, any non-numeric symbols will be stripped out and the numeric phone number will be stored separately. If a numerically identical phone number is used in a different format later, the records are compared using the numeric value only. This applies only to phone numbers with at least 7 digits.

All phone numbers will also be converted into E164 for use in external services (e.g. Twilio). If a phone number cannot be converted into E164, the number will be marked 'Invalid', and external services that rely on phone numbers will not function.

Uniqueness in the TE API

Each type of entity in the TE API can be uniquely identified by a set of attributes. In some cases, multiple options are available to uniquely identify an entity. See each section below for details. These sets of attributes are used to deduplicate entries on creation and to uniquely identify the target in a relationship.

Relationships

Relationships in the TE API are very flexible.

'GET'ing

When GETing an entity, a relationship will be returned with only a partial set of attributes that make sense in the context of that endpoint - e.g. the 'contact_groups' relationship on the '/contacts' endpoint will display only the group name of the target contact_group.

POST and PATCH Requests

When setting a relationship (by POST or PATCH), the target entity is specified using one or more attributes that uniquely identify the entity.

The allowed attributes are listed in the 'Settable Fields' column of each Relationships table. For example, when POSTing to the '/contact-groups' endpoint, either of the following are allowed:

{
\"group_name\": \"Hot Leads\",
\"owner\":{\"username\": \"alfred\"}
}
OR
\n
{
\"group_name\": \"Hot Leads\",
\"owner\":{\"id\": \"123589\"}
}
\n

In cases where an endpoint's relationship supports multiple Settable Fields be aware that the request examples may only make use of one of the attributes though any could be used in its place.

Interacting with the API

Admin Calls vs User Calls

You'll notice that many sections of the documentation have samples for POSTs and GETs that are labeled \"As Admin\" or \"As User\".
When using client credentials to access the API, you'll use the \"As Admin\" examples. For Authorization Code access, you'll use the \"As User\" examples.

'GET'ing

There are two types of GETable endpoints in the TE API: Paging and Individual. Paging endpoints provide lists of entities. E.g. '/contacts' returns a list of contacts.

Getting Individual Entities

Individual endpoints return specific individual entities, specified by TE ID. E.g. '/contacts/51151' returns the contact with the 'id' attribute '51151' (the TE internal identifier).

Getting Multiple Entities (Paging)

Paging endpoints will return an object with two properties: 'objects' and 'links'. The 'objects' property will be an array of entities in 'pages'. Each page will have a number of entities along with a set of links. The page size and page number can be specified using the '?page' GET parameter. Setting '?page[number]=5' will return the fifth page. Setting '?page[size]=100' will make each page consist of 100 items, instead of the default of 10. Both attributes can be set together. E.g. setting '?page[size]=100&page[number]=6' will return items 501-600.

Paging Links

The 'links' attribute on a page object will have four attributes, specifying metadata about the number of entities available to page.

'first' will be the page number of the first page of entities (always '1').
\n
'last' will be the page number of the last page of entities.
\n
'next' will be the page number of the next page after the currently requested one. 'next' may be null if there are no subsequent pages.
\n
'prev' will be the page number of the page immediately preceding the current one. 'prev' may be null if there are no preceding pages.
\n

'POST'ing

Entities can be created in the TE system by POSTing to paging endpoints. E.g. sending a POST to '/contacts' will create a contact.

Deduplication

When POSTing an entity, the TE API will attempt to 'Deduplicate' by searching for existing entities with similar attributes. If such a duplicate does exist, the TE API will treat the POST as a PATCH to that entity instead. See each section for details on what attributes will be used to search for duplicates.

'PATCH'ing

Entities can be updated in the TE system by PATCHing to individual endpoints. E.g. sending a PATCH to '/contacts/51151' will update the attributes of the contact with TE 'id' of '51151'.

'DELETE'ing

Entities can be deleted only by TE ID. Send a DELETE request to the appropriate individual entity endpoint to delete it.

Return Codes

Where applicable, the API will respond with an HTTP status code that indicates what happened during the request. Possible values include:

HTTP CODES

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Code	General Description
200 SUCCESS	The operation completed successfully. See the response body for details (if applicable).
201 CREATED	The object was created successfully. See the response body for details (if applicable).
400 BAD REQUEST	The JSON supplied to the API was malformed and unparseable.
401 UNAUTHORIZED	The request's credentials are invalid. This could mean your token has expired and should be renewed. See the response body for details.
403 FORBIDDEN	An attempt was made to access a resource for which you do not have permission
405 METHOD NOT ALLOWED	An attempt was made to interact with an endpoint in an unsupported manner, e.g. sending a POST to '/contacts/1'
415 UNSUPPORTED MEDIA TYPE	The API endpoints expect a content type of 'media/json'
422 UNPROCESSABLE ENTITY	The JSON body supplied is valid, but not processable semantically. For example, the 'owner' relationship for a contact refers to a User that does not exist in the TE system.
418 I'M A TEAPOT	The API is a teapot (See the 'Heartbeat' section for details).
503 SERVICE UNAVAILABLE	The API is unavailable. Please try your request again later. If this message persists, please contact Technical Support

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1929166","collectionId":"9852f6aa-dc2d-b08c-f8f3-d0c92f09f86c","publishedId":"6Z2RYyU","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2017-07-05T18:44:16.000Z"},"item":[{"name":"Authentication","item":[{"name":"Fetch a Token From Client Credentials Grant","event":[{"listen":"test","script":{"id":"70f18138-e864-4c59-9a18-b9d3d07b1a78","type":"text/javascript","exec":[""]}}],"id":"3a75925c-3a49-4cd3-9037-0c846265dbdd","request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{basic_auth}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"client_credentials\"\n}"},"url":"{{external_api_host}}/v1/token","description":"

Supply client credentials to obtain an access token.

If you are integrating with the Total Expert API from a confidential client you will likely want to use this endpoint. For the client_credentials authorization grant type you will need to make certain that your client is also the resource owner.

Authorization Header Encoding

Shown in the HEADERS table below, the Authorization header field implements the Basic Authentication Schema. The 'basic_auth' value needs to be a base64-encoded string containing your client_id and client_secret. The string that you encode must be in the format:

yourclientid:yourclientsecret

The following are examples of methods that can be used to base64-encode a string.

On BSD/Linux/Mac run:

echo -n 'yourclientid:yourclientsecret' | openssl base64

(note - this often injects one or more newlines into the encoded string, remove it before using to authenticate)

For Windows see:

https://support.microsoft.com/en-us/kb/191239

Using The Token

To interact with the secure endpoints in the TE API, supply the token in the 'Authorization' header as 'Bearer {Token}'

\n","urlObject":{"path":["v1","token"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"1d08c064-19cd-46e5-b2a1-48b4cd3815db","name":"Fetch a Token (scopes defined)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{basic_auth}}"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"client_credentials\",\n \"scope\": \"leadInteraction\"\n}"},"url":"{{external_api_host}}/v1/token"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"407573dd426fe03eec4c63064a4bfbe9525107fa\",\n \"expires_in\": 3600,\n \"token_type\": \"bearer\",\n \"scope\": \"leadInteraction\"\n}"},{"id":"ca7e5963-3fd2-43b8-ab9e-988175debdbe","name":"Invalid credentials","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{basic_auth}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"client_credentials\"\n}"},"url":"{{external_api_host}}/v1/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_client\",\n \"error_description\": \"The client credentials are invalid\"\n}"},{"id":"310630e0-2d5b-4d86-82ae-004f00b9d9e1","name":"Fetch a Token","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{basic_auth}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"client_credentials\"\n}"},"url":"{{external_api_host}}/v1/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"9ecdc290d0a51c1b58ceb7f04622904df485b150\",\n \"expires_in\": 3600,\n \"token_type\": \"bearer\",\n \"scope\": \"leadInteraction loanInteraction\"\n}"}],"_postman_id":"3a75925c-3a49-4cd3-9037-0c846265dbdd"},{"name":"Fetch a Token From Authorization Code","event":[{"listen":"test","script":{"id":"70f18138-e864-4c59-9a18-b9d3d07b1a78","exec":[""],"type":"text/javascript"}}],"id":"5386087c-314f-44e9-b408-f16201cc2238","request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{basic_auth}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"grant_type\":\"authorization_code\",\r\n\t\"code\":\"{{authorization_code}}\",\r\n \"redirect_uri\":\"{{redirect_uri}}\"\r\n}"},"url":"{{external_api_host}}/v1/token","description":"

Supply an authorization code to obtain an access token.

Authorization Header Encoding

yourclientid:yourclientsecret

The following are examples of methods that can be used to base64-encode a string.

On BSD/Linux/Mac run:

echo -n 'yourclientid:yourclientsecret' | openssl base64

(note - this often injects one or more newlines into the encoded string, remove it before using to authenticate)

For Windows see:

https://support.microsoft.com/en-us/kb/191239

Authorization Code Encoding

Supply the authorization code in the POST body as \"code\". Also supply the \"grant_type\" as \"authorization_code\"\nFor details on obtaining an authorization code, please see our authorization documentation

When the authorization code was created using a dynamic redirect uri, 'redirect_uri' must also be supplied. The supplied value must match the value used to create the authorization code.

Using The Token

To interact with the secure endpoints in the TE API, supply the token in the 'Authorization' header as 'Bearer {Token}'

\n","urlObject":{"path":["v1","token"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5386087c-314f-44e9-b408-f16201cc2238"},{"name":"Refresh a Token","event":[{"listen":"test","script":{"id":"70f18138-e864-4c59-9a18-b9d3d07b1a78","exec":[""],"type":"text/javascript"}}],"id":"6d9b4cf2-2144-4bf1-890a-e3585ec603e2","request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{basic_auth}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"grant_type\":\"refresh_token\",\r\n\t\"refresh_token\":\"{{refresh_token}}\"\r\n}"},"url":"{{external_api_host}}/v1/token","description":"

Supply a refresh token to retrieve another new refresh token.

Authorization Header Encoding

yourclientid:yourclientsecret

The following are examples of methods that can be used to base64-encode a string.

On BSD/Linux/Mac run:

echo -n 'yourclientid:yourclientsecret' | openssl base64

(note - this often injects one or more newlines into the encoded string, remove it before using to authenticate)

For Windows see:

https://support.microsoft.com/en-us/kb/191239

Refresh Token Encoding

Supply the refresh token in the POST body as \"refresh_token\". Also supply the \"grant_type\" as \"refresh_token\"

Using The Token

To interact with the secure endpoints in the TE API, supply the token in the 'Authorization' header as 'Bearer {Token}'

\n","urlObject":{"path":["v1","token"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6d9b4cf2-2144-4bf1-890a-e3585ec603e2"}],"id":"70ff3725-cdc3-4e79-9ccc-5383296aab17","description":"

The Total Expert API uses OAuth2.0 to authorize and authenticate requests to the API.

Before you can use the API, you must first obtain an access token by using the ‘/token’ POST endpoint. Please obtain the token by supplying your client credentials (highlighted above) or an authorization code. Once you have your token, you will use it in the Authorization header of subsequent requests.

Total Expert maintains all production and sandbox/test environments behind the same URL. Your organization will be provided with separate credentials for the production and sandbox/test environments.
The Authentication token is good for 3600 seconds (60 mins).
You will retrieve a token for the highest level of scopes you need for the subsequent calls. Highly recommended best practice is to retrieve the token and cache it for the full hour that it’s valid then request a new token towards the end of the hour.
The Total Expert API has a limit of 1,000 requests per minute on all endpoints.
It might be necessary to requeue the requests for certain response codes. Ensure your organization has a process for error handling. See ‘Return Codes’ section above.

\n","event":[{"listen":"prerequest","script":{"id":"9b4f9026-84a6-4234-9ade-894aa79e2e2a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e58d7879-4bc1-4129-a9bb-af05caa2c0df","type":"text/javascript","exec":[""]}}],"_postman_id":"70ff3725-cdc3-4e79-9ccc-5383296aab17"},{"name":"Heartbeat","item":[{"name":"Fetch Heartbeat","id":"63a2d038-f81f-49c5-90bb-6e388edbdcd2","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{external_api_host}}/v1/heartbeat","description":"

The API will respond with a heartbeat with a string describing the running item. Useful for testing routing and API status.

\n","urlObject":{"path":["v1","heartbeat"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"8bcdea2d-6c48-4bfd-a027-498e826bd2bb","name":"Fetch Heartbeat","originalRequest":{"method":"GET","header":[],"url":"{{external_api_host}}/v1/heartbeat"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"running_item\": \"Total Expert External API\"\n}"}],"_postman_id":"63a2d038-f81f-49c5-90bb-6e388edbdcd2"},{"name":"Fetch Teapot","id":"ffb644a8-7877-7551-8520-64e84da3ab35","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{external_api_host}}/v1/teapot","description":"

Checks whether the API is a teapot. Should return '418 - IM A TEAPOT'. This is, naturally, protected information. You will need to authenticate with the API in order to check whether the API is a teapot.

This endpoint is useful for testing whether your authentication credentials are correct, particularly when first integrating with the TE API.

\n","urlObject":{"path":["v1","teapot"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"c23a4fea-bf5c-4766-b671-bb6c9e94dbd6","name":"Fetch Teapot","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/teapot"},"status":"I'm a teapot (RFC 2324)","code":418,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"418 I'm a teapot\",\n \"status\": \"short and stout\"\n}"}],"_postman_id":"ffb644a8-7877-7551-8520-64e84da3ab35"}],"id":"6880ade4-ca2d-f9ca-bf6e-ba9f3a74bf56","description":"

Endpoints for initial integration testing.

\n","event":[{"listen":"prerequest","script":{"id":"f0cb77eb-3dc0-4986-af17-0c0f84bc00a6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"df3ac0f4-a441-4829-9e0b-f177cac69ab8","type":"text/javascript","exec":[""]}}],"_postman_id":"6880ade4-ca2d-f9ca-bf6e-ba9f3a74bf56"},{"name":"Contact Endpoints","item":[{"name":"Contacts","item":[{"name":"Fetch Contact","id":"bd7c4fef-2dde-494a-857f-ae2d4720ecc1","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{external_api_host}}/v1/contacts/{{contact_id}}","description":"

Fetch a specific contact specified by ID.

\n","urlObject":{"path":["v1","contacts","{{contact_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"37f3f032-d504-4ade-87c8-2a270bf6b2e1","name":"Fetch Contact (as User)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/contacts/{{contact_id}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"address\": \"1234 Fake St\",\n \"address_2\": \"Apartment -8\",\n \"birthday\": \"1900-01-01\",\n \"city\": \"Pleasantville\",\n \"classification\": \"\",\n \"close_date\": \"2016-12-26\",\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"credit_score\": null,\n \"credit_score_date\": null,\n \"credit_score_expiration_date\": null,\n \"email\": \"username@example.com\",\n \"email_work\": \"clark.gable2@totalexpertinc.com\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 10058818144\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_license_number\": null,\n \"employer_name\": \"BigIndustry Co, Inc. LLC\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"external_id\": \"101010\",\n \"fax\": null,\n \"first_name\": \"Clark\",\n \"id\": 2317,\n \"internal_created_at\": \"2019-01-31 18:53:53\",\n \"internal_updated_at\": \"2019-01-31 18:55:29\",\n \"last_contacted_date\": \"2017-01-01 12:12:12\",\n \"last_modified_date\": null,\n \"last_name\": \"Gable\",\n \"license_number\": \"Q10101010101011\",\n \"linkedin_url\": null,\n \"list_date\": \"2016-12-25\",\n \"nickname\": null,\n \"ok_to_call\": false,\n \"ok_to_email\": false,\n \"ok_to_mail\": false,\n \"other_url\": null,\n \"phone_cell\": \"(763)555-0123\",\n \"phone_home\": \"(612)-555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"pre_approval_issued_date\": null,\n \"referred_by\": \"\",\n \"referred_to\": \"\",\n \"source\": \"OurSystem\",\n \"state\": \"MN\",\n \"suffix\": null,\n \"title\": \"Doctor\",\n \"website_url\": null,\n \"zip_code\": \"12345\",\n \"contact_groups\": [\n {\n \"group_name\": \"Past Client\",\n \"id\": 14\n },\n {\n \"group_name\": \"Prospect\",\n \"id\": 15\n }\n ],\n \"external_ids\": [\n {\n \"external_id\": \"abcd\",\n \"source\": \"local\"\n },\n {\n \"external_id\": \"101010\",\n \"source\": \"OurSystem\"\n }\n ],\n \"external_status\": {\n \"status_name\": \"Processing\"\n },\n \"preferences\": {\n \"is_silenced\": true\n },\n \"assignee\": {\n \"email\": \"toni.ark@expert.com\",\n \"external_id\": \"ironExpertExternal\",\n \"id\": \"58\",\n \"username\": \"ironExpert\"\n },\n \"owner\": {\n \"email\": \"stevie.dodgers@expert.com\",\n \"external_id\": \"captainExpertExternal\",\n \"id\": \"59\",\n \"username\": \"captainExpert\"\n },\n \"shared_with_users\": [\n {\n \"email\": \"pete.park@expert.com\",\n \"external_id\": \"spiderExpertExternal\",\n \"id\": \"56\",\n \"username\": \"spiderExpert\"\n }\n ]\n}"},{"id":"44ea5eb2-03aa-4608-b1ed-a55442757220","name":"Fetch Contact (as Admin)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/contacts/{{contact_id}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"address\": \"1234 Fake St\",\n \"address_2\": \"Apartment -8\",\n \"birthday\": \"1900-01-01\",\n \"city\": \"Pleasantville\",\n \"classification\": \"\",\n \"close_date\": \"2016-12-26\",\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"credit_score\": null,\n \"credit_score_date\": null,\n \"credit_score_expiration_date\": null,\n \"email\": \"username@example.com\",\n \"email_work\": \"clark.gable2@totalexpertinc.com\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 10058818144\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_license_number\": null,\n \"employer_name\": \"BigIndustry Co, Inc. LLC\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"external_id\": \"101010\",\n \"fax\": null,\n \"first_name\": \"Clark\",\n \"id\": 2317,\n \"internal_created_at\": \"2019-01-31 18:53:53\",\n \"internal_updated_at\": \"2019-01-31 18:55:29\",\n \"last_contacted_date\": \"2017-01-01 12:12:12\",\n \"last_modified_date\": null,\n \"last_name\": \"Gable\",\n \"license_number\": \"Q10101010101011\",\n \"linkedin_url\": null,\n \"list_date\": \"2016-12-25\",\n \"nickname\": null,\n \"ok_to_call\": false,\n \"ok_to_email\": false,\n \"ok_to_mail\": false,\n \"other_url\": null,\n \"phone_cell\": \"(763)555-0123\",\n \"phone_home\": \"(612)-555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"pre_approval_issued_date\": null,\n \"referred_by\": \"\",\n \"referred_to\": \"\",\n \"source\": \"OurSystem\",\n \"state\": \"MN\",\n \"suffix\": null,\n \"title\": \"Doctor\",\n \"website_url\": null,\n \"zip_code\": \"12345\",\n \"contact_groups\": [\n {\n \"group_name\": \"Past Client\",\n \"id\": 14\n },\n {\n \"group_name\": \"Prospect\",\n \"id\": 15\n }\n ],\n \"external_ids\": [\n {\n \"external_id\": \"abcd\",\n \"source\": \"local\"\n },\n {\n \"external_id\": \"101010\",\n \"source\": \"OurSystem\"\n }\n ],\n \"external_status\": {\n \"status_name\": \"Processing\"\n },\n \"owner\": {\n \"email\": \"ted@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 65412,\n \"username\": \"ted-example\"\n },\n \"preferences\": {\n \"is_silenced\": true\n }\n}"}],"_postman_id":"bd7c4fef-2dde-494a-857f-ae2d4720ecc1"},{"name":"Fetch Contacts","id":"c40877aa-1ea9-4f67-929f-4de286c64ce8","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{external_api_host}}/v1/contacts?page[number]=1&page[size]=10","description":"

Fetch a page of contacts. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","contacts"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"c40877aa-1ea9-4f67-929f-4de286c64ce8"},{"name":"Create Contact (as Admin)","event":[{"listen":"test","script":{"id":"d20f4d42-94a1-4b9e-8be6-3d1db74496bc","type":"text/javascript","exec":[""]}}],"id":"4f48dd5f-bbb5-46e3-bb22-e3c572aa76f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Doctor\",\n \"first_name\": \"Clark\",\n \"last_name\": \"Gable\",\n \"email\": \"username@example.com\",\n \"email_work\": \"clark.gable2@totalexpert.com\",\n \"address\": \"1234 Fake St\",\n \"address_2\": \"Apartment -8\",\n \"city\": \"Pleasantville\",\n \"state\": \"MN\",\n \"zip_code\": \"12345\",\n \"phone_cell\": \"(763)555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"phone_home\": \"(612)-555-0123\",\n \"employer_name\": \"BigIndustry Co, Inc. LLC\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 10058818144\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"license_number\": \"Q10101010101011\",\n \"source\": \"OurSystem\",\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"last_contacted_date\": \"2017-01-01 12:12:12\",\n \"list_date\": \"2016-12-25 10:00:00\",\n \"close_date\": \"2016-12-26 09:09:09\",\n \"external_id\": \"101010\",\n \"birthday\": \"1970-01-01\",\n \"ok_to_mail\": 0,\n \"ok_to_email\": 0,\n \"ok_to_call\": 0,\n \"preferences\":{\n \"is_silenced\": true\n },\n \"owner\" : {\n \"external_id\":\"userExternal1\"\n },\n \"contact_groups\": [\n {\n \"group_name\": \"Past Client\"\n },\n {\n \"id\":\"14\"\n }\n ],\n \"custom\": [\n \t{\n \t\t\"field_name\": \"custom_string\",\n \t\t\"value\": \"the custom field string value\"\n \t}\n ],\n \"external_ids\": [\n {\n \"source\":\"local\",\n \"external_id\":\"abcd\"\n }\n ],\n \"external_status\": {\n \"status_name\":\"Processing\"\n }\n}"},"url":"{{external_api_host}}/v1/contacts","description":"

Create a contact.

Required Attributes (one of the following combinations):

source, first_name, last_name, email
source, first_name, last_name, phone_cell
source, first_name, last_name, phone_home
source, first_name, last_name, phone_office
source, first_name, last_name, address, city, state, zip_code

Required Relationships:

owner*

*required if authenticated as an organization admin

\n","urlObject":{"path":["v1","contacts"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"84e65a9f-0a04-422b-9588-2874cb98060d","name":"Update Contact (as Admin)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Doctor\",\n \"first_name\": \"Clark\",\n \"last_name\": \"Gable\",\n \"email\": \"username@example.com\",\n \"email_work\": \"clark.gable2@totalexpertinc.com\",\n \"address\": \"1234 Fake St\",\n \"address_2\": \"Apartment -8\",\n \"city\": \"Pleasantville\",\n \"state\": \"MN\",\n \"zip_code\": \"12345\",\n \"phone_cell\": \"(763)555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"phone_home\": \"(612)-555-0123\",\n \"employer_name\": \"BigIndustry Co, Inc. LLC\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 10058818144\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"license_number\": \"Q10101010101011\",\n \"source\": \"OurSystem\",\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"last_contacted_date\": \"2017-01-01 12:12:12\",\n \"list_date\": \"2016-12-25 10:00:00\",\n \"close_date\": \"2016-12-26 09:09:09\",\n \"external_id\": \"101010\",\n \"birthday\": \"1970-01-01\",\n \"ok_to_mail\": 0,\n \"ok_to_email\": 0,\n \"ok_to_call\": 0,\n \"preferences\":{\n \"is_silenced\": true\n },\n \"owner\" : {\n \"external_id\":\"userExternal1\"\n },\n \"contact_groups\": [\n {\n \"group_name\": \"Past Client\"\n },\n {\n \"id\":\"14\"\n }\n ],\n \"external_ids\": [\n {\n \"source\":\"local\",\n \"external_id\":\"abcd\"\n }\n ],\n \"external_status\": {\n \"status_name\":\"Processing\"\n }\n}"},"url":"{{external_api_host}}/v1/contacts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"duplicate\": \"external-api.totaldev.us/v1/contacts/56495\",\n \"id\": 56495\n}"},{"id":"62f2924c-3d4a-4887-b5c9-9806f99832d3","name":"Create Contact (as Admin)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Doctor\",\n \"first_name\": \"Clark\",\n \"last_name\": \"Gable\",\n \"email\": \"username@example.com\",\n \"email_work\": \"clark.gable2@totalexpertinc.com\",\n \"address\": \"1234 Fake St\",\n \"address_2\": \"Apartment -8\",\n \"city\": \"Pleasantville\",\n \"state\": \"MN\",\n \"zip_code\": \"12345\",\n \"phone_cell\": \"(763)555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"phone_home\": \"(612)-555-0123\",\n \"employer_name\": \"BigIndustry Co, Inc. LLC\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 10058818144\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"license_number\": \"Q10101010101011\",\n \"source\": \"OurSystem\",\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"last_contacted_date\": \"2017-01-01 12:12:12\",\n \"list_date\": \"2016-12-25 10:00:00\",\n \"close_date\": \"2016-12-26 09:09:09\",\n \"external_id\": \"101010\",\n \"birthday\": \"1970-01-01\",\n \"ok_to_mail\": 0,\n \"ok_to_email\": 0,\n \"ok_to_call\": 0,\n \"preferences\":{\n \"is_silenced\": true\n },\n \"owner\" : {\n \"external_id\":\"userExternal1\"\n },\n \"contact_groups\": [\n {\n \"group_name\": \"Past Client\"\n },\n {\n \"id\":\"14\"\n }\n ],\n \"external_ids\": [\n {\n \"source\":\"local\",\n \"external_id\":\"abcd\"\n }\n ],\n \"external_status\": {\n \"status_name\":\"Processing\"\n }\n}"},"url":"{{external_api_host}}/v1/contacts"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"created\": \"{external_api_host}/v1/contacts/56495\",\n \"id\": 56495\n}"}],"_postman_id":"4f48dd5f-bbb5-46e3-bb22-e3c572aa76f3"},{"name":"Create Contact (as User)","event":[{"listen":"test","script":{"id":"87916f75-b829-457f-9b97-248ea35a51a1","type":"text/javascript","exec":[""]}}],"id":"50bfe0d2-6db0-43de-a838-297e495f7141","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Doctor\",\n \"first_name\": \"Clark\",\n \"last_name\": \"Gable\",\n \"email\": \"username@example.com\",\n \"email_work\": \"clark.gable2@totalexpertinc.com\",\n \"address\": \"1234 Fake St\",\n \"address_2\": \"Apartment -8\",\n \"city\": \"Pleasantville\",\n \"state\": \"MN\",\n \"zip_code\": \"12345\",\n \"phone_cell\": \"(763)555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"phone_home\": \"(612)-555-0123\",\n \"employer_name\": \"BigIndustry Co, Inc. LLC\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 10058818144\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"license_number\": \"Q10101010101011\",\n \"source\": \"OurSystem\",\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"last_contacted_date\": \"2017-01-01 12:12:12\",\n \"list_date\": \"2016-12-25 10:00:00\",\n \"close_date\": \"2016-12-26 09:09:09\",\n \"external_id\": \"101010\",\n \"birthday\": \"1970-01-01\",\n \"ok_to_mail\": 0,\n \"ok_to_email\": 0,\n \"ok_to_call\": 0,\n \"preferences\": {\n \"is_silenced\": 0\n },\n \"external_ids\": [\n {\n \"source\": \"local\",\n \"external_id\": \"abcd\"\n }\n ],\n \"contact_groups\": [\n {\n \"group_name\": \"Past Client\"\n }\n ],\n \"external_status\": {\n \"status_name\": \"Processing\"\n },\n \"owner\": {\n \"external_id\": \"ironExpertExternal\"\n },\n \"assignee\": {\n \"external_id\": \"captainExpertExternal\"\n },\n \"shared_with_users\": [\n {\n \"external_id\": \"spiderExpertExternal\"\n }\n ]\n}"},"url":"{{external_api_host}}/v1/contacts","description":"

Create a contact.

Required Attributes (one of the following combinations):

source, first_name, last_name, email
source, first_name, last_name, phone_cell
source, first_name, last_name, phone_home
source, first_name, last_name, phone_office
source, first_name, last_name, address, city, state, zip_code

Required Relationships:

[none]

\n","urlObject":{"path":["v1","contacts"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"50bfe0d2-6db0-43de-a838-297e495f7141"},{"name":"Create Contact (as Admin) with Entity","event":[{"listen":"test","script":{"id":"d20f4d42-94a1-4b9e-8be6-3d1db74496bc","exec":[""],"type":"text/javascript"}}],"id":"bf48c669-cd20-4907-ae90-5ae84974afa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Doctor\",\n \"first_name\": \"Clark\",\n \"last_name\": \"Gable\",\n \"email\": \"username@example.com\",\n \"email_work\": \"clark.gable2@totalexpertinc.com\",\n \"address\": \"1234 Fake St\",\n \"address_2\": \"Apartment -8\",\n \"city\": \"Pleasantville\",\n \"state\": \"MN\",\n \"zip_code\": \"12345\",\n \"phone_cell\": \"(763)555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"phone_home\": \"(612)-555-0123\",\n \"employer_name\": \"BigIndustry Co, Inc. LLC\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 10058818144\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"license_number\": \"Q10101010101011\",\n \"source\": \"OurSystem\",\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"last_contacted_date\": \"2017-01-01 12:12:12\",\n \"list_date\": \"2016-12-25 10:00:00\",\n \"close_date\": \"2016-12-26 09:09:09\",\n \"external_id\": \"101010\",\n \"birthday\": \"1970-01-01\",\n \"ok_to_mail\": 0,\n \"ok_to_email\": 0,\n \"ok_to_call\": 0,\n \"preferences\": {\n \"is_silenced\": true\n },\n \"owner\": {\n \"external_id\": \"userExternal1\"\n },\n \"contact_groups\": [\n {\n \"group_name\": \"Past Client\"\n },\n {\n \"id\": \"14\"\n }\n ],\n \"external_ids\": [\n {\n \"source\": \"local\",\n \"external_id\": \"abcd\"\n }\n ],\n \"external_status\": {\n \"status_name\": \"Processing\"\n },\n \"related_entities\": [\n {\n \"relationship_type\": {\n \"system_name\": \"household\"\n },\n \"parent\": {\n \"id\": \"1234abcd7\",\n \"entity_name\": \"Gable Household\"\n }\n }\n ]\n}"},"url":"{{external_api_host}}/v1/contacts","description":"

Create a contact.

Required Attributes (one of the following combinations):

source, first_name, last_name, email
source, first_name, last_name, phone_cell
source, first_name, last_name, phone_home
source, first_name, last_name, phone_office
source, first_name, last_name, address, city, state, zip_code

Required Relationships:

owner*

*required if authenticated as an organization admin

\n","urlObject":{"path":["v1","contacts"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bf48c669-cd20-4907-ae90-5ae84974afa2"},{"name":"Update Contact","id":"7b52b130-fe28-4329-994a-442ecf9eed70","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Doctor\",\n \"first_name\": \"Clark\",\n \"last_name\": \"Gable\",\n \"email\": \"username@example.com\",\n \"email_work\": \"clark.gable2@totalexpertinc.com\",\n \"address\": \"1234 Fake St\",\n \"address_2\": \"Apartment -8\",\n \"city\": \"Pleasantville\",\n \"state\": \"MN\",\n \"zip_code\": \"12345\",\n \"phone_cell\": \"(763)555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"phone_home\": \"(612)-555-0123\",\n \"employer_name\": \"BigIndustry Co, Inc. LLC\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 10058818144\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"license_number\": \"Q10101010101011\",\n \"source\": \"OurSystem\",\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"last_contacted\": \"2017-01-01 12:12:12\",\n \"list_date\": \"2016-12-25 10:00:00\",\n \"close_date\": \"2016-12-26 09:09:09\",\n \"external_id\": \"101010\",\n \"birthday\": \"1970-01-01\",\n \"ok_to_mail\": 0,\n \"ok_to_email\": 0,\n \"ok_to_call\": 0,\n \"contact_groups\": [\n {\n \"group_name\": \"Past Client\"\n },\n {\n \"group_name\": \"Open House Visitors\"\n }\n ],\n \"external_ids\": [\n {\n \"source\":\"local\",\n \"external_id\":\"abcd\"\n }\n ]\n}"},"url":"{{external_api_host}}/v1/contacts/{{contact_id}}","description":"

Update an existing contact by ID.

\n","urlObject":{"path":["v1","contacts","{{contact_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7b52b130-fe28-4329-994a-442ecf9eed70"},{"name":"Delete Contact","id":"4efd33e1-f6ae-44c9-9678-78cba2b25ea3","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{external_api_host}}/v1/contacts/{{contact_id}}","description":"

Delete a contact by ID.

\n","urlObject":{"path":["v1","contacts","{{contact_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4efd33e1-f6ae-44c9-9678-78cba2b25ea3"}],"id":"ea884c5a-8eb4-4872-9b08-70a5a910509f","description":"

Endpoints for interacting with the contacts resource.

Attributes

Field	Assignable	Type	Description
id	No	numeric	Generated identifier for contact.
address	Yes	string	Street address portion of contact's address.
address_2	Yes	string	Line 2 portion of contact's address.
birthday	Yes	string	Contact's birthday, formatted as a date with 1970 as the year. Preferred format: '1970-MM-DD'
city	Yes	string	City portion of contact's address.
close_date	Yes	string	Date/time contact closed. Preferred format: 'YYYY-MM-DD HH:mm:ss'
creation_date	Yes	string	Date of creation of this contact. Preferred format: 'YYYY-MM-DD HH:mm:ss'
credit_score	Yes	string	TE credit rating of contact. Accepted values: 'Excellent', 'Good', 'Fair', 'Poor', 'Very Poor'
credit_score_date	Yes	string	Date/time of contact's credit score. Preferred format: 'YYYY-MM-DD HH:mm:ss'
email	Yes	string	Contact's personal email address.
email_work	Yes	string	Contact's work email address.
employer_address	Yes	string	Street address portion of contact's employer's address.
employer_address_2	Yes	string	Line 2 portion of contact's employer's address.
employer_city	Yes	string	City portion of contact's employer's address.
employer_license_number	Yes	string	Contact's employer's license number.
employer_name	Yes	string	Name of contact's employer.
employer_state	Yes	string	State portion of contact's employer's address.
employer_zip	Yes	string	Zip code portion of contact's employer's address.
external_id	Yes	string	Contact's external identifier, e.g. the unique identifier from the contact's source.
fax	Yes	string	Contact's fax number. Preferred format: '(555)555-1234'
first_name	Yes	string	Contact's first name.
internal_created_at	No	string	Date of creation of this contact in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'
internal_updated_at	No	string	Date of last change for this contact in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'
last_contacted_date	Yes	string	Date/time of last interaction with contact. Preferred format: 'YYYY-MM-DD HH:mm:ss'
last_name	Yes	string	Contact's last name.
license_number	Yes	string	Contact's license number.
linkedin_url	Yes	string	Contact's LinkedIn Profile URL
list_date	Yes	string	Date/time contact's home was listed. Preferred format: 'YYYY-MM-DD HH:mm:ss'
nickname	Yes	string	Nickname for the contact
ok_to_call	Yes	string	Indicator whether it is ok to call this contact. 1=yes, 0=no.
ok_to_email	Yes	numeric	Indicator whether it is ok to email this contact. 1=yes, 0=no.
ok_to_mail	Yes	string	Indicator whether it is ok to mail this contact. 1=yes, 0=no.
other_url	Yes	string	Other URL relevant to the contact
phone_cell	Yes	string	Contact's cell phone number, preferred format: '(555)555-1234'
phone_home	Yes	string	Contact's home phone number, preferred format: '(555)555-1234'
phone_office	Yes	string	Contact's office phone number, preferred format: '(555)555-1234'
pre_approval_issued_date	Yes	string	Date loan pre-approval was issued for this lead. Preferred format: 'YYYY-MM-DD HH:mm:ss'
preferences	Yes	object	Collection of owner-specific contact preferences. See the \"Contact Preferences\" table for available attributes.
referred_by	Yes	string	Name of person this contact was referred by.
referred_to	Yes	string	Name of person this contact has been referred to.
source	Yes	string	Source of the contact.
state	Yes	string	State portion of contact's address.
suffix	Yes	string	Contact's suffix, e.g. 'Jr.'
title	Yes	string	Contact's honorific/title, e.g. \"Doctor\"
website_url	Yes	string	URL for the contact's personal website
zip_code	Yes	string	Zip code portion of contact's address.

Contact Preferences

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
is_silenced	Yes	boolean	Indicator whether owner is permitted to communicate with the contact. (0/false - permitted communication, 1/true - denied communication)

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
owner	Yes*	User	username, id, external_id, email	Owning user of the contact. One to many relationship, so returned as an object. *Only assignable/visible if authenticated as an organization admin.
contact_groups	Yes	Contact Group	group_name, id	Groups for this contact. Many-to-many relationship, so returned as an array.
external_ids	Yes	Contact External Id	source,external_id	External ids for this contact, paired with the source for that id. One-to-many relationship, so returned as an array.
related_entities	Yes	*	*	*(See Entities documentation)
channels	Yes	Channel	system_name	Business channels for this contact. Many-to-many relationship, so returned as an array.
wlp_access	Yes	Channel	access_type	WLP Access Type for this contact. Many-to-one relationship, so returns as an object.
custom	Yes	Custom Field	*(See Custom Fields)	*(See Custom Fields)
shared_with_users	Yes	User	username, id, external_id, email	Users that this contact is shared with. Many-to-many relationship, so returned as an array.
assignee	Yes	User	username, id, external_id, email	The user that this contact is assigned to. One-to-many relationship, so returned

Special POST/PATCH Relationships

These relationships are used to manipulate the contact but are neither contact attributes nor bona fide relationships. These attributes will not appear in responses.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Settable Fields	Description
remove_contact_groups	Contact Group	group_name, id	Groups to remove this contact from. Array of group objects.
options	Object	See below table.	Options to apply to the request.
remove_related_entities	*	*	*(See Entities documentation)
remove_channels	Channel	system_name	Channels from which to remove this contact. Array of channel objects.

Special POST/PATCH Attributes

These attributes are used to manipulate the contact but are not contact attributes. These attributes will not appear in responses.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
do_not_contact	String	Indicator whether it is ok to contact this contact.1 = yes, 0 = no.

POST/PATCH Options

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description	Default Value
suppress_emails	boolean	Whether to suppress auto-campaign emails that would be sent as a direct result of this request. WARNING: Using this option has consequences. Do not use this option before talking with your TE integration consultant.	False

Sorting

Use the 'sort=attribute_name,attribute_name_2' query to return the list of contacts sorted by the given attribute. Use a minus sign in front of the attribute name to sort the results in descending order. For example, to sort by the internal_updated_at attribute and place the results in descending order, the URL would include:

/contacts?sort=-internal_updated_at

The sort query supports the attributes listed in the Attributes table. The query does not support sorting by relationship values.

Filtering

Use the 'filter=attribute_name=x,attribute_name_2=y' query to return the list of contacts that meet the filter criteria. For example, to filter contacts modified between Oct. 14, 2017 17:41:01 (UTC) and Oct. 15, 2017 17:41:09 (UTC), sorted by the internal_updated_at attribute in ascending order, the following query could be used:

/contacts?sort=internal_updated_at&filter=internal_updated_at_start=2017-10-14T17:41:01Z,internal_updated_at_end=2017-10-15T17:41:09Z

Use the contains filters to return the list of contacts who's first name, last name or email contains a specific string. The minimum character length for contains filters are 3. For example, in order to query for a list of contacts who's first name contains the string \"cat\" the following query could be used:

/contacts?page[number]=1&page[size]=10&filter=first_name_contains=cat

The supported filter attributes are shown in the following table.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
internal_updated_at_start	ISO-8601 formatted date. The start of the time range of interest, inclusive.
internal_updated_at_end	ISO-8601 formatted date. The end of the time range of interest, inclusive.
owner_id	TE ID of the owning user.
owner_email	Email of the owning user.
owner_username	Username of the owning user.
first_name	First name of the contact.
last_name	Last name of the contact
email	Email of the contact
first_name_contains	First name of the contact contains
last_name_contains	Last name of the contact contains
email_contains	Email of the contact contains
group_id	Contact belongs to the group ID specified
group_name	Contact belongs to the group name specified
phone_cell	Contact's cell phone number
phone_home	Contact's home phone number
phone_office	Contact's office phone number
owner_external_id	External ID of the owning user.
archieved	Indicator whether contact is archieved
external_id	External ID of the contact
source	Source of the contact.

Deduplication Logic

Through the API, the external IDs array contains a contact’s unique identifier that comes from the external source. If there is a match within the external IDs array, the contact is successfully matched as well.

If the external IDs array does not contain a match, the logic looks for matches on first name, last name, and email.
If the first name, last name, and email do not match, the logic looks for matches on first name, last name, and address, city, state, and zip code.
If the first name, last name, address, city, stat, and zip code does not match, the logic looks for matches on first name, last name, and home phone.
If the first name, last name, and home phone does not match, the logic looks for matches on first name, last name, and cell phone.
If the first name, last name, and cell phone does not match, the logic looks for matches on first name, last name, and office phone.
If the first name, last name, and home phone does not match, the system will create a new contact.

\n","event":[{"listen":"prerequest","script":{"id":"04d6c4e2-7300-40cd-af13-973609a911bb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a7972dcb-d897-4099-92a9-9f73a6912719","type":"text/javascript","exec":[""]}}],"_postman_id":"ea884c5a-8eb4-4872-9b08-70a5a910509f"},{"name":"Contact Groups","item":[{"name":"Fetch Contact Group","id":"55c68915-07d2-775d-e454-b7e4708523d7","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{external_api_host}}/v1/contact-groups/{{contact_group_id}}","description":"

Fetch a contact group by ID.

\n","urlObject":{"path":["v1","contact-groups","{{contact_group_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"2546a1cb-efda-4fa7-aae4-0a4a13b7a7b0","name":"Fetch Contact Group (as User)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/contact-groups/{{contact_group_id}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"group_name\": \"My Group\",\n \"id\": 15643,\n \"user_editable\": false\n}"},{"id":"1901943d-2adf-4f9e-8522-14d031147331","name":"Fetch Contact Group (as Admin)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/contact-groups/{{contact_group_id}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"group_name\": \"My Group\",\n \"id\": 15643,\n \"user_editable\": false,\n \"owner\": {\n \"email\": \"ted@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 65412,\n \"username\": \"ted-example\"\n }\n}"}],"_postman_id":"55c68915-07d2-775d-e454-b7e4708523d7"},{"name":"Fetch Contact Groups","id":"1f0ae00b-59b5-5ff8-f396-fbb9e0d48cbf","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{external_api_host}}/v1/contact-groups?page[number]=1&page[size]=100","description":"

Fetch a page of contact groups. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","contact-groups"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"100"}],"variable":[]}},"response":[{"id":"c1c31b8e-76e1-45bb-8520-7d0ccf17ab9c","name":"Fetch Contact Groups (as Admin)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"{{external_api_host}}/v1/contact-groups?page[number]=1&page[size]=100","host":["{{external_api_host}}"],"path":["v1","contact-groups"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"100"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"group_name\": \"Active Lead\",\n \"id\": 5,\n \"user_editable\": false,\n \"owner\": {\n \"email\": \"ted@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 65412,\n \"username\": \"ted-example\"\n }\n },\n {\n \"group_name\": \"Active Client\",\n \"id\": 6,\n \"user_editable\": false,\n \"owner\": {\n \"email\": \"ted@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 65412,\n \"username\": \"ted-example\"\n }\n },\n {\n \"group_name\": \"Past Client\",\n \"id\": 7,\n \"user_editable\": false,\n \"owner\": {\n \"email\": \"ted@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 65412,\n \"username\": \"ted-example\"\n }\n },\n {\n \"group_name\": \"Won\",\n \"id\": 8,\n \"user_editable\": false,\n \"owner\": {\n \"email\": \"ted@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 65412,\n \"username\": \"ted-example\"\n }\n },\n {\n \"group_name\": \"Lost\",\n \"id\": 9,\n \"user_editable\": false,\n \"owner\": {\n \"email\": \"ted@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 65412,\n \"username\": \"ted-example\"\n }\n },\n {\n \"group_name\": \"Pre-Approved\",\n \"id\": 10,\n \"user_editable\": false,\n \"owner\": {\n \"email\": \"ted@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 65412,\n \"username\": \"ted-example\"\n }\n },\n {\n \"group_name\": \"Referral\",\n \"id\": 11,\n \"user_editable\": false,\n \"owner\": {\n \"email\": \"ted@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 65412,\n \"username\": \"ted-example\"\n }\n },\n {\n \"group_name\": \"Under Contract\",\n \"id\": 12,\n \"user_editable\": false,\n \"owner\": {\n \"email\": \"ted@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 65412,\n \"username\": \"ted-example\"\n }\n },\n {\n \"group_name\": \"Dead\",\n \"id\": 13,\n \"user_editable\": false,\n \"owner\": {\n \"email\": \"ted@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 65412,\n \"username\": \"ted-example\"\n }\n },\n {\n \"group_name\": \"Past Client\",\n \"id\": 14,\n \"user_editable\": false,\n \"owner\": {\n \"email\": \"eric@example.com\",\n \"external_id\": \"userExternalTwo\",\n \"id\": 70564,\n \"username\": \"eric-example\"\n }\n }\n ],\n \"links\": {\n \"first\": 1,\n \"last\": 2,\n \"next\": 2,\n \"prev\": null\n }\n}"}],"_postman_id":"1f0ae00b-59b5-5ff8-f396-fbb9e0d48cbf"},{"name":"Create Contact Group (as Admin)","event":[{"listen":"test","script":{"id":"a5f90b6e-6fdd-4b26-a675-dcb1fd99acba","type":"text/javascript","exec":[""]}}],"id":"8490f4dc-d5ef-e466-e24e-c421f1ee1d5b","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"group_name\": \"My Group\",\n \"owner\": {\n \"external_id\":\"userExternal1\"\n }\n}"},"url":"{{external_api_host}}/v1/contact-groups","description":"

Create a contact group.

Required Attributes:

group_name

Required Relationships:

owner*

*required if authenticated as an organization admin

\n","urlObject":{"path":["v1","contact-groups"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"706aa209-4b2b-4811-800a-d459683051c5","name":"Owner not found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"group_name\": \"My Group\",\n \"owner\": {\n \"external_id\":\"userExternal1\"\n }\n}"},"url":"{{external_api_host}}/v1/contact-groups"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Unable to find target for relationship: 'owner'\"\n}"},{"id":"38a76b3d-9304-4a5b-88ba-bed1d56e34e2","name":"Create Contact Group (as Admin)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"group_name\": \"My Group\",\n \"owner\": {\n \"external_id\":\"userExternal1\"\n }\n}"},"url":"{{external_api_host}}/v1/contact-groups"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"created\": \"{{external_api_host}}/v1/contact-groups/15643\",\n \"id\": 15643\n}"}],"_postman_id":"8490f4dc-d5ef-e466-e24e-c421f1ee1d5b"},{"name":"Create Contact Group (as User)","event":[{"listen":"test","script":{"id":"f7b54c61-6814-4d02-bc30-34b23722ea7b","type":"text/javascript","exec":[""]}}],"id":"b2084398-935e-97c7-3d1c-2d79d2dc46d6","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"group_name\": \"My Group\"\n}"},"url":"{{external_api_host}}/v1/contact-groups","description":"

Create a contact group.

Required Attributes:

group_name

Required Relationships:

[none]

\n","urlObject":{"path":["v1","contact-groups"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"aa765087-1b3a-44da-afe3-5417b6f9ba88","name":"Create Contact Group (as User)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"group_name\": \"My Group\"\n}"},"url":"{{external_api_host}}/v1/contact-groups"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"created\": \"{{external_api_host}}/v1/contact-groups/15656\",\n \"id\": 15656\n}"}],"_postman_id":"b2084398-935e-97c7-3d1c-2d79d2dc46d6"},{"name":"Update Contact Group","id":"ee00ae8a-43b3-8244-9da8-725429944ac6","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"group_name\": \"My Group\"\n}"},"url":"{{external_api_host}}/v1/contact-groups/{{contact_group_id}}","description":"

Update an existing contact group by ID.

Deletes a contact group by ID.

Groups are an easy way for you to combine and categorize certain contacts or leads.

NOTE: \nSome organizations require specific groups to be added to a contact on contact creation or the API call will fail. If you an encounter this error, please reach out to the organization you are working with to get a list of their currently required groups.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	numeric	Generated identifier for contact group.
group_name	Yes	string	Name of the contact groups.
user_editable	Yes	boolean	Whether the group can be edited in the UI. Defaults to true.

Uniqueness

\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Fields
1	group_name

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
owner	Yes*	User	username, id, external_id, email	Owning user of the contact. One to many relationship, so returned as an object. *Only assignable/visible if authenticated as an organization admin.

","event":[{"listen":"prerequest","script":{"id":"23bce064-b90b-4101-899b-4e0adf9c5a69","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fa92abe1-2eec-453c-8b81-fe816c757fbd","type":"text/javascript","exec":[""]}}],"_postman_id":"544e8dd1-6ed8-0e4c-e02c-5fcc1317ae85"},{"name":"Contact Surveys","item":[{"name":"Get Contact Survey","id":"0b29a944-268a-4d02-a399-78439063c4c4","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{external_api_host}}/v1/contact-surveys/{{contact_survey_id}}","description":"

Fetch a specific survey specified by ID.

\n","urlObject":{"path":["v1","contact-surveys","{{contact_survey_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"f2559377-ba83-4760-97ac-9a4cfce17b68","name":"Get Contact Survey","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{external_api_host}}/v1/contact-surveys/{{contact_survey_id}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"external_id\": null,\n \"id\": \"69003b93703638cf\",\n \"internal_created_at\": \"2018-10-23 20:55:21\",\n \"survey_name\": \"First Time Buyer Funnel\",\n \"version\": \"1.3\",\n \"questions\": [\n {\n \"data_type\": \"text\",\n \"id\": \"7d06643723812637\",\n \"question_text\": \"Any additional information you would like to leave?\",\n \"sort_order\": \"3\",\n \"system_name\": \"comments\"\n },\n {\n \"data_type\": \"choice\",\n \"id\": \"e68569b18b191912\",\n \"question_text\": \"Are granite countertops a must?\",\n \"sort_order\": \"2\",\n \"system_name\": \"granite_tops\",\n \"possible_choice_answers\": [\n {\n \"sort_order\": \"0\",\n \"system_name\": \"no\",\n \"value\": \"Nope\"\n },\n {\n \"sort_order\": \"0\",\n \"system_name\": \"yes\",\n \"value\": \"Absolutely!\"\n }\n ]\n },\n {\n \"data_type\": \"decimal\",\n \"id\": \"f8781f1a6d2f3ab5\",\n \"question_text\": \"What is your maximum price range?\",\n \"sort_order\": \"1\",\n \"system_name\": \"max_price\"\n }\n ]\n}"}],"_postman_id":"0b29a944-268a-4d02-a399-78439063c4c4"},{"name":"Get Contact Surveys","id":"1df1c4c0-e583-47d9-9fa1-f92a87f61c97","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{external_api_host}}/v1/contact-surveys?page[number]=1&page[size]=10","description":"

Fetch a page of surveys. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","contact-surveys"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"1df1c4c0-e583-47d9-9fa1-f92a87f61c97"},{"name":"Create Contact Survey","id":"0d3a515f-9be8-4a53-bf94-c853a95ca868","request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"source\": \"Survey Origination System\",\r\n \"survey_name\": \"First Time Buyer Funnel\",\r\n \"version\": \"1.3\",\r\n \"questions\": [\r\n {\r\n \"question_text\": \"What is your maximum price range?\",\r\n \"system_name\": \"max_price\",\r\n \"data_type\": \"decimal\",\r\n \"sort_order\": \"1\" \r\n },\r\n {\r\n \"question_text\": \"Any additional information you would like to leave?\",\r\n \"system_name\": \"comments\",\r\n \"data_type\": \"text\",\r\n \"sort_order\": \"3\" \r\n },\r\n {\r\n \"question_text\": \"Are granite countertops a must?\",\r\n \"system_name\": \"granite_tops\",\r\n \"data_type\": \"choice\",\r\n \"sort_order\": \"2\",\r\n \"possible_choice_answers\": [\r\n {\r\n \"value\":\"Absolutely!\",\r\n \"system_name\":\"yes\"\r\n },\r\n {\r\n \"value\":\"Nope\",\r\n \"system_name\":\"no\"\r\n }\r\n ]\r\n }\r\n ]\r\n}"},"url":"{{external_api_host}}/v1/contact-surveys","description":"

Create a survey.

Required Attributes:

source
survey_name
questions
questions.question_text
questions.system_name
questions.data_type

\n","urlObject":{"path":["v1","contact-surveys"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"b86da6ad-b4b5-4c20-9460-e084647998fe","name":"Create Contact Survey","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"source\": \"Survey Origination System\",\r\n \"survey_name\": \"First Time Buyer Funnel\",\r\n \"version\": \"1.3\",\r\n \"questions\": [\r\n {\r\n \"question_text\": \"What is your maximum price range?\",\r\n \"system_name\": \"max_price\",\r\n \"data_type\": \"decimal\",\r\n \"sort_order\": \"1\" \r\n },\r\n {\r\n \"question_text\": \"Any additional information you would like to leave?\",\r\n \"system_name\": \"comments\",\r\n \"data_type\": \"text\",\r\n \"sort_order\": \"3\" \r\n },\r\n {\r\n \"question_text\": \"Are granite countertops a must?\",\r\n \"system_name\": \"granite_tops\",\r\n \"data_type\": \"choice\",\r\n \"sort_order\": \"2\",\r\n \"possible_choice_answers\": [\r\n {\r\n \"value\":\"Absolutely!\",\r\n \"system_name\":\"yes\"\r\n },\r\n {\r\n \"value\":\"Nope\",\r\n \"system_name\":\"no\"\r\n }\r\n ]\r\n }\r\n ]\r\n}"},"url":"{{external_api_host}}/v1/contact-surveys"},"status":"Created","code":201,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"created\": \"public.totalexpert.net/v1/contact-surveys/69003b93703638cf\",\r\n \"id\": \"69003b93703638cf\"\r\n}"}],"_postman_id":"0d3a515f-9be8-4a53-bf94-c853a95ca868"},{"name":"Update Contact Survey","id":"1a23ef5d-ae4f-4ab2-8abc-ce2a39cbc93a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"source\": \"Survey Origination System\",\n \"survey_name\": \"First Time Buyer Funnel\",\n \"version\": \"1.3\",\n \"questions\": [\n {\n \"question_text\": \"What is your maximum price range?\",\n \"system_name\": \"max_price\",\n \"data_type\": \"decimal\",\n \"sort_order\": \"1\" \n },\n {\n \"question_text\": \"Any additional information you would like to leave?\",\n \"system_name\": \"comments\",\n \"data_type\": \"text\",\n \"sort_order\": \"3\" \n },\n {\n \"question_text\": \"Are granite countertops a must?\",\n \"system_name\": \"granite_tops\",\n \"data_type\": \"choice\",\n \"sort_order\": \"2\",\n \"possible_choice_answers\": [\n {\n \"value\":\"Absolutely!\",\n \"system_name\":\"yes\"\n },\n {\n \"value\":\"Nope\",\n \"system_name\":\"no\"\n }\n ]\n }\n ]\n}"},"url":"{{external_api_host}}/v1/contact-surveys/{{contact_survey_id}}","description":"

Update a survey.

Required Attributes:

At least one questions array, which could be empty.

\n","urlObject":{"path":["v1","contact-surveys","{{contact_survey_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"b16b3751-40fe-4bbe-a0e0-59217b4280de","name":"Update Contact Survey","originalRequest":{"method":"PATCH","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"source\": \"Survey Origination System\",\n \"survey_name\": \"First Time Buyer Funnel\",\n \"version\": \"1.3\",\n \"questions\": [\n {\n \"question_text\": \"What is your maximum price range?\",\n \"system_name\": \"max_price\",\n \"data_type\": \"decimal\",\n \"sort_order\": \"1\" \n },\n {\n \"question_text\": \"Any additional information you would like to leave?\",\n \"system_name\": \"comments\",\n \"data_type\": \"text\",\n \"sort_order\": \"3\" \n },\n {\n \"question_text\": \"Are granite countertops a must?\",\n \"system_name\": \"granite_tops\",\n \"data_type\": \"choice\",\n \"sort_order\": \"2\",\n \"possible_choice_answers\": [\n {\n \"value\":\"Absolutely!\",\n \"system_name\":\"yes\"\n },\n {\n \"value\":\"Nope\",\n \"system_name\":\"no\"\n }\n ]\n }\n ]\n}"},"url":"{{external_api_host}}/v1/contact-surveys/{{contact_survey_id}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"created\": \"public.totalexpert.net/v1/contact-surveys/69003b93703638cf\",\n \"id\": \"69003b93703638cf\"\n}"}],"_postman_id":"1a23ef5d-ae4f-4ab2-8abc-ce2a39cbc93a"}],"id":"7b449914-780f-4d14-a912-010d431fa25e","description":"

Endpoints for interacting with the contact surveys resource.

Overview

Surveys are a flexible data structure that allow integrations to store additional details around a contact that aren’t supported by the standard contact field set. For example, if a contact was interested in a refinance opportunity and supplied information about their property location, value, and existing mortgage, etc., you could store this information in a survey response and tie it to that contact.

Advantages of using the surveys endpoint

There are a few advantages to using the surveys endpoint:

Multiple survey structures can be created for an organization for different purposes. You can have one for refinance, auto loan interest, or any other data you wish to collect from your contacts.
A contact can submit multiple surveys and new submissions will show up in the survey response area in the UI rather than overwriting old data. This makes it easy to keep track of different interactions with the contact.
Contact survey responses can be used to trigger marketing automation and can also be used as different conditions within the journey.

General Flow

To submit survey responses to the API (examples in the Contact Survey Responses documentation), you first need to create the survey. The survey is structured as a set of questions and potential answers with their field types.

When creating the survey via the API, the API will return a survey ID in its response. Once you have that ID, you can retrieve the IDs of the questions from the API for use when creating a survey response.

Now that you have the IDs of the questions, you can create survey responses for that specific organization when data is being sent to Total Expert from your platform as described in the Contact Surveys Response documentation.

Note
If you are sending standard contact data with a survey, that will have to be sent first in a separate request so that you can obtain the Total Expert contact ID that you want to associate the survey with.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	string	Generated identifier for survey.
external_id	Yes	string	Survey's external identifier.
internal_created_at	No	string	Date of creation of this survey in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'
questions	Yes	object	Collection of questions. See the \"Contact Survey Question Attributes\" table for available attributes.
source	Yes	string	Source system of the survey.
survey_name	Yes	string	Name of the survey.
version	Yes	string	Survey's version.

Contact Survey Question Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
data_type	Yes	string	Question type. One of: decimal, choice, text. If choice, possible_choice_answers must be provided.
possible_choice_answers	Yes	object	Collection of multiple-choice answers. See the \"Contact Survey Question Choice Answer Attributes\" table for available attributes.
question_text	Yes	string	Content of the survey question.
sort_order	Yes	integer	For UI. Order of this question in any list displayed in TE UI.
system_name	Yes	string	Normalized name which TE can use to match questions across surveys. For example, if a Refinance funnel and a New Home funnel have the same question, using the same system name on both questions will allow TE to treat them in the same way for triggering events. Questions in the same survey must have unique system names.

Contact Survey Question Choice Answer Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
sort_order	Yes	integer	For UI. Order of this choice in any list displayed in TE UI.
system_name	Yes	string	Normalized name which TE can use to match choice values across surveys/questions.
value	Yes	string	Content of the choice.

Filtering

Use the 'filter=attribute_name=x,attribute_name_2=y' query to return the list of contact surveys that meet the filter criteria. For example, to filter contact surveys created between Oct. 14, 2017 17:41:01 (UTC) and Oct. 15, 2017 17:41:09 (UTC), the following query could be used:

/contact-surveys?filter=internal_created_at_start=2017-10-14T17:41:01Z,internal_created_at_end=2017-10-15T17:41:09Z

The supported filter attributes are shown in the following table.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
internal_created_at_start	ISO-8601 formatted date. The start of the time range of interest, inclusive.
internal_created_at_end	ISO-8601 formatted date. The end of the time range of interest, inclusive.
survey_name	Name of the survey.
version	Survey's version.

","event":[{"listen":"prerequest","script":{"id":"54043eca-709f-4aa6-ae5a-cf27182c6a41","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"84647ef4-e5aa-42ac-bd58-9c4567f4fe02","type":"text/javascript","exec":[""]}}],"_postman_id":"7b449914-780f-4d14-a912-010d431fa25e"},{"name":"Contact Survey Responses","item":[{"name":"Get Contact Survey Response","id":"79cfa4a8-fddc-475f-a026-9d294ddc901b","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{external_api_host}}/v1/contact-survey-responses/{{contact_survey_response_id}}","description":"

Fetch a specific survey response specified by ID.

\n","urlObject":{"path":["v1","contact-survey-responses","{{contact_survey_response_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"a5e359ce-167b-47ce-8f58-35b41ab50fbd","name":"Get Contact Survey Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"{{external_api_host}}/v1/contact-survey-responses/{{contact_survey_response_id}}","host":["{{external_api_host}}"],"path":["v1","contact-survey-responses","{{contact_survey_response_id}}"],"query":[{"key":"","value":"","type":"text"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"fe20e62940c8a6fb\",\n \"internal_created_at\": \"2018-10-23 21:10:27\",\n \"contact\": {\n \"id\": 4\n },\n \"question_responses\": [\n {\n \"response_value\": \"265000\",\n \"question\": {\n \"data_type\": \"decimal\",\n \"id\": \"f8781f1a6d2f3ab5\",\n \"question_text\": \"What is your maximum price range?\",\n \"sort_order\": \"1\",\n \"system_name\": \"max_price\"\n }\n },\n {\n \"response_value\": \"Nope\",\n \"question\": {\n \"data_type\": \"choice\",\n \"id\": \"e68569b18b191912\",\n \"question_text\": \"Are granite countertops a must?\",\n \"sort_order\": \"2\",\n \"system_name\": \"granite_tops\",\n \"possible_choice_answers\": [\n {\n \"sort_order\": \"0\",\n \"system_name\": \"no\",\n \"value\": \"Nope\"\n },\n {\n \"sort_order\": \"0\",\n \"system_name\": \"yes\",\n \"value\": \"Absolutely!\"\n }\n ]\n }\n },\n {\n \"response_value\": \"Look forward to working with you!\",\n \"question\": {\n \"data_type\": \"text\",\n \"id\": \"7d06643723812637\",\n \"question_text\": \"Any additional information you would like to leave?\",\n \"sort_order\": \"3\",\n \"system_name\": \"comments\"\n }\n }\n ]\n}"}],"_postman_id":"79cfa4a8-fddc-475f-a026-9d294ddc901b"},{"name":"Get Contact Survey Responses","id":"a4b52c6b-97c7-4fa8-969f-995ee85ca8f3","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{external_api_host}}/v1/contact-survey-responses?page[number]=1&page[size]=10","description":"

Fetch a page of survey responses. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","contact-survey-responses"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"a4b52c6b-97c7-4fa8-969f-995ee85ca8f3"},{"name":"Create Contact Survey Response (As User)","id":"e498f48d-05ed-48d5-9510-8c1e0a5c52e2","request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"contact\": {\r\n\t\t\"id\": 4\r\n\t},\r\n\t\"survey\": {\r\n\t\t\"id\": \"69003b93703638cf\"\r\n\t},\r\n\t\"question_responses\": [\r\n\t\t{\r\n\t\t\t\"question\": {\r\n\t\t\t \"id\": \"f8781f1a6d2f3ab5\"\r\n\t\t\t},\r\n\t\t\t\"response_value\": \"265000\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"question\": {\r\n\t\t\t\t\"id\": \"e68569b18b191912\"\r\n\t\t\t},\r\n\t\t\t\"response_value\": \"Nope\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"question\": {\r\n\t\t\t\t\"id\": \"7d06643723812637\"\r\n\t\t\t},\r\n\t\t\t\"response_value\": \"Look forward to working with you!\"\r\n\t\t}\r\n\t]\r\n}"},"url":"{{external_api_host}}/v1/contact-survey-responses","description":"

Create a response to a survey. Once created, responses may not be modified.

Required Attributes:

question_responses

Required Relationships:

survey
contact

\n","urlObject":{"path":["v1","contact-survey-responses"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"42f4b24e-3633-4fc5-996b-1e86a9249f7d","name":"Create Contact Survey Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"contact\": {\r\n\t\t\"id\": 4\r\n\t},\r\n\t\"survey\": {\r\n\t\t\"id\": \"69003b93703638cf\"\r\n\t},\r\n\t\"question_responses\": [\r\n\t\t{\r\n\t\t\t\"question\": {\r\n\t\t\t \"id\": \"f8781f1a6d2f3ab5\"\r\n\t\t\t},\r\n\t\t\t\"response_value\": \"265000\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"question\": {\r\n\t\t\t\t\"id\": \"e68569b18b191912\"\r\n\t\t\t},\r\n\t\t\t\"response_value\": \"Nope\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"question\": {\r\n\t\t\t\t\"id\": \"7d06643723812637\"\r\n\t\t\t},\r\n\t\t\t\"response_value\": \"Look forward to working with you!\"\r\n\t\t}\r\n\t]\r\n}"},"url":"{{external_api_host}}/v1/contact-survey-responses"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"created\": \"public.totalexpert.net/v1/contact-survey-responses/192c0803946dab25\",\n \"id\": \"192c0803946dab25\"\n}"},{"id":"4180a1ef-5807-4af3-8c77-668558b64b0c","name":"Unknown contact","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"contact\": {\r\n\t\t\"id\": 600\r\n\t},\r\n\t\"survey\": {\r\n\t\t\"id\": \"69003b93703638cf\"\r\n\t},\r\n\t\"question_responses\": [\r\n\t\t{\r\n\t\t\t\"question\": {\r\n\t\t\t \"id\": \"f8781f1a6d2f3ab5\"\r\n\t\t\t},\r\n\t\t\t\"response_value\": \"265000\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"question\": {\r\n\t\t\t\t\"id\": \"e68569b18b191912\"\r\n\t\t\t},\r\n\t\t\t\"response_value\": \"Nope\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"question\": {\r\n\t\t\t\t\"id\": \"7d06643723812637\"\r\n\t\t\t},\r\n\t\t\t\"response_value\": \"Look forward to working with you!\"\r\n\t\t}\r\n\t]\r\n}"},"url":"{{external_api_host}}/v1/contact-survey-responses"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Unable to find target for relationship: 'contact'\"\n}"}],"_postman_id":"e498f48d-05ed-48d5-9510-8c1e0a5c52e2"},{"name":"Create Contact Survey Response (As Admin)","id":"a59b27e6-2ecd-453e-9298-f6038bc98392","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contact\": {\n \"id\": 4\n },\n \"survey\": {\n \"id\": \"69003b93703638cf\"\n },\n \"owner\": {\n \"external_id\": \"userExternal1\"\n },\n \"question_responses\": [\n {\n \"question\": {\n \"id\": \"f8781f1a6d2f3ab5\"\n },\n \"response_value\": \"265000\"\n },\n {\n \"question\": {\n \"id\": \"e68569b18b191912\"\n },\n \"response_value\": \"Nope\"\n },\n {\n \"question\": {\n \"id\": \"7d06643723812637\"\n },\n \"response_value\": \"Look forward to working with you!\"\n }\n ]\n}"},"url":"{{external_api_host}}/v1/contact-survey-responses","description":"

Create a response to a survey. Once created, responses may not be modified.

Required Attributes:

question_responses

Required Relationships:

survey
contact
owner

\n","urlObject":{"path":["v1","contact-survey-responses"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"145b45b6-84f0-44fa-98db-29a890b57261","name":"Create Contact Survey Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"contact\": {\r\n\t\t\"id\": 4\r\n\t},\r\n\t\"survey\": {\r\n\t\t\"id\": \"69003b93703638cf\"\r\n\t},\r\n\t\"question_responses\": [\r\n\t\t{\r\n\t\t\t\"question\": {\r\n\t\t\t \"id\": \"f8781f1a6d2f3ab5\"\r\n\t\t\t},\r\n\t\t\t\"response_value\": \"265000\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"question\": {\r\n\t\t\t\t\"id\": \"e68569b18b191912\"\r\n\t\t\t},\r\n\t\t\t\"response_value\": \"Nope\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"question\": {\r\n\t\t\t\t\"id\": \"7d06643723812637\"\r\n\t\t\t},\r\n\t\t\t\"response_value\": \"Look forward to working with you!\"\r\n\t\t}\r\n\t]\r\n}"},"url":"{{external_api_host}}/v1/contact-survey-responses"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"created\": \"public.totalexpert.net/v1/contact-survey-responses/192c0803946dab25\",\n \"id\": \"192c0803946dab25\"\n}"},{"id":"7c1c4d20-a4e1-45a6-b38a-12fb61c61aa5","name":"Unknown contact","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"contact\": {\r\n\t\t\"id\": 600\r\n\t},\r\n\t\"survey\": {\r\n\t\t\"id\": \"69003b93703638cf\"\r\n\t},\r\n\t\"question_responses\": [\r\n\t\t{\r\n\t\t\t\"question\": {\r\n\t\t\t \"id\": \"f8781f1a6d2f3ab5\"\r\n\t\t\t},\r\n\t\t\t\"response_value\": \"265000\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"question\": {\r\n\t\t\t\t\"id\": \"e68569b18b191912\"\r\n\t\t\t},\r\n\t\t\t\"response_value\": \"Nope\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"question\": {\r\n\t\t\t\t\"id\": \"7d06643723812637\"\r\n\t\t\t},\r\n\t\t\t\"response_value\": \"Look forward to working with you!\"\r\n\t\t}\r\n\t]\r\n}"},"url":"{{external_api_host}}/v1/contact-survey-responses"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Unable to find target for relationship: 'contact'\"\n}"}],"_postman_id":"a59b27e6-2ecd-453e-9298-f6038bc98392"}],"id":"5474dd9a-9c5e-407d-94a8-c5b4f5b46a5c","description":"

Endpoints for interacting with the contact survey responses resource.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	string	Generated identifier for survey response.
internal_created_at	No	string	Date of creation of this survey in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'
question_responses	Yes	object	Collection of question responses. See the \"Contact Survey Question Response Attributes\" table for available attributes.

Contact Survey Question Response Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
response_value	Yes	string	Value entered in response to question. If this is a response to a 'choice' question this value must be one of the configured 'possible_choice_answers'.

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
owner	Yes*	User	username, id, external_id, email	Owning user of the contact. One to many relationship, so returned as an object. *Only assignable/visible if authenticated as an organization admin.
contact	Yes	Contact	See contact documentation for uniqueness options.	Contact who provided these responses. One to many relationship, so returned as an object. Contact must already exist in the system.
survey	Yes	Contact Survey	id	Survey that this is a response to. Returned as an object. Survey must already exist in the system.

","event":[{"listen":"prerequest","script":{"id":"54043eca-709f-4aa6-ae5a-cf27182c6a41","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"84647ef4-e5aa-42ac-bd58-9c4567f4fe02","type":"text/javascript","exec":[""]}}],"_postman_id":"5474dd9a-9c5e-407d-94a8-c5b4f5b46a5c"},{"name":"Contact Notes","item":[{"name":"Fetch Contact Note","id":"df5d790c-6c9a-a8a8-62bf-e022dbee1791","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{external_api_host}}/v1/contact-notes/{{contact_note_id}}","description":"

Fetch a contact notes by ID.

\n","urlObject":{"path":["v1","contact-notes","{{contact_note_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"e6df4cf8-781d-4b83-b040-3ea1c3beafcf","name":"Fetch Contact Note","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/contact-notes/14"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 14,\n \"note\": \"My Note Content2\",\n \"title\": \"My Title2\",\n \"type_id\": \"2\",\n \"contact\": {\n \"id\": 65489\n },\n \"owner\": {\n \"email\": \"ted@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 65412,\n \"username\": \"ted-example\"\n }\n}"}],"_postman_id":"df5d790c-6c9a-a8a8-62bf-e022dbee1791"},{"name":"Fetch Contact Notes","id":"2733186e-20e1-cdb1-a125-2c55d9b1679b","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{external_api_host}}/v1/contact-notes?page[number]=1&page[size]=10","description":"

Fetch a page of contact notes. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","contact-notes"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[{"id":"b8a701a3-171e-4017-a634-a875274f4359","name":"Fetch Contact Notes (as User)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"{{external_api_host}}/v1/contact-notes?page[number]=1&page[size]=10","host":["{{external_api_host}}"],"path":["v1","contact-notes"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"items\": [\r\n {\r\n \"id\": 1,\r\n \"note\": \"Additional information pending\",\r\n \"title\": \"Contact info\",\r\n \"type_id\": \"1\",\r\n \"contact\": {\r\n \"id\": 45613\r\n }\r\n },\r\n {\r\n \"id\": 2,\r\n \"note\": \"This is a note with a link https://www.totalexpert.com\",\r\n \"title\": \"Link note\",\r\n \"type_id\": \"1\",\r\n \"contact\": {\r\n \"id\": 65548\r\n }\r\n },\r\n {\r\n \"id\": 3,\r\n \"note\": \"This needs attention\",\r\n \"title\": \"Contact update success\",\r\n \"type_id\": \"2\",\r\n \"contact\": {\r\n \"id\": 65548\r\n }\r\n },\r\n {\r\n \"id\": 4,\r\n \"note\": \"Failed to push contact\",\r\n \"title\": \"Integration Note\",\r\n \"type_id\": \"2\",\r\n \"contact\": {\r\n \"id\": 65548\r\n }\r\n }\r\n ],\r\n \"links\": {\r\n \"first\": 1,\r\n \"last\": 1,\r\n \"next\": null,\r\n \"prev\": null\r\n }\r\n}"},{"id":"6c7f3234-ebf4-4377-94eb-454e357ce69b","name":"Fetch Contact Notes (as Admin)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"{{external_api_host}}/v1/contact-notes?page[number]=1&page[size]=10","host":["{{external_api_host}}"],"path":["v1","contact-notes"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": 1,\n \"note\": \"Additional information pending\",\n \"title\": \"Contact info\",\n \"type_id\": \"1\",\n \"contact\": {\n \"id\": 45613\n },\n \"owner\": {\n \"email\": \"ted@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 65412,\n \"username\": \"ted-example\"\n }\n },\n {\n \"id\": 2,\n \"note\": \"This is a note with a link https://www.totalexpert.com\",\n \"title\": \"Link note\",\n \"type_id\": \"1\",\n \"contact\": {\n \"id\": 65548\n },\n \"owner\": {\n \"email\": \"ted@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 65412,\n \"username\": \"ted-example\"\n }\n },\n {\n \"id\": 3,\n \"note\": \"This needs attention\",\n \"title\": \"Contact update success\",\n \"type_id\": \"2\",\n \"owner\": {\n \"email\": \"ted@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 65412,\n \"username\": \"ted-example\"\n }\n },\n {\n \"id\": 4,\n \"note\": \"Failed to push contact\",\n \"title\": \"Integration Note\",\n \"type_id\": \"2\",\n \"owner\": {\n \"email\": \"ted@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 65412,\n \"username\": \"ted-example\"\n }\n }\n ],\n \"links\": {\n \"first\": 1,\n \"last\": 1,\n \"next\": null,\n \"prev\": null\n }\n}"}],"_postman_id":"2733186e-20e1-cdb1-a125-2c55d9b1679b"},{"name":"Create Contact Note (as User)","event":[{"listen":"test","script":{"id":"e3bee73e-c6b4-4213-9533-4348175929f2","type":"text/javascript","exec":[""]}}],"id":"a1283d5c-4f32-f5e7-5f5a-003dab781a32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"My Title\",\n \"note\": \"My Note Content:
It includes linebreaks ^superscripts, _subscripts, and even italicized text!!\",\n \"type_id\": 1,\n \"contact\": {\n \"first_name\":\"Clark\",\n \"last_name\":\"Gable2\",\n \"email\":\"me@you2.com\",\n \"source\":\"local\"\n },\n \"outcome\": {\n \"outcome_id\": 1\n }\n}"},"url":"{{external_api_host}}/v1/contact-notes","description":"

Create a contact note.

Required Attributes:

title
note
type_id

Required Relationships:

contact

\n","urlObject":{"path":["v1","contact-notes"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"025151c5-99d6-4e2f-a712-9f5447bd04dd","name":"Create Contact Note (as User)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"My Title\",\n \"note\": \"My Note Content:
It includes linebreaks ^superscripts, _subscripts, and even italicized text!!\",\n \"type_id\": 1,\n \"contact\": {\n \"first_name\":\"Clark\",\n \"last_name\":\"Gable2\",\n \"email\":\"me@you2.com\",\n \"source\":\"local\"\n }\n}"},"url":"{{external_api_host}}/v1/contact-notes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"created\": \"{external_api_host}/v1/contact-notes/14\",\n \"id\": 14\n}"},{"id":"b641c8df-bb11-4bd2-99e7-3a80a983b1dd","name":"Contact not found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"My Title\",\n \"note\": \"My Note Content:
It includes linebreaks ^superscripts, _subscripts, and even italicized text!!\",\n \"type_id\": 1,\n \"contact\": {\n \"first_name\":\"Clark\",\n \"last_name\":\"Gable2\",\n \"email\":\"me@you2.com\",\n \"source\":\"local\"\n }\n}"},"url":"{{external_api_host}}/v1/contact-notes"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Unable to find target for relationship: 'contact'\"\n}"}],"_postman_id":"a1283d5c-4f32-f5e7-5f5a-003dab781a32"},{"name":"Create Contact Note (as Admin)","event":[{"listen":"test","script":{"id":"c40919d0-37fe-4f22-b582-8e82ee9e473e","type":"text/javascript","exec":[""]}}],"id":"d59406dd-74cb-edaf-93b7-c5909a60e0da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"My Title\",\n \"note\": \"My Note Content:
It includes linebreaks ^superscripts, _subscripts, and even italicized text!!\",\n \"type_id\": 1,\n \"contact\": {\n \"first_name\":\"Clark\",\n \"last_name\":\"Gable\",\n \"email\":\"me@you2.com\",\n \"source\":\"local\"\n },\n \"owner\": {\n \"username\":\"ted\"\n },\n \"outcome\": {\n \"outcome_id\": 1\n }\n}"},"url":"{{external_api_host}}/v1/contact-notes","description":"

Create a contact note.

Required Attributes:

title
note
type_id

Required Relationships:

contact
owner

\n","urlObject":{"path":["v1","contact-notes"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"8262f4ce-4abc-4ed1-ad91-65280482f7b7","name":"Create Contact Note (as Admin)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"My Title\",\n \"note\": \"My Note Content:
It includes linebreaks ^superscripts, _subscripts, and even italicized text!!\",\n \"type_id\": 1,\n \"contact\": {\n \"first_name\":\"Clark\",\n \"last_name\":\"Gable\",\n \"email\":\"me@you2.com\",\n \"source\":\"local\"\n },\n \"owner\": {\n \"username\":\"ted\"\n }\n}"},"url":"{{external_api_host}}/v1/contact-notes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"created\": \"{external_api_host}/v1/contact-notes/14\",\n \"id\": 14\n}"}],"_postman_id":"d59406dd-74cb-edaf-93b7-c5909a60e0da"},{"name":"Update Contact Note","id":"3dca2409-614d-1fa8-3a12-27448ce52f93","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"My Title2\",\n \"note\": \"My Note Content2\",\n \"type_id\": 2,\n \"contact\": {\n \"first_name\":\"Clark\",\n \"last_name\":\"Gable\",\n \"email\":\"me@you.com\",\n \"source\":\"local\"\n }\n}"},"url":"{{external_api_host}}/v1/contact-notes/{{contact_note_id}}","description":"

Update an existing contact note by ID.

\n","urlObject":{"path":["v1","contact-notes","{{contact_note_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"baa4cc3a-6c8f-4c20-a364-4f11ce34c30b","name":"Update Contact Note","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"My Title2\",\n \"note\": \"My Note Content2\",\n \"type_id\": 2,\n \"contact\": {\n \"first_name\":\"Clark\",\n \"last_name\":\"Gable\",\n \"email\":\"me@you.com\",\n \"source\":\"local\"\n }\n}"},"url":"{{external_api_host}}/v1/contact-notes/{{contact_note_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"3dca2409-614d-1fa8-3a12-27448ce52f93"},{"name":"Delete Contact Note","id":"494f6648-0e49-ec35-5b3c-17592158364a","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{external_api_host}}/v1/contact-notes/{{contact_note_id}}","description":"

Deletes a contact note by ID.

\n","urlObject":{"path":["v1","contact-notes","{{contact_note_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"04f0fa85-e5c0-4874-a74f-3f3e68a65485","name":"Delete Contact Note","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{external_api_host}}/v1/contact-notes/{{contact_note_id}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"494f6648-0e49-ec35-5b3c-17592158364a"}],"id":"656ac0e1-0469-f286-8999-732020655417","description":"

Endpoints for interacting with the contact notes resource.

Before creating a contact note, the contact must exist and be owned by the user specified before being created.

If including contact information when creating the note, the contact information must match exactly.
\n
Contact information cannot be created or edited through Contact Note endpoints.
\n
Delay sending your contact note POST until after you have received a successful create contact response if you are creating a contact note upon initial submission of a new contact.
\n
Deduplication does not apply. Existing Contact Note cannot be edited through the Create (POST) endpoint. Update (PATCH) endpoint must be used to edit any existing notes and the contact_note_id must be passed.
\n

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	numeric	Generated identifier for contact group.
title	Yes	string	Note title.
note	Yes	string	The content of the note. May contain HTML formatting.
type_id	Yes	numeric	A type ID. See table below for details.

Uniqueness

Notes are not uniquely identifiable except by TE id. Deduplication does not apply.

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
contact	Yes	Contact	See contact documentation for uniqueness options.	Contact for this note. One to many relationship, so returned as an object.
owner	Yes*	User	username, id, external_id, email	Owning user of the contact note. One to many relationship, so returned as an object. *Only assignable/visible if authenticated as an organization admin.

Special POST/PATCH relationships

These relationships are used to manipulate the contact/note but are neither note attributes nor bona fide relationships. These attributes will not appear in responses.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Settable Fields	Description
outcome	Outcome	outcome_id	Outcome for contact set by this note. Can trigger journeys depending on journey configuration.

Type IDs

ID	Note Type
1	General Note
2	Task
3	Email Opened
4	Email Sent
5	Prequalification
6	Message Received
7	Contacted
8	Welcome Email Sent
9	SMS Sent
10	SMS Received
11	Email Delivered
12	Email Unsubscribed
13	Email Delivery Failure
14	Email Link Clicked
15	Print Material Sent
16	Open House Registration
17	Event Registration
18	Contact Assigned
19	Contact Passed
20	Contact Shared
21	Drip Campaign Ended
22	Spam Complaint
23	Drip Campaign Added
24	Contact Accepted
25	Appointment Scheduled
26	Transaction Scheduled
27	Drip Campaign Deleted
28	Listing Alert Sent
29	Drip Campaign Email Sent
30	Connection Invite Sent
31	Auto Campaign Email Sent
32	Movement Registration
33	Auto Campaign Print Order Sent
34	Task Complete Email Sent

Filtering

Use the 'filter=attribute_name=x,attribute_name_2=y' query to return the list of contact notes that meet the filter criteria. For example, to filter contact notes created between Oct. 14, 2017 17:41:01 (UTC) and Oct. 15, 2017 17:41:09 (UTC), the following query could be used:

/contact-notes?filter=created_on_start=2017-10-14T17:41:01Z,created_on_end=2017-10-15T17:41:09Z

The supported filter attributes are shown in the following table.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
created_on_start	ISO-8601 formatted date. The start of the time range of interest, inclusive.
created_on_end	ISO-8601 formatted date. The end of the time range of interest, inclusive.
title	Note title.
notes	The content of the note.
is_private	Indicator if notes are private
type_id	A numeric type ID for contact note.
title_contains	Title of contact notes contains
notes_contains	Contents of the note contains.

","event":[{"listen":"prerequest","script":{"id":"42be8e21-a437-4dc4-9440-f35343e20acc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ad58f764-6e88-4c4e-8e3e-1eba0a1a7bcc","type":"text/javascript","exec":[""]}}],"_postman_id":"656ac0e1-0469-f286-8999-732020655417"},{"name":"Contact Recruiting Endpoints","item":[{"name":"Contacts - Recruits","item":[{"name":"Fetch Contact Recruit","id":"39166f9c-ca18-4713-8d12-0801f446189a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/contact-recruits/{{contact_id}}","description":"

Fetch a specific contact specified by ID.

\n","urlObject":{"path":["v1","contact-recruits","{{contact_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"d2d84d0e-38b0-4a1c-99b8-9d9d8c3ac529","name":"Fetch Contact Recruit","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/contact-recruits/{{contact_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"address\": \"1234 Bermuda St\",\n \"address_2\": \"Apt. 3\",\n \"birthday\": \"1900-01-01\",\n \"city\": \"Pleasantville\",\n \"classification\": \"\",\n \"close_date\": null,\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"credit_score\": null,\n \"credit_score_date\": null,\n \"credit_score_expiration_date\": null,\n \"email\": \"jlsmith@example.com\",\n \"email_work\": \"jlsmith@otherlender.com\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 5\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_license_number\": null,\n \"employer_name\": \"Other Lender LLC\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"external_id\": \"101010\",\n \"fax\": null,\n \"first_name\": \"Jane\",\n \"id\": 520,\n \"internal_created_at\": \"2019-03-21 18:10:48\",\n \"internal_updated_at\": \"2019-03-21 18:10:48\",\n \"last_contacted_date\": \"2017-01-01 12:12:12\",\n \"last_modified_date\": null,\n \"last_name\": \"Smith\",\n \"license_number\": \"Q10101010101011\",\n \"linkedin_url\": null,\n \"list_date\": null,\n \"nickname\": null,\n \"ok_to_call\": false,\n \"ok_to_email\": false,\n \"ok_to_mail\": false,\n \"other_url\": null,\n \"phone_cell\": \"(763)555-0123\",\n \"phone_home\": \"(612)-555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"pre_approval_issued_date\": null,\n \"referred_by\": \"\",\n \"referred_to\": \"\",\n \"source\": \"Recruit Intake System\",\n \"state\": \"MN\",\n \"suffix\": null,\n \"title\": \"Ms.\",\n \"website_url\": null,\n \"zip_code\": \"12345\",\n \"contact_groups\": [\n {\n \"group_name\": \"Recruit - Hot\",\n \"id\": 15\n }\n ],\n \"external_ids\": [\n {\n \"external_id\": \"abcd\",\n \"source\": \"Other Recruit Intake System\"\n },\n {\n \"external_id\": \"101010\",\n \"source\": \"Recruit Intake System\"\n }\n ],\n \"external_status\": {\n \"status_name\": \"Processing\"\n },\n \"owner\": {\n \"email\": \"john@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 57,\n \"username\": \"john-example\"\n },\n \"preferences\": {\n \"is_silenced\": true\n },\n \"recruit_info\": {\n \"background\": \"Jane started as a loan officer...\",\n \"commission_cap\": \"26002\",\n \"commission_split\": \"50%\",\n \"corporate_objective\": \"1\",\n \"has_resume\": true,\n \"nmls_id\": \"NMLS identifier\",\n \"resume_url\": \"http:/jlsmith.lender.com/resume\",\n \"sourced_percentage\": \"10\",\n \"ust_is_complete\": true,\n \"years_experience\": \"6\",\n \"branch_manager\": {\n \"email\": \"glen@lender.com\",\n \"external_id\": \"\",\n \"id\": 53,\n \"username\": \"glen-lender\"\n },\n \"division_manager\": {\n \"email\": \"suzy@lender.com\",\n \"external_id\": \"\",\n \"id\": 53,\n \"username\": \"suzy-lender\"\n },\n \"recruit_status\": {\n \"status_name\": \"Active\"\n },\n \"regional_manager\": {\n \"email\": \"richard@lender.com\",\n \"external_id\": \"\",\n \"id\": 53,\n \"username\": \"richard-lender\"\n }\n },\n \"recruit_metrics\": [\n {\n \"on_date\": null,\n \"value\": \"30\",\n \"metric\": {\n \"metric_name\": \"Builders\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n }\n },\n {\n \"on_date\": null,\n \"value\": \"40\",\n \"metric\": {\n \"metric_name\": \"Realtors\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n }\n },\n {\n \"on_date\": \"2018-01-01 00:00:00\",\n \"value\": \"10123\",\n \"metric\": {\n \"metric_name\": \"Sales Production\",\n \"metric_type\": \"sales_production\"\n },\n \"unit\": {\n \"unit_name\": \"dollars\"\n }\n }\n ],\n \"state_licenses\": [\n {\n \"state_name\": \"MN\"\n },\n {\n \"state_name\": \"KS\"\n }\n ]\n}"}],"_postman_id":"39166f9c-ca18-4713-8d12-0801f446189a"},{"name":"Fetch Contact Recruits","id":"f031ec5a-5ff1-45cc-8d48-00ca55414033","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/contact-recruits?page[number]=1&page[size]=10","description":"

Fetch a page of contacts. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","contact-recruits"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[{"id":"e601dddd-cbff-410f-8bc0-54834814367a","name":"Fetch Contact Recruits","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"{{external_api_host}}/v1/contact-recruits?page[number]=1&page[size]=10","host":["{{external_api_host}}"],"path":["v1","contact-recruits"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"address\": \"1234 Bermuda St\",\n \"address_2\": \"Apt. 3\",\n \"birthday\": \"1900-01-01\",\n \"city\": \"Pleasantville\",\n \"classification\": \"\",\n \"close_date\": null,\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"credit_score\": null,\n \"credit_score_date\": null,\n \"credit_score_expiration_date\": null,\n \"email\": \"jlsmith@example.com\",\n \"email_work\": \"jlsmith@otherlender.com\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 5\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_license_number\": null,\n \"employer_name\": \"Other Lender LLC\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"external_id\": \"101010\",\n \"fax\": null,\n \"first_name\": \"Jane\",\n \"id\": 520,\n \"internal_created_at\": \"2019-03-21 18:10:48\",\n \"internal_updated_at\": \"2019-03-21 18:10:48\",\n \"last_contacted_date\": \"2017-01-01 12:12:12\",\n \"last_modified_date\": null,\n \"last_name\": \"Smith\",\n \"license_number\": \"Q10101010101011\",\n \"linkedin_url\": null,\n \"list_date\": null,\n \"nickname\": null,\n \"ok_to_call\": false,\n \"ok_to_email\": false,\n \"ok_to_mail\": false,\n \"other_url\": null,\n \"phone_cell\": \"(763)555-0123\",\n \"phone_home\": \"(612)-555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"pre_approval_issued_date\": null,\n \"referred_by\": \"\",\n \"referred_to\": \"\",\n \"source\": \"Recruit Intake System\",\n \"state\": \"MN\",\n \"suffix\": null,\n \"title\": \"Ms.\",\n \"website_url\": null,\n \"zip_code\": \"12345\",\n \"contact_groups\": [\n {\n \"group_name\": \"Recruit - Hot\",\n \"id\": 15\n }\n ],\n \"external_ids\": [\n {\n \"external_id\": \"abcd\",\n \"source\": \"Other Recruit Intake System\"\n },\n {\n \"external_id\": \"101010\",\n \"source\": \"Recruit Intake System\"\n }\n ],\n \"external_status\": {\n \"status_name\": \"Processing\"\n },\n \"owner\": {\n \"email\": \"john@example.com\",\n \"external_id\": \"userExternal1\",\n \"id\": 57,\n \"username\": \"john-example\"\n },\n \"preferences\": {\n \"is_silenced\": true\n },\n \"recruit_info\": {\n \"background\": \"Jane started as a loan officer...\",\n \"commission_cap\": \"26002\",\n \"commission_split\": \"50%\",\n \"corporate_objective\": \"1\",\n \"has_resume\": true,\n \"nmls_id\": \"NMLS identifier\",\n \"resume_url\": \"http:/jlsmith.lender.com/resume\",\n \"sourced_percentage\": \"10\",\n \"ust_is_complete\": true,\n \"years_experience\": \"6\",\n \"branch_manager\": {\n \"email\": \"glen@lender.com\",\n \"external_id\": \"\",\n \"id\": 53,\n \"username\": \"glen-lender\"\n },\n \"division_manager\": {\n \"email\": \"suzy@lender.com\",\n \"external_id\": \"\",\n \"id\": 53,\n \"username\": \"suzy-lender\"\n },\n \"recruit_status\": {\n \"status_name\": \"Active\"\n },\n \"regional_manager\": {\n \"email\": \"richard@lender.com\",\n \"external_id\": \"\",\n \"id\": 53,\n \"username\": \"richard-lender\"\n }\n },\n \"recruit_metrics\": [\n {\n \"on_date\": null,\n \"value\": \"30\",\n \"metric\": {\n \"metric_name\": \"Builders\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n }\n },\n {\n \"on_date\": null,\n \"value\": \"40\",\n \"metric\": {\n \"metric_name\": \"Realtors\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n }\n },\n {\n \"on_date\": \"2018-01-01 00:00:00\",\n \"value\": \"10123\",\n \"metric\": {\n \"metric_name\": \"Sales Production\",\n \"metric_type\": \"sales_production\"\n },\n \"unit\": {\n \"unit_name\": \"dollars\"\n }\n }\n ],\n \"state_licenses\": [\n {\n \"state_name\": \"MN\"\n },\n {\n \"state_name\": \"KS\"\n }\n ]\n }\n ],\n \"links\": {\n \"first\": 1,\n \"last\": 1,\n \"next\": null,\n \"prev\": null\n }\n}"}],"_postman_id":"f031ec5a-5ff1-45cc-8d48-00ca55414033"},{"name":"Create Contact Recruit (as Admin)","event":[{"listen":"test","script":{"id":"ee67e6dc-d2ae-469b-8476-c761da1dfe9f","exec":[""],"type":"text/javascript"}}],"id":"54035e57-9229-4d28-9237-994aa16a9366","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"email\": \"jlsmith@example.com\",\n \"email_work\": \"jlsmith@otherlender.com\",\n \"address\": \"1234 Bermuda St\",\n \"address_2\": \"Apt. 3\",\n \"city\": \"Pleasantville\",\n \"state\": \"MN\",\n \"zip_code\": \"12345\",\n \"phone_cell\": \"(763)555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"phone_home\": \"(612)-555-0123\",\n \"employer_name\": \"Other Lender LLC\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 5\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"license_number\": \"Q10101010101011\",\n \"source\": \"Recruit Intake System\",\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"last_contacted_date\": \"2017-01-01 12:12:12\",\n \"external_id\": \"101010\",\n \"birthday\": \"1970-01-01\",\n \"ok_to_mail\": 0,\n \"ok_to_email\": 0,\n \"ok_to_call\": 0,\n \"preferences\": {\n \"is_silenced\": true\n },\n \"owner\": {\n \"external_id\": \"userExternal1\"\n },\n \"contact_groups\": [\n {\n \"group_name\": \"Recruit - Hot\"\n }\n ],\n \"external_ids\": [\n {\n \"source\": \"Recruit Intake System\",\n \"external_id\": \"101010\"\n },\n {\n \"source\": \"Other Recruit Intake System\",\n \"external_id\": \"abcd\"\n }\n ],\n \"external_status\": {\n \"status_name\": \"Processing\"\n },\n \"recruit_info\": {\n \"nmls_id\": \"NMLS identifier\",\n \"regional_manager\": {\n \"username\": \"glen-lender\"\n },\n \"division_manager\": {\n \"username\": \"suzy-lender\"\n },\n \"branch_manager\": {\n \"username\": \"richard-lender\"\n },\n \"recruit_status\": {\n \"status_name\": \"Active\"\n },\n \"corporate_objective\": \"2306\",\n \"sourced_percentage\": \"10\",\n \"commission_cap\": \"26002\",\n \"commission_split\": \"50%\",\n \"ust_is_complete\": true,\n \"background\": \"Jane started as a loan officer...\",\n \"years_experience\": 6,\n \"has_resume\":true,\n \"resume_url\":\"http:/jlsmith.lender.com/resume\"\n },\n \"state_licenses\": [\n {\n \"state_name\": \"minnesota\"\n },\n {\n \"state_name\": \"KS\"\n }\n ],\n \"recruit_metrics\": [\n {\n \"metric\": {\n \"metric_name\": \"Builders\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"30\"\n },\n {\n \"metric\": {\n \"metric_name\": \"Realtors\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"40\"\n },\n\t {\n \t\t\"metric\": {\n \t\t\t\"metric_name\": \"Sales Production\",\n \t\t\t\"metric_type\": \"sales_production\"\n \t\t},\n \t\t\"unit\": {\n \t\t\t\"unit_name\": \"dollars\"\n \t\t},\n \t\t\"value\": \"10123\",\n \t\t\"on_date\": \"2018\"\n \t}\n ]\n}"},"url":"{{external_api_host}}/v1/contact-recruits","description":"

Create a contact.

Required Attributes (one of the following combinations):

source, first_name, last_name, email
source, first_name, last_name, phone_cell
source, first_name, last_name, phone_home
source, first_name, last_name, phone_office
source, first_name, last_name, address, city, state, zip_code

Required Relationships:

owner*

*required if authenticated as an organization admin

\n","urlObject":{"path":["v1","contact-recruits"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"d5b5beee-ef18-4743-a4a1-3bf2af4482ff","name":"Create Contact Recruit (as Admin)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"email\": \"jlsmith@example.com\",\n \"email_work\": \"jlsmith@otherlender.com\",\n \"address\": \"1234 Bermuda St\",\n \"address_2\": \"Apt. 3\",\n \"city\": \"Pleasantville\",\n \"state\": \"MN\",\n \"zip_code\": \"12345\",\n \"phone_cell\": \"(763)555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"phone_home\": \"(612)-555-0123\",\n \"employer_name\": \"Other Lender LLC\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 5\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"license_number\": \"Q10101010101011\",\n \"source\": \"Recruit Intake System\",\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"last_contacted_date\": \"2017-01-01 12:12:12\",\n \"external_id\": \"101010\",\n \"birthday\": \"1970-01-01\",\n \"ok_to_mail\": 0,\n \"ok_to_email\": 0,\n \"ok_to_call\": 0,\n \"preferences\": {\n \"is_silenced\": true\n },\n \"owner\": {\n \"external_id\": \"userExternal1\"\n },\n \"contact_groups\": [\n {\n \"group_name\": \"Recruit - Hot\"\n }\n ],\n \"external_ids\": [\n {\n \"source\": \"Recruit Intake System\",\n \"external_id\": \"101010\"\n },\n {\n \"source\": \"Other Recruit Intake System\",\n \"external_id\": \"abcd\"\n }\n ],\n \"external_status\": {\n \"status_name\": \"Processing\"\n },\n \"recruit_info\": {\n \"nmls_number\": \"NMLS identifier\",\n \"regional_manager\": {\n \"username\": \"glen-lender\"\n },\n \"division_manager\": {\n \"username\": \"suzy-lender\"\n },\n \"branch_manager\": {\n \"username\": \"richard-lender\"\n },\n \"recruit_status\": {\n \"status_name\": \"Active\"\n },\n \"corporate_objective\": \"2306\",\n \"sourced_percentage\": \"10\",\n \"commission_cap\": \"26002\",\n \"commission_split\": \"50%\",\n \"ust_is_complete\": true,\n \"background\": \"Jane started as a loan officer...\",\n \"years_experience\": 6,\n \"has_resume\":true,\n \"resume_url\":\"http:/jlsmith.lender.com/resume\"\n },\n \"state_licenses\": [\n {\n \"state_name\": \"minnesota\"\n },\n {\n \"state_name\": \"KS\"\n }\n ],\n \"recruit_metrics\": [\n {\n \"metric\": {\n \"metric_name\": \"Builders\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"30\"\n },\n {\n \"metric\": {\n \"metric_name\": \"Realtors\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"40\"\n },\n\t {\n \t\t\"metric\": {\n \t\t\t\"metric_name\": \"Sales Production\",\n \t\t\t\"metric_type\": \"sales_production\"\n \t\t},\n \t\t\"unit\": {\n \t\t\t\"unit_name\": \"dollars\"\n \t\t},\n \t\t\"value\": \"10123\",\n \t\t\"on_date\": \"2018\"\n \t}\n ]\n}"},"url":"{{external_api_host}}/v1/contact-recruits"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"created\": \"external-api.totaldev.us/v1/contact-recruits/520\",\n \"id\": 520\n}"},{"id":"409f9054-9a9d-4583-bdd4-7f407974fb12","name":"Insufficient Scope","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"email\": \"jlsmith@example.com\",\n \"email_work\": \"jlsmith@otherlender.com\",\n \"address\": \"1234 Bermuda St\",\n \"address_2\": \"Apt. 3\",\n \"city\": \"Pleasantville\",\n \"state\": \"MN\",\n \"zip_code\": \"12345\",\n \"phone_cell\": \"(763)555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"phone_home\": \"(612)-555-0123\",\n \"employer_name\": \"Other Lender LLC\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 5\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"license_number\": \"Q10101010101011\",\n \"source\": \"Recruit Intake System\",\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"last_contacted_date\": \"2017-01-01 12:12:12\",\n \"external_id\": \"101010\",\n \"birthday\": \"1970-01-01\",\n \"ok_to_mail\": 0,\n \"ok_to_email\": 0,\n \"ok_to_call\": 0,\n \"preferences\": {\n \"is_silenced\": true\n },\n \"owner\": {\n \"external_id\": \"userExternal1\"\n },\n \"contact_groups\": [\n {\n \"group_name\": \"Recruit - Hot\"\n }\n ],\n \"external_ids\": [\n {\n \"source\": \"Recruit Intake System\",\n \"external_id\": \"101010\"\n },\n {\n \"source\": \"Other Recruit Intake System\",\n \"external_id\": \"abcd\"\n }\n ],\n \"external_status\": {\n \"status_name\": \"Processing\"\n },\n \"recruit_info\": {\n \"nmls_number\": \"NMLS identifier\",\n \"regional_manager\": {\n \"username\": \"glen-lender\"\n },\n \"division_manager\": {\n \"username\": \"suzy-lender\"\n },\n \"branch_manager\": {\n \"username\": \"richard-lender\"\n },\n \"recruit_status\": {\n \"status_name\": \"Active\"\n },\n \"corporate_objective\": \"2306\",\n \"sourced_percentage\": \"10\",\n \"commission_cap\": \"26002\",\n \"commission_split\": \"50%\",\n \"ust_is_complete\": true,\n \"background\": \"Jane started as a loan officer...\",\n \"years_experience\": 6,\n \"has_resume\":true,\n \"resume_url\":\"http:/jlsmith.lender.com/resume\"\n },\n \"state_licenses\": [\n {\n \"state_name\": \"minnesota\"\n },\n {\n \"state_name\": \"KS\"\n }\n ],\n \"recruit_metrics\": [\n {\n \"metric\": {\n \"metric_name\": \"Builders\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"30\"\n },\n {\n \"metric\": {\n \"metric_name\": \"Realtors\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"40\"\n },\n\t {\n \t\t\"metric\": {\n \t\t\t\"metric_name\": \"Sales Production\",\n \t\t\t\"metric_type\": \"sales_production\"\n \t\t},\n \t\t\"unit\": {\n \t\t\t\"unit_name\": \"dollars\"\n \t\t},\n \t\t\"value\": \"10123\",\n \t\t\"on_date\": \"2018\"\n \t}\n ]\n}"},"url":"{{external_api_host}}/v1/contact-recruits"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": \"insufficient_scope\",\n \"error_description\": \"The request requires higher privileges than provided by the access token\"\n}"},{"id":"15cf5a2c-a86a-4c6c-ac9c-2f7ee3978b25","name":"Update Contact Recruit (as Admin)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"email\": \"jlsmith@example.com\",\n \"email_work\": \"jlsmith@otherlender.com\",\n \"address\": \"1234 Bermuda St\",\n \"address_2\": \"Apt. 3\",\n \"city\": \"Pleasantville\",\n \"state\": \"MN\",\n \"zip_code\": \"12345\",\n \"phone_cell\": \"(763)555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"phone_home\": \"(612)-555-0123\",\n \"employer_name\": \"Other Lender LLC\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 5\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"license_number\": \"Q10101010101011\",\n \"source\": \"Recruit Intake System\",\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"last_contacted_date\": \"2017-01-01 12:12:12\",\n \"external_id\": \"101010\",\n \"birthday\": \"1970-01-01\",\n \"ok_to_mail\": 0,\n \"ok_to_email\": 0,\n \"ok_to_call\": 0,\n \"preferences\": {\n \"is_silenced\": true\n },\n \"owner\": {\n \"external_id\": \"userExternal1\"\n },\n \"contact_groups\": [\n {\n \"group_name\": \"Recruit - Hot\"\n }\n ],\n \"external_ids\": [\n {\n \"source\": \"Recruit Intake System\",\n \"external_id\": \"101010\"\n },\n {\n \"source\": \"Other Recruit Intake System\",\n \"external_id\": \"abcd\"\n }\n ],\n \"external_status\": {\n \"status_name\": \"Processing\"\n },\n \"recruit_info\": {\n \"nmls_number\": \"NMLS identifier\",\n \"regional_manager\": {\n \"username\": \"glen-lender\"\n },\n \"division_manager\": {\n \"username\": \"suzy-lender\"\n },\n \"branch_manager\": {\n \"username\": \"richard-lender\"\n },\n \"recruit_status\": {\n \"status_name\": \"Active\"\n },\n \"corporate_objective\": \"2306\",\n \"sourced_percentage\": \"10\",\n \"commission_cap\": \"26002\",\n \"commission_split\": \"50%\",\n \"ust_is_complete\": true,\n \"background\": \"Jane started as a loan officer...\",\n \"years_experience\": 6,\n \"has_resume\":true,\n \"resume_url\":\"http:/jlsmith.lender.com/resume\"\n },\n \"state_licenses\": [\n {\n \"state_name\": \"minnesota\"\n },\n {\n \"state_name\": \"KS\"\n }\n ],\n \"recruit_metrics\": [\n {\n \"metric\": {\n \"metric_name\": \"Builders\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"30\"\n },\n {\n \"metric\": {\n \"metric_name\": \"Realtors\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"40\"\n },\n\t {\n \t\t\"metric\": {\n \t\t\t\"metric_name\": \"Sales Production\",\n \t\t\t\"metric_type\": \"sales_production\"\n \t\t},\n \t\t\"unit\": {\n \t\t\t\"unit_name\": \"dollars\"\n \t\t},\n \t\t\"value\": \"10123\",\n \t\t\"on_date\": \"2018\"\n \t}\n ]\n}"},"url":"{{external_api_host}}/v1/contact-recruits"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"duplicate\": \"external-api.totaldev.us/v1/contact-recruits/520\",\n \"id\": 520\n}"}],"_postman_id":"54035e57-9229-4d28-9237-994aa16a9366"},{"name":"Create Contact Recruit (as User)","event":[{"listen":"test","script":{"id":"ee67e6dc-d2ae-469b-8476-c761da1dfe9f","exec":[""],"type":"text/javascript"}}],"id":"02570879-9ea4-49f9-886e-5220e46911e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"email\": \"jlsmith@example.com\",\n \"email_work\": \"jlsmith@otherlender.com\",\n \"address\": \"1234 Bermuda St\",\n \"address_2\": \"Apt. 3\",\n \"city\": \"Pleasantville\",\n \"state\": \"MN\",\n \"zip_code\": \"12345\",\n \"phone_cell\": \"(763)555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"phone_home\": \"(612)-555-0123\",\n \"employer_name\": \"Other Lender LLC\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 5\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"license_number\": \"Q10101010101011\",\n \"source\": \"Recruit Intake System\",\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"last_contacted_date\": \"2017-01-01 12:12:12\",\n \"external_id\": \"101010\",\n \"birthday\": \"1970-01-01\",\n \"ok_to_mail\": 0,\n \"ok_to_email\": 0,\n \"ok_to_call\": 0,\n \"preferences\": {\n \"is_silenced\": true\n },\n \"contact_groups\": [\n {\n \"group_name\": \"Recruit - Hot\"\n }\n ],\n \"external_ids\": [\n {\n \"source\": \"Recruit Intake System\",\n \"external_id\": \"101010\"\n },\n {\n \"source\": \"Other Recruit Intake System\",\n \"external_id\": \"abcd\"\n }\n ],\n \"external_status\": {\n \"status_name\": \"Processing\"\n },\n \"recruit_info\": {\n \"nmls_id\": \"NMLS identifier\",\n \"regional_manager\": {\n \"username\": \"glen-lender\"\n },\n \"division_manager\": {\n \"username\": \"suzy-lender\"\n },\n \"branch_manager\": {\n \"username\": \"richard-lender\"\n },\n \"recruit_status\": {\n \"status_name\": \"Active\"\n },\n \"corporate_objective\": \"2306\",\n \"sourced_percentage\": \"10\",\n \"commission_cap\": \"26002\",\n \"commission_split\": \"50%\",\n \"ust_is_complete\": true,\n \"background\": \"Jane started as a loan officer...\",\n \"years_experience\": 6,\n \"has_resume\":true,\n \"resume_url\":\"http:/jlsmith.lender.com/resume\"\n },\n \"state_licenses\": [\n {\n \"state_name\": \"minnesota\"\n },\n {\n \"state_name\": \"KS\"\n }\n ],\n \"recruit_metrics\": [\n {\n \"metric\": {\n \"metric_name\": \"Builders\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"30\"\n },\n {\n \"metric\": {\n \"metric_name\": \"Realtors\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"40\"\n },\n\t {\n \t\t\"metric\": {\n \t\t\t\"metric_name\": \"Sales Production\",\n \t\t\t\"metric_type\": \"sales_production\"\n \t\t},\n \t\t\"unit\": {\n \t\t\t\"unit_name\": \"dollars\"\n \t\t},\n \t\t\"value\": \"10123\",\n \t\t\"on_date\": \"2018\"\n \t}\n ]\n}"},"url":"{{external_api_host}}/v1/contact-recruits","description":"

Create a contact.

Required Attributes (one of the following combinations):

source, first_name, last_name, email
source, first_name, last_name, phone_cell
source, first_name, last_name, phone_home
source, first_name, last_name, phone_office
source, first_name, last_name, address, city, state, zip_code

Required Relationships:

[none]

\n","urlObject":{"path":["v1","contact-recruits"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"46c99bd7-7e7f-4cea-9f7c-3bb0a5b28acc","name":"Update Contact Recruit (as User)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"email\": \"jlsmith@example.com\",\n \"email_work\": \"jlsmith@otherlender.com\",\n \"address\": \"1234 Bermuda St\",\n \"address_2\": \"Apt. 3\",\n \"city\": \"Pleasantville\",\n \"state\": \"MN\",\n \"zip_code\": \"12345\",\n \"phone_cell\": \"(763)555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"phone_home\": \"(612)-555-0123\",\n \"employer_name\": \"Other Lender LLC\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 5\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"license_number\": \"Q10101010101011\",\n \"source\": \"Recruit Intake System\",\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"last_contacted_date\": \"2017-01-01 12:12:12\",\n \"external_id\": \"101010\",\n \"birthday\": \"1970-01-01\",\n \"ok_to_mail\": 0,\n \"ok_to_email\": 0,\n \"ok_to_call\": 0,\n \"preferences\": {\n \"is_silenced\": true\n },\n \"contact_groups\": [\n {\n \"group_name\": \"Recruit - Hot\"\n }\n ],\n \"external_ids\": [\n {\n \"source\": \"Recruit Intake System\",\n \"external_id\": \"101010\"\n },\n {\n \"source\": \"Other Recruit Intake System\",\n \"external_id\": \"abcd\"\n }\n ],\n \"external_status\": {\n \"status_name\": \"Processing\"\n },\n \"recruit_info\": {\n \"nmls_number\": \"NMLS identifier\",\n \"regional_manager\": {\n \"username\": \"glen-lender\"\n },\n \"division_manager\": {\n \"username\": \"suzy-lender\"\n },\n \"branch_manager\": {\n \"username\": \"richard-lender\"\n },\n \"recruit_status\": {\n \"status_name\": \"Active\"\n },\n \"corporate_objective\": \"2306\",\n \"sourced_percentage\": \"10\",\n \"commission_cap\": \"26002\",\n \"commission_split\": \"50%\",\n \"ust_is_complete\": true,\n \"background\": \"Jane started as a loan officer...\",\n \"years_experience\": 6,\n \"has_resume\":true,\n \"resume_url\":\"http:/jlsmith.lender.com/resume\"\n },\n \"state_licenses\": [\n {\n \"state_name\": \"minnesota\"\n },\n {\n \"state_name\": \"KS\"\n }\n ],\n \"recruit_metrics\": [\n {\n \"metric\": {\n \"metric_name\": \"Builders\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"30\"\n },\n {\n \"metric\": {\n \"metric_name\": \"Realtors\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"40\"\n },\n\t {\n \t\t\"metric\": {\n \t\t\t\"metric_name\": \"Sales Production\",\n \t\t\t\"metric_type\": \"sales_production\"\n \t\t},\n \t\t\"unit\": {\n \t\t\t\"unit_name\": \"dollars\"\n \t\t},\n \t\t\"value\": \"10123\",\n \t\t\"on_date\": \"2018\"\n \t}\n ]\n}"},"url":"{{external_api_host}}/v1/contact-recruits"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"duplicate\": \"external-api.totaldev.us/v1/contact-recruits/520\",\n \"id\": 520\n}"},{"id":"23ad4e1b-a21b-416a-b93c-7e6817951200","name":"Create Contact Recruit (as User)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"email\": \"jlsmith@example.com\",\n \"email_work\": \"jlsmith@otherlender.com\",\n \"address\": \"1234 Bermuda St\",\n \"address_2\": \"Apt. 3\",\n \"city\": \"Pleasantville\",\n \"state\": \"MN\",\n \"zip_code\": \"12345\",\n \"phone_cell\": \"(763)555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"phone_home\": \"(612)-555-0123\",\n \"employer_name\": \"Other Lender LLC\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 5\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"license_number\": \"Q10101010101011\",\n \"source\": \"Recruit Intake System\",\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"last_contacted_date\": \"2017-01-01 12:12:12\",\n \"external_id\": \"101010\",\n \"birthday\": \"1970-01-01\",\n \"ok_to_mail\": 0,\n \"ok_to_email\": 0,\n \"ok_to_call\": 0,\n \"preferences\": {\n \"is_silenced\": true\n },\n \"contact_groups\": [\n {\n \"group_name\": \"Recruit - Hot\"\n }\n ],\n \"external_ids\": [\n {\n \"source\": \"Recruit Intake System\",\n \"external_id\": \"101010\"\n },\n {\n \"source\": \"Other Recruit Intake System\",\n \"external_id\": \"abcd\"\n }\n ],\n \"external_status\": {\n \"status_name\": \"Processing\"\n },\n \"recruit_info\": {\n \"nmls_number\": \"NMLS identifier\",\n \"regional_manager\": {\n \"username\": \"glen-lender\"\n },\n \"division_manager\": {\n \"username\": \"suzy-lender\"\n },\n \"branch_manager\": {\n \"username\": \"richard-lender\"\n },\n \"recruit_status\": {\n \"status_name\": \"Active\"\n },\n \"corporate_objective\": \"2306\",\n \"sourced_percentage\": \"10\",\n \"commission_cap\": \"26002\",\n \"commission_split\": \"50%\",\n \"ust_is_complete\": true,\n \"background\": \"Jane started as a loan officer...\",\n \"years_experience\": 6,\n \"has_resume\":true,\n \"resume_url\":\"http:/jlsmith.lender.com/resume\"\n },\n \"state_licenses\": [\n {\n \"state_name\": \"minnesota\"\n },\n {\n \"state_name\": \"KS\"\n }\n ],\n \"recruit_metrics\": [\n {\n \"metric\": {\n \"metric_name\": \"Builders\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"30\"\n },\n {\n \"metric\": {\n \"metric_name\": \"Realtors\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"40\"\n },\n\t {\n \t\t\"metric\": {\n \t\t\t\"metric_name\": \"Sales Production\",\n \t\t\t\"metric_type\": \"sales_production\"\n \t\t},\n \t\t\"unit\": {\n \t\t\t\"unit_name\": \"dollars\"\n \t\t},\n \t\t\"value\": \"10123\",\n \t\t\"on_date\": \"2018\"\n \t}\n ]\n}"},"url":"{{external_api_host}}/v1/contact-recruits"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"created\": \"external-api.totaldev.us/v1/contact-recruits/520\",\n \"id\": 520\n}"},{"id":"0ad7802f-7874-44b6-acdc-40aecadfe367","name":"Insufficient Scope","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Ms.\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"email\": \"jlsmith@example.com\",\n \"email_work\": \"jlsmith@otherlender.com\",\n \"address\": \"1234 Bermuda St\",\n \"address_2\": \"Apt. 3\",\n \"city\": \"Pleasantville\",\n \"state\": \"MN\",\n \"zip_code\": \"12345\",\n \"phone_cell\": \"(763)555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"phone_home\": \"(612)-555-0123\",\n \"employer_name\": \"Other Lender LLC\",\n \"employer_address\": \"1235 Fake Ave.\",\n \"employer_address_2\": \"Ste 5\",\n \"employer_city\": \"Unpleasantville\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"license_number\": \"Q10101010101011\",\n \"source\": \"Recruit Intake System\",\n \"creation_date\": \"2017-01-01 11:11:11\",\n \"last_contacted_date\": \"2017-01-01 12:12:12\",\n \"external_id\": \"101010\",\n \"birthday\": \"1970-01-01\",\n \"ok_to_mail\": 0,\n \"ok_to_email\": 0,\n \"ok_to_call\": 0,\n \"preferences\": {\n \"is_silenced\": true\n },\n \"owner\": {\n \"external_id\": \"userExternal1\"\n },\n \"contact_groups\": [\n {\n \"group_name\": \"Recruit - Hot\"\n }\n ],\n \"external_ids\": [\n {\n \"source\": \"Recruit Intake System\",\n \"external_id\": \"101010\"\n },\n {\n \"source\": \"Other Recruit Intake System\",\n \"external_id\": \"abcd\"\n }\n ],\n \"external_status\": {\n \"status_name\": \"Processing\"\n },\n \"recruit_info\": {\n \"nmls_number\": \"NMLS identifier\",\n \"regional_manager\": {\n \"username\": \"glen-lender\"\n },\n \"division_manager\": {\n \"username\": \"suzy-lender\"\n },\n \"branch_manager\": {\n \"username\": \"richard-lender\"\n },\n \"recruit_status\": {\n \"status_name\": \"Active\"\n },\n \"corporate_objective\": \"2306\",\n \"sourced_percentage\": \"10\",\n \"commission_cap\": \"26002\",\n \"commission_split\": \"50%\",\n \"ust_is_complete\": true,\n \"background\": \"Jane started as a loan officer...\",\n \"years_experience\": 6,\n \"has_resume\":true,\n \"resume_url\":\"http:/jlsmith.lender.com/resume\"\n },\n \"state_licenses\": [\n {\n \"state_name\": \"minnesota\"\n },\n {\n \"state_name\": \"KS\"\n }\n ],\n \"recruit_metrics\": [\n {\n \"metric\": {\n \"metric_name\": \"Builders\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"30\"\n },\n {\n \"metric\": {\n \"metric_name\": \"Realtors\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"40\"\n },\n\t {\n \t\t\"metric\": {\n \t\t\t\"metric_name\": \"Sales Production\",\n \t\t\t\"metric_type\": \"sales_production\"\n \t\t},\n \t\t\"unit\": {\n \t\t\t\"unit_name\": \"dollars\"\n \t\t},\n \t\t\"value\": \"10123\",\n \t\t\"on_date\": \"2018\"\n \t}\n ]\n}"},"url":"{{external_api_host}}/v1/contact-recruits"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": \"insufficient_scope\",\n \"error_description\": \"The request requires higher privileges than provided by the access token\"\n}"}],"_postman_id":"02570879-9ea4-49f9-886e-5220e46911e6"},{"name":"Update Contact Recruit","id":"295482db-2d05-4e6a-8aae-a6993f535445","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\"recruit_metrics\": [\r\n\t{\r\n\t\t\"metric\": {\r\n\t\t\t\"metric_name\": \"Builders\",\r\n\t\t\t\"metric_type\": \"business_source\"\r\n\t\t},\r\n\t\t\"unit\": {\r\n\t\t\t\"unit_name\": \"percent\"\r\n\t\t},\r\n\t\t\"value\": \"50\"\r\n\t},\r\n\t{\r\n\t\t\"metric\": {\r\n\t\t\t\"metric_name\": \"Realtors\",\r\n\t\t\t\"metric_type\": \"business_source\"\r\n\t\t},\r\n\t\t\"unit\": {\r\n\t\t\t\"unit_name\": \"percent\"\r\n\t\t},\r\n\t\t\"value\": \"20\"\r\n\t},\r\n\t{\r\n\t\t\"metric\": {\r\n\t\t\t\"metric_name\": \"Sales Production\",\r\n\t\t\t\"metric_type\": \"sales_production\"\r\n\t\t},\r\n\t\t\"unit\": {\r\n\t\t\t\"unit_name\": \"dollars\"\r\n\t\t},\r\n\t\t\"value\": \"10123\",\r\n\t\t\"on_date\": \"2018\"\r\n\t}\r\n]\r\n}"},"url":"{{external_api_host}}/v1/contact-recruits/{{contact_id}}","description":"

Update an existing contact by ID.

\n","urlObject":{"path":["v1","contact-recruits","{{contact_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"d5afa70d-a39c-4577-9912-2ce6fb4a08f5","name":"Remove Metric","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\"remove_recruit_metrics\": [\r\n\t{\r\n\t\t\"metric\": {\r\n\t\t\t\"metric_name\": \"Builders\",\r\n\t\t\t\"metric_type\": \"business_source\"\r\n\t\t},\r\n\t\t\"unit\": {\r\n\t\t\t\"unit_name\": \"percent\"\r\n\t\t}\r\n\t}\r\n]\r\n}"},"url":"{{external_api_host}}/v1/contact-recruits/{{contact_id}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[]"},{"id":"1d124f9e-8dda-4394-a2cc-da3d8cca2f4a","name":"Update Contact Recruit","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\"recruit_metrics\": [\r\n\t{\r\n\t\t\"metric\": {\r\n\t\t\t\"metric_name\": \"Builders\",\r\n\t\t\t\"metric_type\": \"business_source\"\r\n\t\t},\r\n\t\t\"unit\": {\r\n\t\t\t\"unit_name\": \"percent\"\r\n\t\t},\r\n\t\t\"value\": \"50\"\r\n\t},\r\n\t{\r\n\t\t\"metric\": {\r\n\t\t\t\"metric_name\": \"Realtors\",\r\n\t\t\t\"metric_type\": \"business_source\"\r\n\t\t},\r\n\t\t\"unit\": {\r\n\t\t\t\"unit_name\": \"percent\"\r\n\t\t},\r\n\t\t\"value\": \"20\"\r\n\t},\r\n\t{\r\n\t\t\"metric\": {\r\n\t\t\t\"metric_name\": \"Sales Production\",\r\n\t\t\t\"metric_type\": \"sales_production\"\r\n\t\t},\r\n\t\t\"unit\": {\r\n\t\t\t\"unit_name\": \"dollars\"\r\n\t\t},\r\n\t\t\"value\": \"10123\",\r\n\t\t\"on_date\": \"2018\"\r\n\t}\r\n]\r\n}"},"url":"{{external_api_host}}/v1/contact-recruits/{{contact_id}}"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[]"},{"id":"10eb7cb1-693a-4539-b9af-00b3383484cb","name":"Remove State License","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"remove_state_licenses\": [{\"state_name\":\"AK\"}, {\"state_name\":\"kansas\"}]\n}"},"url":"{{external_api_host}}/v1/contact-recruits/{{contact_id}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"295482db-2d05-4e6a-8aae-a6993f535445"},{"name":"Delete Contact Recruit","event":[{"listen":"prerequest","script":{"id":"587ad705-e7b4-45ab-bc32-998e50fd892a","exec":[""],"type":"text/javascript"}}],"id":"87e76cc1-0ad4-4702-8fa4-c169a2bac7ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{external_api_host}}/v1/contact-recruits/{{contact_id}}","description":"

Delete a contact by ID.

\n","urlObject":{"path":["v1","contact-recruits","{{contact_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"87e76cc1-0ad4-4702-8fa4-c169a2bac7ce"}],"id":"769e57f8-f5c5-45b6-8868-d024cf50120c","description":"

Endpoints for interacting with the contact-recruits resource.

Attributes

See the Contacts documentation for accepted attributes and uniqueness considerations. See below for additional special attributes accepted by the Contact Recruits endpoints:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
recruit_info	Yes	object	Collection of recruit's professional data. See the \"Recruit Info Attributes\" and \"Recruit Info Relationships\" tables for available attributes.
state_licenses	Yes	object	Collection of recruit's state licenses. See the \"Recruit State License Attributes\" table for available attributes.
recruit_metrics	Yes	object	Collection of recruit's professional metrics. See the \"Recruit Metric Attributes\" and \"Recruit Metric Relationships\" tables for available attributes.

Recruit Info Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
nmls_id	Yes	string	The NMLS identifier.
corporate_objective	Yes	string	The recruit's sales objective with their current employer.
sourced_percent	Yes	string	The percent of the recruit's business they source versus leads that are handed to them by their current employer.
commission_cap	Yes	string	The maximum amount of commission the recruit can acquire.
commission_split_percent	Yes	string	The percent split of profit share between the organization and the loan officer.
ust_is_complete	Yes	boolean	The recruit has completed the uniform state test.
background	Yes	string	A summary of the contact's background and/or experience.
years_experience	Yes	string	The number of years of relevant experience that the contact has.
has_resume	Yes	boolean	Contact has provided a resume.
resume_url	Yes	string	Link to the contact's resume page.

Recruit Info Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
branch_manager	Yes	User	username, id, external_id, email	Existing user to associate with the recruit.
division_manager	Yes	User	username, id, external_id, email	Existing user to associate with the recruit.
regional_manager	Yes	User	username, id, external_id, email	Existing user to associate with the recruit.
recruit_status	Yes	Contact Recruit Status	status_name	Existing recruitment status to associate with this contact.

Recruit State License Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
state_name	Yes	string	Name or abbreviation of a U.S. state. Names will be converted to state abbreviations.

Recruit Metric Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
value	Yes	integer	The numeric value for the metric. The 'unit' relationship defines the number's meaning.
on_date	Yes	string	Date/year to which metric applies. Preferred format: 'YYYY', 'YYYY-MM-DD', 'YYYY-MM'

Recruit Metric Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
metric	Yes	Contact Recruit Metric	metric_name, metric_type	Existing metric definition associated with the metric 'value'.
unit	Yes	Contact Recruit Metric Unit	unit_name	Existing metric unit definition associate with the metric 'value'.

Special POST/PATCH Attributes

These attributes are used to manipulate the recruit but are neither recruit attributes or relationships. These attributes will not appear in responses.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Settable Fields	Description
remove_state_licenses	Recruit State License	state_name	License to remove from recruit's state licenses. Array of recruit state license objects.
remove_recruit_metrics	Recruit Metric	metric, unit	Metrics to remove from recruit's professional metrics. Array of recruit metric objects.

Restrictions on Metrics

There are a few quirks to metrics. Contact metrics must meet the following requirements:

Any \"sales_production\" metrics must have an \"on_date\" included. For other metrics, \"on_date\" is optional.
Any \"system_experience\" metrics must use the \"years\" unit.
Metrics of a given metric type (e.g. \"business_source\") that are expressed with the \"percent\" unit must have a combined sum that does not exceed 100%. If you receive an error related to this and your POST/PATCH body meets this requirement ensure that there are no pre-existing metrics in the system that would be adding to the sum for the recruit.

\n","event":[{"listen":"prerequest","script":{"id":"03aab143-4c0a-46ba-89f8-6b4facd850d0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b2fee9bf-318f-447e-93a8-c1534dc008fa","type":"text/javascript","exec":[""]}}],"_postman_id":"769e57f8-f5c5-45b6-8868-d024cf50120c"},{"name":"Contact Recruit Status","item":[{"name":"Fetch Contact Recruit Statuses","id":"31b2ee23-837c-4c2d-ab44-1f7b816fd963","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/contact-recruit-statuses?page[number]=1&page[size]=10","urlObject":{"path":["v1","contact-recruit-statuses"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[{"id":"953cd5de-639f-4096-a4dd-775742368c44","name":"Fetch Contact Recruit Statuses","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"{{external_api_host}}/v1/contact-recruit-statuses?page[number]=1&page[size]=10","host":["{{external_api_host}}"],"path":["v1","contact-recruit-statuses"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"status_name\": \"Active\"\n },\n {\n \"status_name\": \"On Hold\"\n },\n {\n \"status_name\": \"Decline\"\n },\n {\n \"status_name\": \"Engaged\"\n },\n {\n \"status_name\": \"Offer Out\"\n }\n ],\n \"links\": {\n \"first\": 1,\n \"last\": 1,\n \"next\": null,\n \"prev\": null\n }\n}"}],"_postman_id":"31b2ee23-837c-4c2d-ab44-1f7b816fd963"}],"id":"652ce2c7-318b-4948-be2e-04768194665c","description":"

Endpoints for interacting with the contact-recruit-statuses resource. These are the definitions for the recruit statuses the user's organization allows.

Attributes

The attributes returned by the Contact Recruit Statuses endpoint:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
status_name	No	string	The name of the status (e.g. Active, On Hold).

","event":[{"listen":"prerequest","script":{"id":"99a37f63-3a4a-4958-8f61-4c9eefae87bd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"63fa848b-5aa3-4176-b715-ee2e1ad6f54b","type":"text/javascript","exec":[""]}}],"_postman_id":"652ce2c7-318b-4948-be2e-04768194665c"},{"name":"Contact Recruit Metrics","item":[{"name":"Fetch Contact Recruit Metrics","id":"da6ecb4c-a7b9-43b7-a9a4-81355dcddb6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/contact-recruit-metrics?page[number]=1&page[size]=10","urlObject":{"path":["v1","contact-recruit-metrics"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[{"id":"1afcab8f-d231-4573-b2d0-bb1010baa339","name":"Fetch Contact Recruit Metrics","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"{{external_api_host}}/v1/contact-recruit-metrics?page[number]=1&page[size]=10","host":["{{external_api_host}}"],"path":["v1","contact-recruit-metrics"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"metric_name\": \"Referrals\",\n \"metric_type\": \"business_source\"\n },\n {\n \"metric_name\": \"Leads\",\n \"metric_type\": \"business_source\"\n },\n {\n \"metric_name\": \"Lead Sources\",\n \"metric_type\": \"business_source\"\n },\n {\n \"metric_name\": \"Realtors\",\n \"metric_type\": \"business_source\"\n },\n {\n \"metric_name\": \"Sales Production\",\n \"metric_type\": \"sales_production\"\n },\n {\n \"metric_name\": \"Builders\",\n \"metric_type\": \"business_source\"\n },\n {\n \"metric_name\": \"Conforming\",\n \"metric_type\": \"product\"\n },\n {\n \"metric_name\": \"FHA/VA\",\n \"metric_type\": \"product\"\n },\n {\n \"metric_name\": \"Jumbo\",\n \"metric_type\": \"product\"\n },\n {\n \"metric_name\": \"Broker\",\n \"metric_type\": \"product\"\n }\n ],\n \"links\": {\n \"first\": 1,\n \"last\": 2,\n \"next\": 2,\n \"prev\": null\n }\n}"}],"_postman_id":"da6ecb4c-a7b9-43b7-a9a4-81355dcddb6d"}],"id":"e02ff7b8-8b28-43a2-bf97-9b3c925edc64","description":"

Endpoints for interacting with the contact-recruit-metrics resource. These are the definitions for the metrics the user's organization is collecting.

Attributes

The attributes returned by the Contact Recruit Metrics endpoint:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
metric_name	No	string	The name of the metric (e.g. Builders, Total Expert).
metric_type	No	string	The type of metric (e.g. business_source, system_experience).

","event":[{"listen":"prerequest","script":{"id":"2156edcb-83ef-43e2-9c2b-a8ed587eee65","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9b053e3a-7628-450b-9696-ed5482148170","type":"text/javascript","exec":[""]}}],"_postman_id":"e02ff7b8-8b28-43a2-bf97-9b3c925edc64"},{"name":"Contact Recruit Units","item":[{"name":"Fetch Contact Recruit Metric Units","id":"4d88f1e4-39d8-4702-9e2e-039692cfb47d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/contact-recruit-metric-units?page[number]=1&page[size]=10","urlObject":{"path":["v1","contact-recruit-metric-units"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[{"id":"587f6f0a-12ba-4c91-93fd-7dbbabfd42e9","name":"Fetch Contact Recruit Metric Units","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"{{external_api_host}}/v1/contact-recruit-metric-units?page[number]=1&page[size]=10","host":["{{external_api_host}}"],"path":["v1","contact-recruit-metric-units"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"unit_name\": \"percent\"\n },\n {\n \"unit_name\": \"dollars\"\n },\n {\n \"unit_name\": \"loans\"\n },\n {\n \"unit_name\": \"years\"\n }\n ],\n \"links\": {\n \"first\": 1,\n \"last\": 1,\n \"next\": null,\n \"prev\": null\n }\n}"}],"_postman_id":"4d88f1e4-39d8-4702-9e2e-039692cfb47d"}],"id":"4e2b2866-fea8-4ad2-bad7-579ea9e1aedd","description":"

Endpoints for interacting with the contact-recruit-metric-units resource. These are the definitions for the metric units the user's organization allows.

Attributes

The attributes returned by the Contact Recruit Metric Units endpoint:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
unit_name	No	string	The name of the unit (e.g. dollars, years).

","event":[{"listen":"prerequest","script":{"id":"fc98af50-7209-4f9d-877d-e7ccc2f014dd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f7c8c5ea-138e-4eef-8e52-70180963bd21","type":"text/javascript","exec":[""]}}],"_postman_id":"4e2b2866-fea8-4ad2-bad7-579ea9e1aedd"}],"id":"2f188af0-8499-4135-a129-66a5e8400d58","_postman_id":"2f188af0-8499-4135-a129-66a5e8400d58","description":""},{"name":"Contact Communication Consent","item":[{"name":"Grant Consent on Create","id":"e0fe3170-1c0e-4dc1-97ff-73b28fb7148a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Doctor\",\n \"first_name\": \"Clark\",\n \"last_name\": \"Gable\",\n \"email\": \"username@example.com\",\n \"email_work\": \"clark.gable2@totalexpertinc.com\",\n \"address\": \"1234 Fake St\",\n \"address_2\": \"Apartment -8\",\n \"city\": \"Pleasantville\",\n \"state\": \"MN\",\n \"zip_code\": \"12345\",\n \"phone_cell\": \"(763)555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"phone_home\": \"(612)-555-0123\",\n \"external_ids\": [\n {\n \"source\":\"local\",\n \"external_id\":\"abcd\"\n }\n ],\n \"grant_consent\": {\n \"communication_agent\": \"agentic-a-i\",\n \"communication_channel\": \"phone\",\n \"channel_target\": \"+17635550123\",\n \"contact_purpose\": \"marketing\",\n \"capture_source\": \"A web form check box\",\n \"consent_language\": \"Contact has consented to AI calls\",\n \"ip_address\": \"1.1.1.1\"\n }\n}"},"url":"{{external_api_host}}/v1/contacts/","urlObject":{"path":["v1","contacts",""],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e0fe3170-1c0e-4dc1-97ff-73b28fb7148a"},{"name":"Grant Consent on Update","id":"490643d3-2835-4b55-815a-26903374806a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Doctor\",\n \"first_name\": \"Clark\",\n \"last_name\": \"Gable\",\n \"email\": \"username@example.com\",\n \"email_work\": \"clark.gable2@totalexpertinc.com\",\n \"address\": \"1234 Fake St\",\n \"address_2\": \"Apartment -8\",\n \"city\": \"Pleasantville\",\n \"state\": \"MN\",\n \"zip_code\": \"12345\",\n \"phone_cell\": \"(763)555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"phone_home\": \"(612)-555-0123\",\n \"external_ids\": [\n {\n \"source\":\"local\",\n \"external_id\":\"abcd\"\n }\n ],\n \"grant_consent\": {\n \"communication_agent\": \"agentic-a-i\",\n \"communication_channel\": \"phone\",\n \"channel_target\": \"+17635550123\",\n \"contact_purpose\": \"marketing\",\n \"capture_source\": \"A web form check box\",\n \"consent_language\": \"Contact has consented to AI calls\",\n \"ip_address\": \"1.1.1.1\"\n }\n}"},"url":"{{external_api_host}}/v1/contacts/","urlObject":{"path":["v1","contacts",""],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"490643d3-2835-4b55-815a-26903374806a"},{"name":"Revoke Consent","id":"78029990-0719-4be5-ac9b-b7b5ba1cb716","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Doctor\",\n \"first_name\": \"Clark\",\n \"last_name\": \"Gable\",\n \"email\": \"username@example.com\",\n \"email_work\": \"clark.gable2@totalexpertinc.com\",\n \"address\": \"1234 Fake St\",\n \"address_2\": \"Apartment -8\",\n \"city\": \"Pleasantville\",\n \"state\": \"MN\",\n \"zip_code\": \"12345\",\n \"phone_cell\": \"(763)555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"phone_home\": \"(612)-555-0123\",\n \"external_ids\": [\n {\n \"source\":\"local\",\n \"external_id\":\"abcd\"\n }\n ],\n \"revoke_consent\": {\n \"communication_agent\": \"agentic-a-i\",\n \"communication_channel\": \"phone\",\n \"channel_target\": \"+17635550123\",\n \"contact_purpose\": \"marketing\",\n \"capture_source\": \"Customer support\",\n \"consent_language\": \"Contact has revoked consented for AI calls\",\n \"ip_address\": \"1.1.1.1\"\n }\n}"},"url":"{{external_api_host}}/v1/contacts/","urlObject":{"path":["v1","contacts",""],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"78029990-0719-4be5-ac9b-b7b5ba1cb716"}],"id":"e1fb304b-091d-481c-890a-a68a680f7140","description":"

The communication consent toolset provides a mechanism for recording the consent records your organization collects from your contacts. This tool is currently tailored specifically for telephone communication by an agentic A.I. application.

The API is designed around 2 primary operations: \"Consent Grant\" and \"Consent Revoke\". In order for consent to be revoked, it must have been previously granted.

Once consent has been granted, the corresponding Journey Condition will allow or block the AI Sales Assistant from making automated calls depending on the status of the Contact's AI Consent. AI Consent status will also be displayed on the Contact Profile, with an option to revoke manually through the User Interface.

The consent api follows the same command structure that the other Contact API endpoints for identifiying your contact, plus an object that describes your \"grant\" or revocation \"revoke\".

Note: Consent grant may be attached for a Create Contact (POST) or a Update Contact (PATCH). Revoking consent must be performed as a Contact Update (PATCH).

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter name	Type and values	Required	Description
`first_name`	string	true	refer to Consent Create and update for the full list of contact parameters.
`last_name`	string	true	...
`email`	string: A valid email	false	...
`grant_consent or revoke_consent`	Object	true
.`communication_agent`	string	true	\"agentic-a-i\"
.`communication_channel`	string	true	\"phone\"
.`channel_target`	string	true	an e164 formatted (U.S.) phone number. ie- \"+16125551212\"
.`contact_purpose`	string	true	\"marketing\", \"existing-business\"
.`capture_source`	string	true	a description of the way in which the consent was established. ie- \"Online form checkbox\"
.`consent_language`	string	true	The copy that the user was presented with when they opted in with consent.
.`ip_address`	string	true	A valid ip4 or ip6 addess if it can be captured accurately. Pass 1.1.1.1 if the address has not been captured.

API Example

\n\n

{\n  \"first_name\": \"first\",\n  \"last_name\": \"last\",\n  \"email\": \"test@test.com\",\n  \"grant_consent\": {\n    \"communication_agent\": \"agentic-a-i\",\n    \"communication_channel\": \"phone\",\n    \"channel_target\": \"+16518675309\",\n    \"contact_purpose\": \"marketing\",\n    \"capture_source\": \"A web form check box\",\n    \"consent_language\": \"Contact has consented to AI calls\",\n    \"ip_address\": \"1.1.1.1\"\n  }\n}  \n\n

\n\n

{\n  \"first_name\": \"first\",\n  \"last_name\": \"last\",\n  \"email\": \"test@test.com\",\n  \"revoke_consent\": {\n    \"communication_agent\": \"agentic-a-i\",\n    \"communication_channel\": \"phone\",\n    \"channel_target\": \"+16518675309\",\n    \"contact_purpose\": \"marketing\",\n    \"consent_language\": \"Contact has consented to AI calls\",\n    \"ip_address\": \"1.1.1.1\"\n  }\n}\n\n

\n","_postman_id":"e1fb304b-091d-481c-890a-a68a680f7140"},{"name":"Additional Contact Related Endpoints","item":[{"name":"Channels","item":[{"name":"Fetch Channels","id":"c43f1af8-2737-4d59-8783-60e967023adb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/channels?page[number]=1","description":"

Fetch a page of channels. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","channels"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"disabled":true,"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"c43f1af8-2737-4d59-8783-60e967023adb"}],"id":"72a9cdba-a6be-4c6f-a479-765ec8972d6d","description":"

Endpoints for interacting with the channels resource.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
system_name	No	string	The unique system name of the channel

","event":[{"listen":"prerequest","script":{"id":"623761ca-34df-42aa-ad35-6fa22d40ad05","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"66d2771b-8430-464c-bc60-7fce3d60f9bd","type":"text/javascript","exec":[""]}}],"_postman_id":"72a9cdba-a6be-4c6f-a479-765ec8972d6d"},{"name":"WLP Access Types","item":[{"name":"Fetch WLP Access Types","id":"2c9a2a5d-07ee-4730-bf49-597061ee8e68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/wlp-access-types?page[number]=1","description":"

Fetch a page of wlp access types. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","wlp-access-types"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"disabled":true,"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"2c9a2a5d-07ee-4730-bf49-597061ee8e68"}],"id":"6f00a509-33db-4ae1-9195-e26f42859c11","description":"

Endpoints for interacting with the wlp-access-types resource.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
access_type	No	string	The unique name of the WLP access type

","event":[{"listen":"prerequest","script":{"id":"623761ca-34df-42aa-ad35-6fa22d40ad05","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"66d2771b-8430-464c-bc60-7fce3d60f9bd","type":"text/javascript","exec":[""]}}],"_postman_id":"6f00a509-33db-4ae1-9195-e26f42859c11"},{"name":"Campaigns","item":[{"name":"Fetch Campaigns","id":"203716c0-4244-46f4-b4d3-b53516bbeaf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/campaigns","description":"

Fetch a page of campaigns. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","campaigns"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"203716c0-4244-46f4-b4d3-b53516bbeaf9"},{"name":"Fetch Campaign","id":"4e26a565-a032-4fa9-b750-c82684311f87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/campaigns/{{campaign_id}}","description":"

Fetch a campaign by id.

\n","urlObject":{"path":["v1","campaigns","{{campaign_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4e26a565-a032-4fa9-b750-c82684311f87"},{"name":"Create Campaign","event":[{"listen":"test","script":{"id":"1131a048-c109-493f-8283-ce3005dac37b","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"contact_group_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"2f54aaec-3018-454b-aaca-ca053870628e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Campaign Test Name\"\n}"},"url":"{{external_api_host}}/v1/campaigns","description":"

Create a campaign.

Required Attributes:

name

\n","urlObject":{"path":["v1","campaigns"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2f54aaec-3018-454b-aaca-ca053870628e"}],"id":"084f2c90-7e60-4118-9cc4-4ffbc59158f0","description":"

Endpoints for interacting with the Campaigns resource.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	string	Generated hexadecimal identifier for campaign.
name	Yes	string	Name of the campaign.
visible	Yes	boolean	Whether the campaign is visible in the UI.
start_date	Yes	datetime	Starting date for the campaign.
end_date	Yes	datetime	Ending date for the campaign.
archived	Yes	boolean	Whether the campaign has been archived.
internal_created_at	Yes	datetime	Date the campaign was created in TE (read-only).

Uniqueness

\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Fields
1	name

Filtering

Use the 'filter=attribute_name=x,attribute_name_2=y' query to return the list of campaigns that meet the filter criteria. For example, to filter campaigns started between Oct. 14, 2017 17:41:01 (UTC) and Oct. 15, 2017 17:41:09 (UTC), the following query could be used:

/campaigns?filter=start_date_start=2017-10-14T17:41:01Z,start_date_end=2017-10-15T17:41:09Z

The supported filter attributes are shown in the following table.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
start_date_start	ISO-8601 formatted date. The start of the time range of interest, inclusive.
start_date_end	ISO-8601 formatted date. The end of the time range of interest, inclusive.
end_date_start	ISO-8601 formatted date. The end of the time range of interest, inclusive.
end_date_end	ISO-8601 formatted date. The end of the time range of interest, inclusive.

","event":[{"listen":"prerequest","script":{"id":"d06193a6-1b64-4564-a86e-6c1135f02651","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2e6bff4f-c655-4eed-ae53-c18806820a96","type":"text/javascript","exec":[""]}}],"_postman_id":"084f2c90-7e60-4118-9cc4-4ffbc59158f0"},{"name":"Campaign Activity","item":[{"name":"Create Campaign Activity","event":[{"listen":"test","script":{"id":"1131a048-c109-493f-8283-ce3005dac37b","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"contact_group_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"36fbeb86-848c-4d6b-aad9-67311e903a32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"touched_at\":\"2019-01-01 10:00:00\",\n \"owner\": {\n \t\"id\":50\n },\n \"contact\":{\n \t\"id\":\"500\"\n },\n \"campaign\": {\n \t\"id\":\"374363f2971dedcddae7502e5f920c35\"\n }\n}"},"url":"{{external_api_host}}/v1/campaign-activity","description":"

Create a campaign activity.

Required Attributes:

[none]

Required Relationsips:

contact
campaign

\n","urlObject":{"path":["v1","campaign-activity"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"36fbeb86-848c-4d6b-aad9-67311e903a32"},{"name":"Delete Campaign Activity","event":[{"listen":"test","script":{"id":"1131a048-c109-493f-8283-ce3005dac37b","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"contact_group_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"0259f258-ea13-423e-ad9d-5013a5a3ed93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{external_api_host}}/v1/campaign-activity/","description":"

Delete a campaign activity record by id.

\n","urlObject":{"path":["v1","campaign-activity",""],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0259f258-ea13-423e-ad9d-5013a5a3ed93"},{"name":"Fetch Campaign Activities","id":"56f54c30-206c-4311-9bad-e813f3dee68e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/campaign-activity?page[number]=1&page[size]=100","description":"

Fetch a page of campaign activity records. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","campaign-activity"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"100"}],"variable":[]}},"response":[],"_postman_id":"56f54c30-206c-4311-9bad-e813f3dee68e"},{"name":"Fetch Campaign Activity","id":"134b6035-7a04-4d25-a80c-9d3b52ad9462","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/campaign-activity/{{campaign_activity_id}}","description":"

Fetch a campaign activity by id.

\n","urlObject":{"path":["v1","campaign-activity","{{campaign_activity_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"134b6035-7a04-4d25-a80c-9d3b52ad9462"}],"id":"63220b1b-ffd6-4e09-a8bb-a9e251b0de7d","description":"

Endpoints for interacting with the Campaign Activity resource.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	string	Generated hexadecimal identifier for campaign activity.
touched_at	Yes	datetime	Timestamp the activity occurred.
internal_created_at	Yes	string	Timestamp the activity was created in TE (read-only).

Uniqueness

Campaign activity is not deduplicated. Each post will create a new activity.

Relationships

The \"owner\" section at the top level of the POST, PATCH, or DELETE is required when contacts are included in the request. All included contacts are created or updated for that owner, and only one owner can be used per request.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
owner	Yes*	User	username, id, external_id, email	Owning user of the entity. One to many relationship, so returned as an object. *Only assignable/visible if authenticated as an organization admin.
contact	Yes	Contact	(See contact documentation)	Contact for whom this activity occurred.
campaign	Yes	Campaign	id, name	(See Related Entities Relationships Section, below)

Filtering

Use the 'filter=attribute_name=x,attribute_name_2=y' query to return the list of campaign activities that meet the filter criteria. For example, to filter campaign activities created between Oct. 14, 2017 17:41:01 (UTC) and Oct. 15, 2017 17:41:09 (UTC), the following query could be used:

/campaign-activity?filter=internal_created_at_start=2017-10-14T17:41:01Z,internal_created_at_end=2017-10-15T17:41:09Z

The supported filter attributes are shown in the following table.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
internal_created_at_start	ISO-8601 formatted date. The start of the time range of interest, inclusive.
internal_created_at_end	ISO-8601 formatted date. The end of the time range of interest, inclusive.
touched_at_start	ISO-8601 formatted date. The end of the time range of interest, inclusive.
touched_at_end	ISO-8601 formatted date. The end of the time range of interest, inclusive.
related_range_ext_field	Related range extension field.
contact_id	ID for the contact.
campaign_id	Identifier for campaign.

The following endpoints are in limited availability and are not recommended for general use. For questions about these endpoints, please reach out to support.

\n","_postman_id":"9a8b96cd-3fc6-4310-ad39-8bf8c0ee6e6e"}],"id":"60505d53-7df5-455e-9ae4-f1d7f3985057","description":"

The varying contact endpoints that are associated with the following collections are used for

Adding contacts
\n
Updating existing contacts
\n
Transferring ownership of contacts
\n
Obtaining the TE ID of contacts
\n
Creating and submitting Contact Surveys
\n
Creating contact groups, etc.
\n

Tips for using the Contact endpoints

You will see a “duplicate” response if utilizing the Create (POST) method for updating existing contacts. However, the original entity will be updated.
\n
You may want to utilize more than one identifier, such as ‘email address,’ if your organization has overlap when specifying the owner of a contact based on the User’s External ID.
\n
If the data field does not exist within your environment, it is better to not submit this attribute in the request – rather than submitting it as blank. Ex: Do not submit a date of “0000-00-00”
\n
Only use valid dates when submitting through the API. Omit the attribute if the date does not exist.
\n
The maximum number of contacts returned per page on a GET request is 100. Specify using ‘?page[size]=100’
\n

Why Contacts Are Important

Ensuring that you have the most up-to-date contact information within your TE system allows you to confidently send relevant communication, enable the right kinds of marketing automation at the right time, strengthen both your new and past relationships with customers and increase your overall brand image.

Contact Source

If the contact is coming from a third-party lead generating source, such as LeadPops, Velocify, LendingTree, etc. it is recommended to call use the source attribute in the call.

Contact Ownership

Specifying the owner of a contact is important because they are the only user that has the ability to remove or share/assign the contact record to other users within the TE system.

As an admin that is POSTing contacts to the TE system, you need to specify the contact’s owner. When specifying who the contact owner is, you can use the following settable fields within the request:

Username
\n
ID
\n
External ID
\n
Email
You do not need to specify the contact’s owner if you have user-level authentication access.
\n

How to Change Contact Ownership

Similar to specifying the contact’s owner, you need to have admin-level authentication access. A POST call is required to update the owner of an already created contact. Simply include the contact ID and the updated owner ID in call. Deduplication logic will apply (see below for details).

Contact Webhooks

Total Expert has webhooks for the following contact interactions:

Contact Update
\n
Contact Creation
\n
Contact Archived
\n

Check out the Webhook documentation for more details on how to subscribe to these webhooks.

\n","_postman_id":"60505d53-7df5-455e-9ae4-f1d7f3985057"},{"name":"Lead Opportunities (New)","item":[{"name":"Error Scenarios","item":[{"name":"Missing Required Fields","id":"961a3bbe-7f8e-4f67-977f-48c0c4e34b64","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\"\n}"},"url":"{{external_api_host}}/v1/lead-opportunities","description":"

Example error when required fields are missing.

Expected Response (400):

{\n  \"error\": \"Missing required fields. Must provide: first_name, last_name, source, and either phone or email\"\n}\n

\n","urlObject":{"path":["v1","lead-opportunities"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"961a3bbe-7f8e-4f67-977f-48c0c4e34b64"},{"name":"Invalid Filter Expression","id":"b6e28d92-b630-46d0-836c-9c2568b99340","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{external_api_host}}/v1/lead-opportunities?filter=invalidfilter","description":"

Example error for invalid filter syntax.

Expected Response (400):

{\n  \"error\": \"Invalid filter expression: invalidfilter\"\n}\n

\n","urlObject":{"path":["v1","lead-opportunities"],"host":["{{external_api_host}}"],"query":[{"key":"filter","value":"invalidfilter"}],"variable":[]}},"response":[],"_postman_id":"b6e28d92-b630-46d0-836c-9c2568b99340"},{"name":"Invalid Sort Field","id":"90b31341-c4b9-4a38-ade1-6aac68bbdb8e","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{external_api_host}}/v1/lead-opportunities?sort=invalid_field","description":"

Example error for invalid sort field.

Allowed Fields: created_at, updated_at, lead_stage, loan_purpose

Expected Response (400):

{\n  \"error\": \"Invalid sort field: 'invalid_field'.\"\n}\n

\n","urlObject":{"path":["v1","lead-opportunities"],"host":["{{external_api_host}}"],"query":[{"key":"sort","value":"invalid_field"}],"variable":[]}},"response":[],"_postman_id":"90b31341-c4b9-4a38-ade1-6aac68bbdb8e"},{"name":"Page Out of Range","id":"dd87e493-0c7c-40dd-a60c-1f40619c20d6","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{external_api_host}}/v1/lead-opportunities?page[number]=999","description":"

Example error when requesting a page beyond the result set.

Expected Response (422):

{\n  \"error\": \"Page requested is outside of result set\"\n}\n

\n","urlObject":{"path":["v1","lead-opportunities"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"999"}],"variable":[]}},"response":[],"_postman_id":"dd87e493-0c7c-40dd-a60c-1f40619c20d6"}],"id":"4fb5c1ff-b05f-447d-8adf-96aea472dfa2","description":"

Error scenarios demonstrating validation and boundary conditions.

\n","_postman_id":"4fb5c1ff-b05f-447d-8adf-96aea472dfa2"},{"name":"List Lead Opportunities (Default)","id":"02bb9c00-c506-49f5-9059-24369143ae99","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{external_api_host}}/v1/lead-opportunities","description":"

Retrieve a paginated list of lead opportunities with default settings.

Default Pagination:

Page 1
25 items per page

Response:

{\n  \"items\": [\n    {\n      \"id\": \"uuid\",\n      \"first_name\": \"John\",\n      \"last_name\": \"Doe\",\n      \"stage\": {\"id\": \"stage-1\", \"name\": \"New Lead\"},\n      \"product\": {\"type\": \"mortgage\", \"values\": {...}},\n      \"source\": {\"id\": 1, \"display_name\": \"Website\"},\n      \"assigned_user_id\": 789,\n      \"legacy_contact_id\": 456,\n      \"created_at\": \"2024-01-15T10:30:00Z\",\n      \"updated_at\": \"2024-01-16T14:20:00Z\"\n    }\n  ],\n  \"links\": {\"first\": 1, \"last\": 10, \"next\": 2, \"prev\": null}\n}\n

cURL:

curl \"{{external_api_host}}/v1/lead-opportunities\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -H \"Accept: application/json\"\n

\n","urlObject":{"path":["v1","lead-opportunities"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"02bb9c00-c506-49f5-9059-24369143ae99"},{"name":"List with Pagination","id":"fb26ea56-a08d-4df1-a5fc-07555e5e965e","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{external_api_host}}/v1/lead-opportunities?page[number]=1&page[size]=10","description":"

Get lead opportunities with custom pagination settings.

Parameters:

page[number] - Page number to retrieve (minimum: 1)
page[size] - Number of items per page (minimum: 1, default: 25)

cURL:

curl \"{{external_api_host}}/v1/lead-opportunities?page[number]=1&page[size]=10\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -H \"Accept: application/json\"\n

\n","urlObject":{"path":["v1","lead-opportunities"],"host":["{{external_api_host}}"],"query":[{"description":{"content":"

Page number (default: 1, min: 1)

\n","type":"text/plain"},"key":"page[number]","value":"1"},{"description":{"content":"

Items per page (default: 25, min: 1)

\n","type":"text/plain"},"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"fb26ea56-a08d-4df1-a5fc-07555e5e965e"},{"name":"Filter by Contact ID","id":"f1a3d47e-9160-4ac7-a5fc-e3efed015f57","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{external_api_host}}/v1/lead-opportunities?filter=contact_id=456","description":"

Filter lead opportunities by a specific contact ID.

Supported Filters:

contact_id - Contact identifier
user_id - User identifier

cURL:

curl \"{{external_api_host}}/v1/lead-opportunities?filter=contact_id=456\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -H \"Accept: application/json\"\n

\n","urlObject":{"path":["v1","lead-opportunities"],"host":["{{external_api_host}}"],"query":[{"description":{"content":"

Filter by contact ID

\n","type":"text/plain"},"key":"filter","value":"contact_id=456"}],"variable":[]}},"response":[],"_postman_id":"f1a3d47e-9160-4ac7-a5fc-e3efed015f57"},{"name":"Multiple Filters","id":"eeb3225d-f085-4000-a4a4-785a5064334e","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{external_api_host}}/v1/lead-opportunities?filter=user_id=789,contact_id=456","description":"

Filter by multiple fields using comma-separated expressions.

Syntax: filter=field1=value1,field2=value2

cURL:

curl \"{{external_api_host}}/v1/lead-opportunities?filter=user_id=789,contact_id=456\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -H \"Accept: application/json\"\n

\n","urlObject":{"path":["v1","lead-opportunities"],"host":["{{external_api_host}}"],"query":[{"description":{"content":"

Multiple comma-separated filters

\n","type":"text/plain"},"key":"filter","value":"user_id=789,contact_id=456"}],"variable":[]}},"response":[],"_postman_id":"eeb3225d-f085-4000-a4a4-785a5064334e"},{"name":"Sort by Created Date (Descending)","id":"c470af38-6098-453f-8c43-0dd50998a554","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{external_api_host}}/v1/lead-opportunities?sort=-created_at","description":"

Sort lead opportunities by creation date, newest first.

Sort Format:

field - Ascending order
-field - Descending order (with minus prefix)

Allowed Fields:

created_at
updated_at
lead_stage
loan_purpose

cURL:

curl \"{{external_api_host}}/v1/lead-opportunities?sort=-created_at\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -H \"Accept: application/json\"\n

\n","urlObject":{"path":["v1","lead-opportunities"],"host":["{{external_api_host}}"],"query":[{"description":{"content":"

Sort descending (- prefix)

\n","type":"text/plain"},"key":"sort","value":"-created_at"}],"variable":[]}},"response":[],"_postman_id":"c470af38-6098-453f-8c43-0dd50998a554"},{"name":"Sort by Updated Date (Ascending)","id":"2a423512-7983-45b2-be39-cc7532a7e541","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{external_api_host}}/v1/lead-opportunities?sort=updated_at","description":"

Sort lead opportunities by update date, oldest first.

cURL:

curl \"{{external_api_host}}/v1/lead-opportunities?sort=updated_at\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -H \"Accept: application/json\"\n

\n","urlObject":{"path":["v1","lead-opportunities"],"host":["{{external_api_host}}"],"query":[{"description":{"content":"

Sort ascending

\n","type":"text/plain"},"key":"sort","value":"updated_at"}],"variable":[]}},"response":[],"_postman_id":"2a423512-7983-45b2-be39-cc7532a7e541"},{"name":"Combined - Filter, Sort, Paginate","id":"8ae25d54-d798-45c0-ba94-c7c51964e99c","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{external_api_host}}/v1/lead-opportunities?page[number]=1&page[size]=10&filter=contact_id=456&sort=-updated_at","description":"

Combine pagination, filtering, and sorting in a single request.

This example:

Returns page 1 with 10 items
\n
Filters by contact_id=456
\n
Sorts by most recently updated first
\n

cURL:

curl \"{{external_api_host}}/v1/lead-opportunities?page[number]=1&page[size]=10&filter=contact_id=456&sort=-updated_at\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -H \"Accept: application/json\"\n\n

\n","urlObject":{"path":["v1","lead-opportunities"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"},{"key":"filter","value":"contact_id=456"},{"key":"sort","value":"-updated_at"}],"variable":[]}},"response":[],"_postman_id":"8ae25d54-d798-45c0-ba94-c7c51964e99c"},{"name":"Get Lead Opportunity by ID","id":"10294e79-2d80-43c3-a650-c7b36f82b462","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{external_api_host}}/v1/lead-opportunities/{{lead_opportunity_id}}","description":"

Retrieve a specific lead opportunity by its unique identifier.

Path Parameters:

id - Lead opportunity UUID or alphanumeric ID

Response (200 OK):

{\n  \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"stage\": {\"id\": \"stage-123\", \"name\": \"New Lead\"},\n  \"product\": {\"type\": \"mortgage\", \"values\": {...}},\n  \"source\": {\"id\": 1, \"display_name\": \"Website\"},\n  \"assigned_user_id\": 789,\n  \"legacy_contact_id\": 456,\n  \"created_at\": \"2024-01-15T10:30:00Z\",\n  \"updated_at\": \"2024-01-16T14:20:00Z\"\n}\n

Response (404 Not Found):

{\n  \"message\": \"Object with id '550e8400-e29b-41d4-a716-446655440000' not found\"\n}\n

cURL:

curl \"{{external_api_host}}/v1/lead-opportunities/550e8400-e29b-41d4-a716-446655440000\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -H \"Accept: application/json\"\n

\n","urlObject":{"path":["v1","lead-opportunities","{{lead_opportunity_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"10294e79-2d80-43c3-a650-c7b36f82b462"},{"name":"Create Lead Opportunity (Minimal)","id":"98cb054a-0bc0-45b9-aab1-e11b58cbcc8f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"source\": \"website\",\n \"email\": \"john.doe@example.com\"\n}"},"url":"{{external_api_host}}/v1/lead-opportunities","description":"

Create a lead opportunity with minimal required fields.

Required Fields (one combination):

first_name, last_name, source, phone
first_name, last_name, source, email

Response (201 Created):

{\n  \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"contact_id\": 456\n}\n

cURL:

curl -X POST \"{{external_api_host}}/v1/lead-opportunities\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"first_name\": \"John\",\n    \"last_name\": \"Doe\",\n    \"source\": \"website\",\n    \"email\": \"john.doe@example.com\"\n  }'\n

\n","urlObject":{"path":["v1","lead-opportunities"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"98cb054a-0bc0-45b9-aab1-e11b58cbcc8f"},{"name":"Create Lead Opportunity (Full)","id":"8bf73512-4c4c-49fc-b94b-988f57849d01","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"source\": \"website\",\n \"phone\": \"555-123-4567\",\n \"email\": \"john.doe@example.com\",\n \"contact_id\": 456,\n \"assigned_user\": {\n \"user_id\": 789\n },\n \"product\": {\n \"type\": \"mortgage\",\n \"values\": {\n \"loan_purpose\": \"Purchase\",\n \"loan_amount\": 350000,\n \"property_type\": \"Single-Family\",\n \"property_state\": \"CA\",\n \"credit_score\": 720\n }\n },\n \"stage\": {\n \"id\": \"1\",\n \"name\": \"New Lead\"\n },\n \"referred_by\": \"Jane Smith\",\n \"utm_source\": \"google\",\n \"utm_campaign\": \"spring_sale\",\n \"utm_medium\": \"cpc\"\n}"},"url":"{{external_api_host}}/v1/lead-opportunities","description":"

Create a lead opportunity with all available fields.

Optional Fields:

contact_id - Existing contact ID
\n
assigned_user_id - User to assign
\n
product.type and product.values - Must be provided together
\n
product.values.loan_purpose - Required when product provided
\n
stage.id and stage.name - Stage assignment
\n
referred_by - Referrer name
\n
utm_source, utm_campaign, utm_medium: marketing attribution values (all optional, strings)
\n

cURL:

curl -X POST \"{{external_api_host}}/v1/lead-opportunities\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"first_name\": \"John\",\n    \"last_name\": \"Doe\",\n    \"source\": \"website\",\n    \"phone\": \"555-123-4567\",\n    \"email\": \"john.doe@example.com\",\n    \"assigned_user_id\": 789,\n    \"product\": {\n      \"type\": \"mortgage\",\n      \"values\": {\n        \"loan_purpose\": \"purchase\",\n        \"loan_amount\": 350000\n      }\n    },\n    \"stage\": {\"id\": \"stage-123\", \"name\": \"New Lead\"},\n    \"referred_by\": \"Jane Smith\",\n    \"utm_source\": \"google\",\n    \"utm_campaign\": \"spring_sale\",\n    \"utm_medium\": \"cpc\"\n  }'\n\n

\n","urlObject":{"path":["v1","lead-opportunities"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8bf73512-4c4c-49fc-b94b-988f57849d01"},{"name":"Update Lead Opportunity","id":"752a6e41-778a-4d65-869c-feed73139226","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contact_id\": 456,\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"email\": \"jane.smith@example.com\",\n \"assigned_user\": {\n \"user_id\": 999\n },\n \"product\": {\n \"values\": {\n \"loan_amount\": 400000,\n \"credit_score\": 750\n }\n },\n \"stage\": {\n \"id\": \"stage-456\"\n },\n \"utm_source\": \"bing\",\n \"utm_campaign\": \"summer_promo\",\n \"utm_medium\": \"email\"\n}"},"url":"{{external_api_host}}/v1/lead-opportunities/{{lead_opportunity_id}}","description":"

Update an existing lead opportunity.

Required: contact_id (always required for updates)

Update Behavior:\nThree independent operations:

Assignment update (assigned_user_id)
Stage update (stage.id)
Lead opportunity update (other fields)

Product Values: Partial updates merge with existing values.

Marketing attribution: utm_source, utm_campaign, utm_medium are optional strings, each patched independently. Omit a field to leave its stored value unchanged; send a field to overwrite it.

Response (200 OK):

{\n  \"leadOpportunity\": {\"id\": \"...\", \"contact_id\": 456},\n  \"errors\": {\"stage\": \"Failed to update stage\"}\n}\n

cURL Examples:

Update assignment:

curl -X PATCH \"{{external_api_host}}/v1/lead-opportunities/550e8400-e29b-41d4-a716-446655440000\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"contact_id\": 456, \"assigned_user_id\": 999}'\n

Update product:

curl -X PATCH \"{{external_api_host}}/v1/lead-opportunities/550e8400-e29b-41d4-a716-446655440000\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"contact_id\": 456, \"product\": {\"values\": {\"loan_amount\": 400000}}}'\n

Update marketing attribution:

curl -X PATCH \"{{external_api_host}}/v1/lead-opportunities/550e8400-e29b-41d4-a716-446655440000\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"contact_id\": 456, \"utm_source\": \"bing\", \"utm_campaign\": \"summer_promo\", \"utm_medium\": \"email\"}'\n

Important Note: As part of Total Expert’s new Lead Management feature, this new endpoint has been created. Because both the new endpoint (v1/lead-opportunities) and the existing (v1/leads) endpoint deal with “leads” in the platform, there is a conflict with the nomenclature used by both endpoints.

This section of the documentation refers exclusively to the new v1/lead-opportunities endpoint.

For information on the older v1/leads endpoint, formerly called Lead Opportunities in the documentation, please see the “ALM Leads (formerly Lead Opportunities)” section.

Unless and until further notice, users cannot utilize both endpoints concurrently.

The Lead Opportunities endpoints allow lead providers to POST, GET, and PATCH lead and lead opportunity details, including offer details and custom fields.

Base Endpoint: /v1/lead-opportunities
OAuth Scope: leadOpportunitiesSalesPipelineInteraction

Supported Operations

GET /v1/lead-opportunities - List with pagination, filtering, and sorting
\n
GET /v1/lead-opportunities/{id} - Get specific lead opportunity
\n
POST /v1/lead-opportunities - Create new lead opportunity
\n
PATCH /v1/lead-opportunities/{id} - Update existing lead opportunity
\n

Pagination

All list endpoints support pagination:

page[number] - Page number (default: 1, min: 1)
\n
page[size] - Items per page (default: 25, min: 1)
\n

Response includes pagination links:

{\n  \"items\": [...],\n  \"links\": {\"first\": 1, \"last\": 10, \"next\": 2, \"prev\": null}\n}\n\n

Filtering

Use comma-separated field=value expressions:

filter=contact_id=123,user_id=456\n\n

Supported Filter Fields:

contact_id - Filter by contact ID
\n
user_id - Filter by user ID
\n

Sorting

Use sort query parameter with optional - prefix for descending:

sort=created_at        # Ascending\nsort=-updated_at       # Descending\n\n

Allowed Sort Fields:

created_at - Creation date
\n
updated_at - Last update date
\n
lead_stage - Lead stage
\n
loan_purpose - Loan purpose
\n

Behavior:

Uses first field only if multiple provided
\n
Case-insensitive, whitespace trimmed
\n
Invalid field returns 400 error
\n

Required Fields for Creation

Must provide ONE of these combinations:

first_name, last_name, source, phone
\n
first_name, last_name, source, email
\n

Product Validation

product.type and product.values must be provided together
\n
product.values.loan_purpose is required when product is provided
\n
Partial updates merge new values with existing product values
\n

Update Requirements

contact_id is always required for PATCH requests
\n
Updates target three independent areas:
\n
1. Assignment (assigned_user)
  \n
  1. user_id
    \n
  2. email
    \n
  \n
\n

Example:

  \"assigned_user\": {\n    \"user_id\": 789\n  },\n\n

  \"assigned_user\": {\n    \"email\": \"john@example.com\"\n  },\n\n

Stage (stage.id)
\n
Lead Opportunity data (other fields)
\n
Partial failures return both successes and errors
\n

Error Response Codes

400 - Bad request (invalid body, missing fields, invalid filter/sort)
\n
404 - Not found (lead opportunity doesn't exist)
\n
422 - Unprocessable entity (page number out of range)
\n
500 - Internal server error
\n

Valid Attributes

The following list of values are valid on the product entity.

Loan Purpose Options product.values.loan_purpose

Purchase
\n
Refinance - No Cash Out
\n
Refinance - Cash Out
\n
HELOC
\n
Home Equity Loan
\n
Reverse Mortgage
\n
Second Mortgage
\n
Construction Loan
\n
Other
\n
TBD
\n

Property Type Options product.values.property_type

Single-Family
\n
2-4 Unit
\n
Condo
\n
Co-op
\n
Manufactured Housing
\n
Planned Unit Development (PUD)
\n
Other
\n

Stage Names stage.name

NewLead
\n
ContactAttempted
\n
Engaged
\n
ApplicationStarted
\n
ApplicationSubmitted
\n
PreApproved
\n
InProcess
\n
Closed
\n

Occupancy product.values.occupancy

Primary Residence
\n
Second Home
\n
Investment
\n
Other
\n

Self Reported Credit Rating product.values.self_reported_credit_rating

Excellent
\n
Good
\n
Fair
\n
Poor
\n

Desired Timeframe product.values.desired_timeframe

Next 30 days
\n
3 months
\n
6 months
\n
6+ months
\n

Found Home/ Veteran / First Time Buyer found under product.values

Yes
\n
No
\n
Unknown
\n

Stage Id Mapping

1: New Lead

2: Contact Attempted

3: Engaged

4: Application Started

5: Application Submitted

6: Pre-Approved

7: In Process

8: Closed

Quick Examples

Create a Lead:

curl -X POST \"{{external_api_host}}/v1/lead-opportunities\" \\\n  -H \"Authorization: Bearer TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"first_name\":\"John\",\"last_name\":\"Doe\",\"source\":\"website\",\"email\":\"john@example.com\"}'\n\n

List with Filters:

curl \"{{external_api_host}}/v1/lead-opportunities?page[size]=10&filter=contact_id=456&sort=-created_at\" \\\n  -H \"Authorization: Bearer TOKEN\"\n\n

Update Assignment:

curl -X PATCH \"{{external_api_host}}/v1/lead-opportunities/{id}\" \\\n  -H \"Authorization: Bearer TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"contact_id\":456,\"assigned_user_id\":789}'\n\n

\n","_postman_id":"95a16720-fefb-4598-8bf0-e718d3c369d1"},{"name":"Custom Fields","item":[],"id":"e2c1510b-60df-4add-9d22-227d198dce7c","description":"

Interacting with the Custom Fields relationships.

Custom Fields cannot be accessed directly. For the several endpoints that can be related to custom fields, interacting with Custom Fields is similar to other relationships.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
description	No	string	Short description of the custom field.
field_name	No	string	System name (used as identifier) for the custom field.
value	Yes	mixed	Value of the custom field*.

*The value must match the specified data format used when creating the custom field definition.

As Relationships

This relationship is to be used through other entities that support custom fields. See the attributes list above for those that appear in GET responses.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Settable Fields	Description
custom	Custom Fields	field_name, value	Custom Field Values to add to the entity.

The 'field_name' field is used as the identifier in the context of the entity you are interacting with. For example, when interacting with a contact, the field_name is a unique identifier for contact entities and your organization.

Special POST/PATCH 'Value' Handling

Unlike other relationships, custom field values are deleted by setting the 'value' field to null. Note that there is no \"remove relationship\" for custom fields.

\n","event":[{"listen":"prerequest","script":{"id":"e9cf5f01-65dd-417c-92ca-b5a508816842","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"74536fc9-7e74-47c4-a38e-1efaff1cbc88","type":"text/javascript","exec":[""]}}],"_postman_id":"e2c1510b-60df-4add-9d22-227d198dce7c"},{"name":"Insight Endpoints","item":[{"name":"Insight Types","item":[{"name":"Fetch Insight Types","id":"b556588b-2ac6-455b-ad75-fdaa06fc2a03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/insight-types?page[number]=1&page[size]=10","description":"

Fetch a page of insight types. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","insight-types"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"},{"disabled":true,"key":"filter","value":"type=listings"}],"variable":[]}},"response":[],"_postman_id":"b556588b-2ac6-455b-ad75-fdaa06fc2a03"}],"id":"1db38283-5eba-47ef-9fda-b84d54673574","description":"

Endpoints for interacting with the Insight Types resource.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	numeric	Generated identifier for insight.
description	No	string	Description of the insight type.
expiration_interval	No	numeric	The default time (in seconds) before an insight of this type expires.
type	No	string	The unique system name for this insight type.
internal_created_at	No	string	Date of creation of this insight type in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'
internal_updated_at	No	string	Date of last change for this insight type in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'

Filtering

Use the 'filter=attribute_name=x,attribute_name_2=y' query to return the list of insight types that meet the filter criteria. For example, to filter insights by type 'property', the following query could be used:

/insight-types?filter=type=property

The supported filter attributes are shown in the following table.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
type	Type of insight type

","event":[{"listen":"prerequest","script":{"id":"5e8bc395-cfd1-49bd-8090-9e9b2d81495c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"582a16af-5e9b-426f-92df-bf4714a736a3","type":"text/javascript","exec":[""]}}],"_postman_id":"1db38283-5eba-47ef-9fda-b84d54673574"},{"name":"Insights","item":[{"name":"Fetch Insight","id":"759b1667-b9e2-4eed-8b6f-9bb1e6a93c4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/insights/{{insight_id}}","description":"

Fetch a specific insight specified by ID.

\n","urlObject":{"path":["v1","insights","{{insight_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"759b1667-b9e2-4eed-8b6f-9bb1e6a93c4d"},{"name":"Fetch Insights","id":"1c4dee1e-5565-497c-9d49-302bd9d24c5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/insights?page[number]=1&page[size]=10","description":"

Fetch a page of insights. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","insights"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"1c4dee1e-5565-497c-9d49-302bd9d24c5e"},{"name":"Create Insight (as Admin)","event":[{"listen":"test","script":{"id":"35788950-547d-4e37-aacb-63b17da28c73","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"contact_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"bd2a8932-de33-4eb8-b05b-7736d95ac93d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n\t\t\"description\": \"This insight is very insightful\"\n\t},\n\t\"insight_date\": \"2020-04-12 12:34:56\",\n\t\"owner\": {\n\t\t\"id\": 50\n\t},\n\t\"contact\": {\n\t\t\"id\": 451\n\t},\n\t\"type\": {\n\t\t\"id\": 7\n\t}\n}"},"url":"{{external_api_host}}/v1/insights","description":"

Create an Insight.

Required Relationships:

owner*
type
contact

*required if authenticated as an organization admin

\n","urlObject":{"path":["v1","insights"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bd2a8932-de33-4eb8-b05b-7736d95ac93d"},{"name":"Create Insight (as User)","event":[{"listen":"test","script":{"id":"836e39fa-d5eb-4d42-888f-498652d4b5e4","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"contact_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"18a18a94-ec7a-4be9-9f8e-ad6812fd73b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n\t\t\"description\": \"This insight is very insightful\"\n\t},\n\t\"insight_date\": \"2020-04-12 12:34:56\",\n\t\"contact\": {\n\t\t\"id\": 451\n\t},\n\t\"type\": {\n\t\t\"id\": 7\n\t}\n}"},"url":"{{external_api_host}}/v1/insights","description":"

Create an Insight.

Required Relationships:

type
contact

\n","urlObject":{"path":["v1","insights"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"18a18a94-ec7a-4be9-9f8e-ad6812fd73b1"}],"id":"76ff22f7-11b1-4db1-90a1-3e6ec9900227","description":"

Endpoints for interacting with the Insights resource.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	numeric	Generated identifier for insight.
data	Yes	object	Additional data pertaining to this insight.
expires_at	Yes	string	Date of expiration of this insight. Format: 'YYYY-MM-DD HH:mm:ss'
insight_date	Yes	string	Date of creation of this insight in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'
internal_updated_at	No	string	Date of last change for this insight in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'

Filtering

Use the 'filter=attribute_name=x,attribute_name_2=y' query to return the list of insight types that meet the filter criteria. For example, to filter insights by owner email, the following query could be used:

insights?filter=owner_email=test@test.com

The supported filter attributes are shown in the following table.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
owner_email	Insight owner email address
owner_id	Insight owner id
owner_external_id	Insight owner external id
type_id	Insight type id
contact_id	Contact id

Insight Data

Additional, unstructured data can be passed in through this field as applicable for your insight and insight type. Some integrations make use of this data, and may require a specific schema unless otherwise noted. We recommend passing a description key into this field at a minimum.

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
owner	Yes*	User	username, id, external_id	Owning user of the contact. One to many relationship, so returned as an object. *Only assignable/visible if authenticated as an organization admin.
contact	Yes	Contact	See contact documentation for uniqueness options.	Contact associated with this insight.
type	Yes	InsightType	id, type	Type of insight. See Insight Types documentation for more information.

","event":[{"listen":"prerequest","script":{"id":"d80df47b-d280-46dd-9771-62a0c581f4d0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6e08863b-d0ce-4cc0-b0ba-2d12c0e9b081","type":"text/javascript","exec":[""]}}],"_postman_id":"76ff22f7-11b1-4db1-90a1-3e6ec9900227"}],"id":"70f27fd7-40ae-45f8-9b0b-8c6841fdbcc1","description":"

With the Total Expert Insights API, you can provide insights from events occurring within your platform which can be leveraged to drive marketing automation in Total Expert. For example, a user downloading your mobile app could trigger an insight via our API called \"Mobile App Downloaded\" which would then trigger marketing automation that sends an email about all the features within the mobile app.

Advantages of Insights

Insights can be used to trigger a marketing automation flow within Total Expert.
Insights can be used to create a custom Focused View of contacts within Total Expert.

Insight Structure

To begin using insights through the API, you will need to coordinate with our team to create new insight types specific to your integration. Once these insight types are created, they can be used to create insights associated with any contact within TE (that you have access to).

Our standard naming convention for insight types is to prefix them with the integration partner’s name. For Example: “Lending Software: Loan application submitted”.

When submitting an insight for a contact you are able to provide a description within the insight that will show up within Total Expert. That area is freeform text and will not be formatted within Total Expert but is available to provide additional context around an insight.

\n","_postman_id":"70f27fd7-40ae-45f8-9b0b-8c6841fdbcc1"},{"name":"User Endpoints","item":[{"name":"Users","item":[{"name":"Fetch User","id":"1f7139f2-33e4-4cf2-b9d8-63692b31d1b7","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{external_api_host}}/v1/users/{{user_id}}","description":"

Fetch a specific user by ID.

\n","urlObject":{"path":["v1","users","{{user_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1f7139f2-33e4-4cf2-b9d8-63692b31d1b7"},{"name":"Fetch Users","id":"a2de5549-4e71-4656-bd3b-1e6d2b4e5618","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{external_api_host}}/v1/users?page[number]=1&page[size]=10","description":"

Fetch a page of users. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","users"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"a2de5549-4e71-4656-bd3b-1e6d2b4e5618"},{"name":"Create Users","id":"e6a13529-13ee-4b3f-a5d6-5877e0078307","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"email\": \"fred@example.com\",\r\n\t\"status\": 0,\r\n\t\"type\": \"Lender\",\r\n\t\"role\": {\r\n\t\t\"role_name\": \"Real Estate Lender\"\r\n\t},\r\n\t\"info\": {\r\n\t\t\"job_title\": \"Real Estate Loan Officer\",\r\n\t\t\"first_name\": \"Fred\",\r\n\t\t\"last_name\": \"Smith\",\r\n\t\t\"company\": \"Big Lender\",\r\n\t\t\"website\": \"http://biglender.com/freddy\",\r\n\t\t\"testimonial_url\": \"http://biglender.com/freddy/testimonials\",\r\n\t\t\"phone_cell\": \"612-100-200\",\r\n\t\t\"phone_fax\": \"612-300-400\",\r\n\t\t\"phone_office\": \"612-500-600\",\r\n\t\t\"address\": \"123 Main St.\",\r\n\t\t\"address_2\": \"Suite 1\",\r\n\t\t\"city\": \"Eden Prairie\",\r\n\t\t\"state\": \"MN\",\r\n\t\t\"zip_code\": \"55346\",\r\n\t\t\"cost_center\": \"18\",\r\n\t\t\"timezone_name\": \"America/Chicago\",\r\n\t\t\"location_id\": \"1\"\r\n\t},\r\n\t\"settings_marketing\": {\r\n\t\t\"agent_bio\": \"Freddy is a loan officer\",\r\n\t\t\"application_url\": \"apply.biglender.com\",\r\n\t\t\"disclaimer\": \"Freddy disclaimer text\",\r\n\t\t\"icon_one_img_url\": \"https://totalexpert.com/icon1.jpg\",\r\n\t\t\"icon_two_img_url\": \"https://totalexpert.com/icon2.jpg\",\r\n\t\t\"icon_three_img_url\": \"https://totalexpert.com/icon3.jpg\",\r\n\t\t\"logo_img_url\": \"https://totalexpert.com/freddy_logo.jpg\",\r\n\t\t\"license_title\": \"Bonafide loan officer\",\r\n\t\t\"profile_img_url\": \"https://totalexpert.com/freddy_profile.jpg\",\r\n\t\t\"short_name\": \"FreddyS\",\r\n\t\t\"social_facebook\": \"freddy.facebook.com\",\r\n\t\t\"social_twitter\": \"freddy.twitter.com\",\r\n\t\t\"social_google\": \"freddy.google.com\",\r\n\t\t\"social_linkedin\": \"freddy.linkedin.com\",\r\n\t\t\"daily_spend_threshold\": \"200\",\r\n\t\t\"user_quote\": \"Changing the world, one close at a time\",\r\n\t\t\"weekly_spend_threshold\": \"800\",\r\n\t\t\"wistia_id\": \"XYZ\"\r\n\t\t\r\n\t},\r\n\t\"expenditure_approver\": {\r\n\t\t\"username\": \"cadence\"\r\n\t},\r\n\t\"licenses\": [{\r\n\t\t\t\"license_name\": \"MN\",\r\n\t\t\t\"content\": \"LIC 12345\"\r\n\t\t}, {\r\n\t\t\t\"license_name\": \"IA\",\r\n\t\t\t\"content\": \"LIC 54321\"\r\n\t\t}\r\n\t],\r\n \"disclaimers\": [{\r\n \"disclaimer_name\": \"Flyer Disclaimer\",\r\n \"content\": \"Subject to change\",\r\n \"type\": {\r\n \"name\": \"Print Disclaimer\"\r\n }\r\n }, {\r\n \"disclaimer_name\": \"New Customer Email Disclaimer\",\r\n \"content\": \"Subject to change\",\r\n \"type\": {\r\n \"name\": \"Email Disclaimer\"\r\n }\r\n }],\r\n\t\"teams\": [{\r\n\t\t\t\"team_name\": \"Alice Sunny Team\",\r\n\t\t\t\"managers\": [{\r\n\t\t\t\t\t\"username\": \"alice\"\r\n\t\t\t\t}\r\n\t\t\t]\r\n\t\t}, {\r\n\t\t\t\"team_name\": \"Regional Team - West\",\r\n\t\t\t\"managers\": [{\r\n\t\t\t\t\t\"username\": \"grant\"\r\n\t\t\t\t}, {\r\n\t\t\t\t\t\"username\": \"dominic\"\r\n\t\t\t\t}\r\n\t\t\t]\r\n\t\t}\r\n\t]\r\n}"},"url":"{{external_api_host}}/v1/users","description":"

Create a user.

Required Attributes:

email
type

Required Relationships:

info
role

\n","urlObject":{"path":["v1","users"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e6a13529-13ee-4b3f-a5d6-5877e0078307"},{"name":"Update User","id":"c3dcb204-0cf3-4876-8225-6f2c65dc1f94","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"info\": {\r\n\t\t\"job_title\": \"Manager\"\r\n\t},\r\n\t\"settings_marketing\": {\r\n\t\t\"weekly_spend_threshold\":\"400\"\r\n\t},\r\n\t\"licenses\":[{\r\n\t\t\"license_name\":\"MN\",\r\n\t\t\"content\":\"LIC 12345\"\r\n\t\t} \r\n\t], \r\n\t\"remove_licenses\":[{\r\n\t\t\"license_name\":\"IA\", \r\n\t\t\"content\":\"LIC 54321\"\r\n\t\t} \r\n\t],\r\n \"disclaimers\": [{\r\n \"disclaimer_name\": \"Flyer Disclaimer\",\r\n \"content\": \"Subject to change\",\r\n \"type\": {\r\n \"name\": \"Print Disclaimer\"\r\n }\r\n }],\r\n \"remove_disclaimers\": [{\r\n \"disclaimer_name\": \"New Customer Email Disclaimer\",\r\n \"content\": \"Subject to change\",\r\n \"type\": {\r\n \"name\": \"Email Disclaimer\"\r\n }\r\n }],\r\n\t\"teams\":[\r\n\t\t{\r\n\t\t\t\"team_name\": \"Fred's Team\",\r\n\t\t\t\"managers\" : [{\"username\": \"freddy\"}]\r\n\t\t} \r\n\t], \r\n\t\"remove_teams\":[\r\n\t\t{\r\n\t\t\t\"team_name\": \"Alice Sunny's Team\", \r\n\t\t\t\"managers\" : [{\"username\": \"alice\"}] \r\n\t\t} \r\n\t]\r\n}"},"url":"{{external_api_host}}/v1/users/{{user_id}}","description":"

Update a user

\n","urlObject":{"path":["v1","users","{{user_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3dcb204-0cf3-4876-8225-6f2c65dc1f94"}],"id":"c39a3d8f-879f-4831-b1f0-61087d370aad","description":"

Endpoints for interacting with the users resource. These endpoints are restricted to organization admin users.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	numeric	Generated identifier for user.
email	Yes*	string	User's email address. *Cannot be modified after initial assignment.
external_id	Yes	string	User's external identifier.
info	Yes	object	Collection of user details. See the \"User Information Attributes\" table for available attributes.
internal_created_at	No	string	Date of creation of this user in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'
internal_updated_at	No	string	Date of last change for this user in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'
last_login_date	No	string	Date this user last logged into the TE system. Format: 'YYYY-MM-DD HH:mm:ss'
licenses	Yes	Array of objects	Collection of state user licenses. See the \"User Licenses Attributes\" table for available attributes.
disclaimers	Yes	Array of objects	Collection of disclaimers. See the \"User Disclaimers Attributes\" table for available attributes.
settings_marketing	Yes	object	Collection of user marketing settings. See the \"User Marketing Settings Attributes\" table for available attributes.
status	Yes	integer	0 - User is inactive. 1 - User is active. On user creation, if this is not provided, an active user is created.
type	Yes	string	One of: \"Realtor\", \"Lender\", \"Title\"
username	No	string	User's TE username. Read only. On user creation, this is generated from the user's email. For example, an email of \"John.Smith@totalexpert.com\" would create a username like \"john-smith-totalexpert####\", where none or up to four digits may be appended.
saml_subject_id	No	string	Custom subject ID for this user for SSO.

User Information Attributes

Field	Assignable	Type	Description
address	Yes	string	Street address portion of user's address.
address_2	Yes	string	Line 2 portion of user's address.
city	Yes	string	City portion of user's address.
state	Yes	string	State portion of user's address.
zip_code	Yes	string	Zip code portion of user's address.
first_name	Yes	string	User's first name.
last_name	Yes	string	User's last name.
phone_cell	Yes	string	User's cell phone number, preferred format: '(555)555-1234'
phone_office	Yes	string	User's office phone number, preferred format: '(555)555-1234'
phone_fax	Yes	string	User's fax number, preferred format: '(555)555-1234'
job_title	Yes	string	User's job title
cost_center	Yes	string	Value used for accounting purposes. Typically used by an organization to determine how a user is segmented for billing within the organization.
website	Yes	string	The user's homepage.
testimonial_url	Yes	string	Link to page (usually from user's website) that features testimonials about working with that user
timezone_name	Yes	string	The time zone the user operates in.
location_id	Yes	string
company	Yes	string	Employer of user

User Marketing Settings Attributes

Field	Assignable	Type	Description
agent_bio	Yes	string	User's professional bio
application_url	Yes	string	Link to Loan Officer's page where a contact can start a loan application
daily_spend_threshold	Yes	float	Dollar amount user is authorized to spend of their organization cost share per day
disclaimer	Yes	string	User's disclaimer text.
icon_one_img_url	Yes	string	Link to image (1) to import for use in specific marketing material.
icon_two_img_url	Yes	string	Link to image (2) to import for use in specific marketing material.
icon_three_img_url	Yes	string	Link to image (3) to import for use in specific marketing material.
license_title	Yes	string	User's license title.
logo_img_url	Yes	string	Link to image to import as the user's logo image.
profile_img_url	Yes	string	Link to image to import as the user's TE profile image.
short_name	Yes	string	User's short name which can be used for links in their email signatures
social_facebook	Yes	string	Link to personal or business page for the user on Facebook
social_google	Yes	string	Link to personal or business page for the user on Google
social_linkedin	Yes	string	Link to personal or business page for the user on LinkedIn
social_twitter	Yes	string	Link to personal or business page for the user on Twitter
user_quote	Yes	string	Secondary mission statement for the user. Used on specific marketing material.
weekly_spend_threshold	Yes	float	Dollar amount user is authorized to spend of their organization cost share per week
wistia_id	Yes	string	User's Wistia.com video identifier
post_close_survey_url	Yes	string	url for the user's post close survey

Acceptable formats for images (any of the *_img_url fields) are: jpeg, jpg, png, and gif. The domains which host the image URLs must be pre-registered with Total Expert.

User Disclaimer Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
disclaimer_name	Yes	string	Name of the disclaimer.
content	Yes	string	Content of the disclaimer.
type	Yes	object	Type of the disclaimer. Please see \"User Disclaimer Type Attributes\" table for available attributes.

User Disclaimer Type Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
name	Yes	string	Type of the disclaimer. The available types are 'Print Disclaimer', 'Web Disclaimer', 'Email Disclaimer', 'License Number', and 'Sub-Disclaimer'

User License Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
license_name	Yes	string	Name of license. For example, a U.S. state abbreviation.
content	Yes	string	Content of license. For example, the license number.

Uniqueness

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Fields
1	username
2	email
3	external_id

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
expenditure_approver	Yes	User	username, id, external_id, email	User responsible for approving overages on daily or weekly organization cost share threshold.
role	Yes	User Role	id, role_name	Role of the user.
teams	Yes	Team	id, team_name	Teams to add this user to. Array of Team objects.

Use a team's \"managers\" and \"remove_managers\" relationships to define the users managing a team. Alternatively, use the Teams endpoints to assign or remove team managers.

Special POST/PATCH Attributes

These attributes are used to manipulate the user but are neither user attributes or relationships. These attributes will not appear in responses.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Settable Fields	Description
remove_teams	Team	team_name, id	Teams to remove this user from. Array of team objects.
remove_licenses	License	license_name	Licenses to remove from this user. Array of license objects.
remove_disclaimers	Disclaimer	disclaimer_name, type	Disclaimers to remove from this user. Array of disclaimer objects.

Filtering

Use the 'filter=attribute_name=x,attribute_name_2=y' query to return the list of users that meet the filter criteria. For example, to filter users modified between Oct. 14, 2017 17:41:01 (UTC) and Oct. 15, 2017 17:41:09 (UTC), the following query could be used:

/users?filter=internal_updated_at_start=2017-10-14T17:41:01Z,internal_updated_at_end=2017-10-15T17:41:09Z

The supported filter attributes are shown in the following table.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
internal_updated_at_start	ISO-8601 formatted date. The start of the time range of interest, inclusive.
internal_updated_at_end	ISO-8601 formatted date. The end of the time range of interest, inclusive.
email	User's email address.
username	User's TE username.
status	Indicator of user's status.
external_id	User's external identifier.

","event":[{"listen":"prerequest","script":{"id":"51124e41-1756-40c4-89b2-9618add6a332","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"012d03ac-b977-4872-9cce-da022c93ef39","type":"text/javascript","exec":[""]}}],"_postman_id":"c39a3d8f-879f-4831-b1f0-61087d370aad"},{"name":"User Roles","item":[{"name":"Fetch User Roles","id":"e5742b49-d5c5-fe53-4269-b065efb0becd","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{external_api_host}}/v1/user-roles?page[number]=1&page[size]=10","description":"

Fetch a page of user roles. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","user-roles"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"e5742b49-d5c5-fe53-4269-b065efb0becd"},{"name":"Fetch User Role","id":"426eeaae-51e3-bae8-e6b5-c2a7af605894","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/user-roles/{{user_role_id}}","description":"

Fetch a specific user role specified by ID.

\n","urlObject":{"path":["v1","user-roles","{{user_role_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"426eeaae-51e3-bae8-e6b5-c2a7af605894"},{"name":"Fetch Permissions for User Role","id":"29a7cc5d-36cc-428e-b638-66327aaa030e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{external_api_host}}/v1/role-permissions/{{role_id}}","urlObject":{"path":["v1","role-permissions","{{role_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"29a7cc5d-36cc-428e-b638-66327aaa030e"}],"id":"718b1c1d-0f04-11ab-f728-9e9d38406030","description":"

Endpoints for interacting with the user roles resource. These endpoints are restricted to organization admin users.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	numeric	Generated identifier for role.
role_name	No	string	Name of role.

","_postman_id":"718b1c1d-0f04-11ab-f728-9e9d38406030"},{"name":"Teams","item":[{"name":"Fetch Team","id":"ae802814-6400-8c07-a35f-eac7513859b2","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{external_api_host}}/v1/teams/{{team_id}}","description":"

Fetch a team by ID.

\n","urlObject":{"path":["v1","teams","{{team_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ae802814-6400-8c07-a35f-eac7513859b2"},{"name":"Fetch Teams","id":"cf1cc2ee-5b52-9d0c-8c16-1feddbcd4af5","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{external_api_host}}/v1/teams?page[number]=1&page[size]=10","description":"

Fetch a page of teams. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","teams"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"cf1cc2ee-5b52-9d0c-8c16-1feddbcd4af5"},{"name":"Create Team","id":"3326cb26-0a21-92b6-7ffb-0eb1765676be","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"team_name\": \"Harry N's Team\",\n \"managers\": [\n {\n \"username\": \"harryn\"\n },\n {\n \"username\": \"rickyg\"\n }\n ]\n}"},"url":"{{external_api_host}}/v1/teams","description":"

Create a Team.

Required Attributes:

team_name

\n","urlObject":{"path":["v1","teams"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3326cb26-0a21-92b6-7ffb-0eb1765676be"},{"name":"Update Team","id":"4c6b35ae-1fcd-c0f3-7985-86dd2defb320","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"remove_managers\": [\n {\n \"username\": \"rickyg\"\n }\n ]\n}"},"url":"{{external_api_host}}/v1/teams/{{team_id}}","description":"

Update an existing team by ID.

\n","urlObject":{"path":["v1","teams","{{team_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c6b35ae-1fcd-c0f3-7985-86dd2defb320"},{"name":"Delete Team","id":"1084f814-8a0d-be59-20fb-709f22fa4d7d","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{external_api_host}}/v1/teams/{{team_id}}","description":"

Deletes a team by ID.

\n","urlObject":{"path":["v1","teams","{{team_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1084f814-8a0d-be59-20fb-709f22fa4d7d"}],"id":"14222a06-cb03-1b70-4f41-71ab26f6a128","description":"

Endpoints for interacting with the teams resource.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	numeric	Generated identifier for team.
team_name	Yes	string	Name of the team.

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
managers	Yes	User	username, id, external_id, email	Managers of the team. Many-to-many relationship, so returned as an array.

Special POST/PATCH Attributes

These attributes are used to manipulate the team but are neither team attributes or relationships. These attributes will not appear in responses.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Settable Fields	Description
remove_managers	User	username, id, external_id, email	Users to remove as managers. Array of User objects. These users will not be removed from the team (this must be done through the Users endpoints).

","event":[{"listen":"prerequest","script":{"id":"80e840db-ae83-4502-8fe5-5c90cc1c4a64","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b23486b3-abd9-45e0-813b-2e8221764ec6","type":"text/javascript","exec":[""]}}],"_postman_id":"14222a06-cb03-1b70-4f41-71ab26f6a128"},{"name":"Permissions","item":[{"name":"Fetch Permissions","id":"7ab2acc5-f74f-4a32-8ec9-09255e1fcd8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{external_api_host}}/v1/permissions?page[number]=1&page[size]=10","urlObject":{"path":["v1","permissions"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"7ab2acc5-f74f-4a32-8ec9-09255e1fcd8e"},{"name":"Fetch Permission","id":"b8ed0856-1973-4db6-9936-1d665d4e4b7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{external_api_host}}/v1/permissions/{{permission_id}}","urlObject":{"path":["v1","permissions","{{permission_id}}"],"host":["{{external_api_host}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"b8ed0856-1973-4db6-9936-1d665d4e4b7a"}],"id":"f3745292-8661-45cc-b079-9ab0439b0671","_postman_id":"f3745292-8661-45cc-b079-9ab0439b0671","description":""}],"id":"cadf999c-2dac-48d1-972d-b0e5af0ea72b","_postman_id":"cadf999c-2dac-48d1-972d-b0e5af0ea72b","description":""},{"name":"Entities","item":[{"name":"Fetch Entity","id":"e8e0d036-4c1f-4922-a7b2-cc7529ef72e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/entities/{{entity_id}}","description":"

Fetch a specific entity specified by ID.

\n","urlObject":{"path":["v1","entities","{{entity_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e8e0d036-4c1f-4922-a7b2-cc7529ef72e1"},{"name":"Fetch Entities","id":"cc0b51ad-2422-492c-9661-bc2ea6375f73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/entities?page[number]=1&page[size]=10","description":"

Fetch a page of entities. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","entities"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"cc0b51ad-2422-492c-9661-bc2ea6375f73"},{"name":"Fetch Entity Relationship Types","id":"db9c777c-7802-4d1a-a0b6-7b3463f17421","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/entity-relationship-types?page[number]=1&page[size]=10","description":"

Fetch a page of entities. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","entity-relationship-types"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"db9c777c-7802-4d1a-a0b6-7b3463f17421"},{"name":"Create Entity (as Admin)","event":[{"listen":"test","script":{"id":"2b249af8-ba41-4a84-8a00-5e56ebc49eea","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"contact_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"b3f43503-deb0-4d4f-a8e5-f719dce8f331","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"entity_name\": \"Squiggle Whomp Household\",\n \"entity_type\": {\n \"system_name\": \"household\"\n },\n \"related_entities\": [\n {\n \t\"relationship_type\": {\n \t\t\"system_name\": \"members\"\n \t},\n \t\"children\": [\n \t\t{\n \t\t\t\"external_id\": \"abcd1234\"\n \t\t}\n \t]\n }\n ],\n \"custom\": [\n {\n \"field_name\": \"gold_star_string\",\n \"value\": \"value\"\n }\n ]\n}"},"url":"{{external_api_host}}/v1/entities","description":"

Create an entity.

\n","urlObject":{"path":["v1","entities"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3f43503-deb0-4d4f-a8e5-f719dce8f331"},{"name":"Update Entity","id":"58d56f99-5ce1-413b-842d-6a882a81e703","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"phone\": \"5558675309\"\n}"},"url":"{{external_api_host}}/v1/entities/{{entity_id}}","description":"

Update an existing entity by ID.

\n","urlObject":{"path":["v1","entities","{{entity_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"58d56f99-5ce1-413b-842d-6a882a81e703"},{"name":"Delete Entity","id":"2acfdf84-1589-4729-b773-2ccdbe029d6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{external_api_host}}/v1/entities/{{entity_id}}","description":"

Delete an entity by ID.

\n","urlObject":{"path":["v1","entities","{{entity_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2acfdf84-1589-4729-b773-2ccdbe029d6f"}],"id":"1036d088-04eb-4492-8fbc-399c7a1ed2ee","description":"

Endpoints for interacting with the entities resource. These endpoints are restricted to organization admin users.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	string	Generated identifier for entity.
address	Yes	string	Street address portion of entity's address.
address_2	Yes	string	Line 2 portion of entity's address.
city	Yes	string	City portion of entity's address.
entity_name	Yes	string	Name of the entity.
external_id	Yes	string	entity's external identifier, e.g. the unique identifier from the entity's source.
state	Yes	string	State portion of entity's address.
zip_code	Yes	string	Zip code portion of entity's address.
phone	Yes	string	Entity's phone number, preferred format: '(555)555-1234'
internal_created_at	No	string	Date of creation of this entity in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'
internal_updated_at	No	string	Date of last change for this entity in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'

Relationships

Some relationship types are discrete and can only have one child.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
owner	Yes*	User	username, id, external_id, email	Owning user of the entity. One to many relationship, so returned as an object. *Only assignable/visible if authenticated as an organization admin.
entity_type	Yes	Entity Type	system_name	Type for this entity. Many-to-one relationship, is returned as an object.
related_entities	Yes	*	*	*(See Related Entities Relationships Section, below)
custom	Yes	Custom Field	*(See Custom Fields)	*(See Custom Fields)

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
relationship_type	Yes	Entity Relationship Type	system_name	The type of relationship to the target contacts.
children	Yes	Contacts	*	*(See contact documentation)

Special POST/PATCH Attributes - depending on posting endpoint

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
children	Yes	Contacts	*	*(See contact documentation) - available when posting inside an entity
parent	Yes	Entity	*	*(See entity resource documentation, above) - Only available when posting inside a contact

Special POST/PATCH Attributes

These attributes are used to manipulate the entity but are neither entity attributes or relationships. These attributes will not appear in responses.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Settable Fields	Description
remove_related_entities	*	*	*(See Related Entities Relationships Section, above, to dissociate related entities)

Sorting

Use the 'sort=attribute_name,attribute_name_2' query to return the list of entities sorted by the given attribute. Use a minus sign in front of the attribute name to sort the results in descending order. For example, to sort by the internal_updated_at attribute and place the results in descending order, the URL would include:

/entities?sort=-internal_updated_at

The sort query supports the attributes listed in the Attributes table. The query does not support sorting by relationship values.

\n","event":[{"listen":"prerequest","script":{"id":"0879f709-90f6-4621-99ba-86b46fcd513b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"138dd6f4-de3a-4c3b-9987-d17bdff13e29","type":"text/javascript","exec":[""]}}],"_postman_id":"1036d088-04eb-4492-8fbc-399c7a1ed2ee"},{"name":"Loan Endpoints","item":[{"name":"Loans","item":[{"name":"Fetch Loan","id":"3c0895bb-69a0-9e0f-233d-22ab4ff1f7d5","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{external_api_host}}/v1/loans/{{loan_id}}","description":"

Fetch a specific loan type specified by ID.

\n","urlObject":{"path":["v1","loans","{{loan_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3c0895bb-69a0-9e0f-233d-22ab4ff1f7d5"},{"name":"Fetch Loans","id":"f885ca4f-43f0-6c61-351c-d7e3d121b5ce","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{external_api_host}}/v1/loans?page[number]=1&page[size]=10","description":"

Fetch a page of loans. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","loans"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"f885ca4f-43f0-6c61-351c-d7e3d121b5ce"},{"name":"Create Loan (as Admin)","event":[{"listen":"test","script":{"id":"7e3bddc1-691b-4543-9873-f61b27805927","exec":[""],"type":"text/javascript"}}],"id":"cddb67e8-0ee9-ed03-d7a4-d6bd34b0f6f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"2161010\",\r\n \"loan_number\": \"2161010\",\r\n \"address\": \"446 Second St\",\r\n \"address_2\": null,\r\n \"city\": \"Middlesex\",\r\n \"state\": \"NJ\",\r\n \"zip_code\": \"08846\",\r\n \"owner\": {\r\n \"username\": \"jsmith\"\r\n },\r\n \"borrower\": {\r\n \"source\": \"PCLender\",\r\n \"first_name\": \"Jenny\",\r\n \"last_name\": \"Kristoff\",\r\n \"email\": \"jennyK@example.com\",\r\n \"custom\": [\r\n {\r\n \"field_name\": \"custom_string\",\r\n \"value\": \"the custom field string value\"\r\n }\r\n ]\r\n },\r\n \"coborrower\": {\r\n \"source\": \"PCLender\",\r\n \"first_name\": \"Anthony\",\r\n \"last_name\": \"Kristoff\",\r\n \"email\": \"anthonyK@example.com\"\r\n },\r\n \"loan_program\": {\r\n \"loan_program\": \"10-year Fixed\"\r\n },\r\n \"loan_purpose\": {\r\n \"loan_purpose\": \"Refinance\"\r\n },\r\n \"loan_status\": {\r\n \"loan_status\": \"Pending\"\r\n },\r\n \"loan_type\": {\r\n \"loan_type\": \"Conventional Fixed Rate\"\r\n },\r\n \"loan_subordinate_financing_type\": {\r\n \"loan_subordinate_financing_type\": \"HELOC\"\r\n },\r\n \"buyers_agent\": {\r\n \"source\": \"PCLender\",\r\n \"first_name\": \"Jay\",\r\n \"last_name\": \"Jenkel\",\r\n \"email\": \"jagent@example.com\"\r\n },\r\n \"sellers_agent\": {\r\n \"source\": \"PCLender\",\r\n \"first_name\": \"Fred\",\r\n \"last_name\": \"Ingle\",\r\n \"email\": \"fseller@example.com\"\r\n },\r\n \"settlement_agent\": {\r\n \"source\": \"PCLender\",\r\n \"first_name\": \"Angie\",\r\n \"last_name\": \"Deedle\",\r\n \"email\": \"asettlement@example.com\"\r\n },\r\n \"account_class\": {\r\n \"class_name\": \"mortgage\",\r\n \"class_type\": \"LOAN\"\r\n },\r\n \"custom\": [\r\n {\r\n \"field_name\": \"custom_string\",\r\n \"value\": \"the custom field string value\"\r\n }\r\n ]\r\n}"},"url":"{{external_api_host}}/v1/loans","description":"

Create a loan.

Required Attributes:

external_id

Required Relationships:

owner
borrower
- Must have required fields for contact creation, found here: Create Contact (as Admin)
\n
any other required loan participant roles, which can be found using the Fetch Loan Participant Roles request (requires describeSchema scope to access)

\n","urlObject":{"path":["v1","loans"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cddb67e8-0ee9-ed03-d7a4-d6bd34b0f6f3"},{"name":"Create Loan (as User)","event":[{"listen":"test","script":{"id":"5789e5d3-a6f0-46d5-a49e-6e222d77f7ee","exec":[""],"type":"text/javascript"}}],"id":"a174df6c-c694-3dc1-7cf7-926bf2cf55b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"2161006\",\n \"loan_number\": \"2161006\",\n \"loan_rate\": \"4.00\",\n \"loan_term\": 360,\n \"loan_application_number\": null,\n \"purchase_price\": null,\n \"appraised_value\": \"450000.00\",\n \"is_first_time_buyer\": 0,\n \"property_type\": null,\n \"address\": \"446 Second St\",\n \"address_2\": null,\n \"city\": \"Middlesex\",\n \"state\": \"NJ\",\n \"zip_code\": \"08846\",\n \"loan_name\": null,\n \"pre_approval_issued\": null,\n \"loan_amount\": \"357904.00\",\n \"loan_to_value_combined\": \"86.24\",\n \"occupancy_type\": \"Owner\",\n \"estimated_value\": null,\n \"lock_status\": \"Locked\",\n \"escrow_waived\": 0,\n \"referral_source\": null,\n \"annual_review_date\": null,\n \"application_date\": \"2016-07-27 00:00:00\",\n \"appraisal_expected_date\": null,\n \"appraisal_ordered_date\": \"2017-04-21 00:00:00\",\n \"appraisal_received_date\": \"2017-04-28 00:00:00\",\n \"approval_date\": null,\n \"closing_date\": \"2017-05-19 00:00:00\",\n \"created_date\": \"2017-06-06 15:51:19\",\n \"ctc_date\": null,\n \"documents_signed_date\": null,\n \"epo_date\": null,\n \"last_modified_date\": \"2017-05-15 06:55:00\",\n \"first_payment_date\": \"2017-06-01 00:00:00\",\n \"funded_date\": null,\n \"loan_arm_expiration_date\": null,\n \"lock_date\": \"2017-04-26 00:00:00\",\n \"lock_expiration_date\": \"2017-05-25 00:00:00\",\n \"pre_approval_expiration_date\": null,\n \"pre_approval_issued_date\": null,\n \"processing_start_date\": \"2016-08-05 00:00:00\",\n \"underwriting_approval_date\": null,\n \"underwriting_submission_date\": \"2016-08-02 00:00:00\",\n \"internal_created_at\": \"2017-06-06 15:51:19\",\n \"internal_updated_at\": \"2017-06-06 15:51:20\",\n \"borrower\": {\n \"id\": 502\n },\n \"coborrower\": {\n \"id\": 502\n },\n \"loan_program\": {\n \"loan_program\": \"30-year Fixed\"\n },\n \"loan_purpose\": {\n \"loan_purpose\": \"New\"\n },\n \"loan_status\": {\n \"loan_status\": \"In review\"\n },\n \"loan_type\": {\n \"loan_type\": \"Conventional Fixed Rate\"\n },\n \"loan_subordinate_financing_type\": {\n \"loan_subordinate_financing_type\": \"HELOC\"\n },\n \"account_class\": {\n \"class_name\": \"mortgage\",\n \"class_type\": \"LOAN\"\n },\n \"custom\": [\n {\n \"field_name\": \"custom_string\",\n \"value\": \"the custom field string value\"\n }\n ]\n}"},"url":"{{external_api_host}}/v1/loans","description":"

Create a loan.

Required Attributes:

external_id

Required Relationships:

borrower
- Must have required fields for contact creation, found here: Create Contact (as User)
\n
any other required loan participant roles, which can be found using the Fetch Loan Participant Roles request (requires describeSchema scope to access)

\n","urlObject":{"path":["v1","loans"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a174df6c-c694-3dc1-7cf7-926bf2cf55b8"},{"name":"Update Loan ","id":"8eff5898-6ccb-8840-cd94-6d6d0a3bd307","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"2161006\",\n \"loan_number\": \"2161006\",\n \"loan_rate\": \"4.00\",\n \"loan_term\": 360,\n \"loan_application_number\": null,\n \"purchase_price\": null,\n \"appraised_value\": \"450000.00\",\n \"is_first_time_buyer\": 0,\n \"property_type\": null,\n \"address\": \"446 Second St\",\n \"address_2\": null,\n \"city\": \"Middlesex\",\n \"state\": \"NJ\",\n \"zip_code\": 8846,\n \"loan_name\": null,\n \"pre_approval_issued\": null,\n \"loan_amount\": \"357904.00\",\n \"loan_to_value_combined\": \"86.24\",\n \"occupancy_type\": \"Owner\",\n \"estimated_value\": null,\n \"lock_status\": \"Locked\",\n \"escrow_waived\": 0,\n \"referral_source\": null,\n \"annual_review_date\": null,\n \"application_date\": \"2016-07-27 00:00:00\",\n \"appraisal_expected_date\": null,\n \"appraisal_ordered_date\": \"2017-04-21 00:00:00\",\n \"appraisal_received_date\": \"2017-04-28 00:00:00\",\n \"approval_date\": null,\n \"closing_date\": \"2017-05-19 00:00:00\",\n \"created_date\": \"2017-06-06 15:51:19\",\n \"ctc_date\": null,\n \"documents_signed_date\": null,\n \"epo_date\": null,\n \"last_modified_date\": \"2017-05-15 06:55:00\",\n \"first_payment_date\": \"2017-06-01 00:00:00\",\n \"funded_date\": null,\n \"loan_arm_expiration_date\": null,\n \"lock_date\": \"2017-04-26 00:00:00\",\n \"lock_expiration_date\": \"2017-05-25 00:00:00\",\n \"pre_approval_expiration_date\": null,\n \"pre_approval_issued_date\": null,\n \"processing_start_date\": \"2016-08-05 00:00:00\",\n \"underwriting_approval_date\": null,\n \"underwriting_submission_date\": \"2016-08-02 00:00:00\",\n \"internal_created_at\": \"2017-06-06 15:51:19\",\n \"internal_updated_at\": \"2017-06-06 15:51:20\",\n \"coborrower\": {\n \"id\": 1186\n },\n \"loan_program\": {\n \"loan_program\": \"30-year Fixed\"\n },\n \"loan_purpose\": {\n \"loan_purpose\": \"New\"\n },\n \"loan_status\": {\n \"loan_status\": \"In review\"\n },\n \"loan_type\": {\n \"loan_type\": \"Conventional Fixed Rate\"\n },\n \"account_class\": {\n \t\"class_name\": \"mortgage\",\n \t\"class_type\": \"LOAN\"\n }\n}"},"url":"{{external_api_host}}/v1/loans/{{loan_id}}","description":"

Update an existing loan by ID.

\n","urlObject":{"path":["v1","loans","{{loan_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8eff5898-6ccb-8840-cd94-6d6d0a3bd307"},{"name":"Delete Loan","id":"d2bd4af8-36ba-18dd-21ab-65f59b741be9","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{external_api_host}}/v1/loans/{{loan_id}}","description":"

Deletes a loan by ID.

\n","urlObject":{"path":["v1","loans","{{loan_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d2bd4af8-36ba-18dd-21ab-65f59b741be9"}],"id":"ec243dd9-e4e4-a203-d4f7-536db0b2f3e0","description":"

Endpoints for interacting with the loans resource.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	numeric	generated identifier for loan.
address	Yes	string	street address portion of the property
address_2	Yes	string	second line of the address of the property
amort_type	Yes	string	type of loan repayment mechanism
amort_type_arm_desc	yes	string	type of ARM amortization
annual_review_date	Yes	string	date of annual review for the loan, formatted as a date with 1970 as the year. Preferred format: '1970-MM-DD'
application_date	Yes	string	date/time of the application for the loan. Preferred format: 'YYYY-MM-DD HH:mm:ss'
appraised_value	Yes	string	appraised value of the property
appraisal_expected_date	Yes	string	expected date/time of the appraisal. Preferred format: 'YYYY-MM-DD HH:mm:ss'
appraisal_ordered_date	Yes	string	date/time when the appraisal was ordered. Preferred format: 'YYYY-MM-DD HH:mm:ss'
appraisal_received_date	Yes	string	date/time when the appraisal was received. Preferred format: 'YYYY-MM-DD HH:mm:ss'
approval_date	Yes	string	date/time the loan was approved. Preferred format: 'YYYY-MM-DD HH:mm:ss'
audits_date	Yes	string	date/time auditor finished preparing loan for shipping. Preferred format: 'YYYY-MM-DD HH:mm:ss'
available_line_amount	Yes	string	Dollar available line amount
borrower_entity_type	Yes	string	Type of Borrower Entity
business_partner	Yes	string	Business Partner
buydown_points	Yes	numeric	Mortgage/discount points applied to the loan
channel	Yes	string	Channel
city	Yes	string	city portion of the address of the property
closing_date	Yes	string	date/time of the closing for the loan. Preferred format: 'YYYY-MM-DD HH:mm:ss'
closing_date_estimated	Yes	string	estimated date/time of the closing for the loan. Preferred format: 'YYYY-MM-DD HH:mm:ss'
completion_date	Yes	String	Date mortgage is completed and funds are disbursed. Preferred format: 'YYYY-MM-DD HH:mm:ss'
closing_disclosure_out_date	Yes	string	Date the signed closing documents were issued to the buyer
closing_disclosure_signed_date	Yes	string	Date the signed closing documents were received from the buyer
county	Yes	string	County containing property
created_date	Yes	string	date/time the loan was created. Preferred format: 'YYYY-MM-DD HH:mm:ss'
credit_report_date	Yes	string	Date of the credit report
ctc_date	Yes	string	date/time of the loan clear-to-close. Preferred format: 'YYYY-MM-DD HH:mm:ss'
debt_to_income	Yes	string	Debt to income ratio (float value)
docs_out_date	Yes	string	the date in which documents required by federal law and contract were sent to the borrower/co-borrower. Preferred format: 'YYYY-MM-DD HH:mm:ss'
documents_signed_date	Yes	string	date/time the documents were signed. Preferred format: 'YYYY-MM-DD HH:mm:ss'
epo_date	Yes	string	date/time of the loan early payoff. Preferred format: 'YYYY-MM-DD HH:mm:ss'
escrow_waived	Yes	numeric	Indicator whether escrow has been waived
estimated_value	Yes	string	estimated value of the property
external_id	Yes	string	ID of loan in source system
first_payment_date	Yes	string	date/time of the first payment for the loan. Preferred format: 'YYYY-MM-DD HH:mm:ss'
funded_date	Yes	string	date/time the funds were released. Preferred format: 'YYYY-MM-DD HH:mm:ss'
funding_date	Yes	string	anticipated date/time funds are to be released. Preferred format: 'YYYY-MM-DD HH:mm:ss'
funds_requested_date	Yes	string	date/time funds were requested. Preferred format: 'YYYY-MM-DD HH:mm:ss'
guarantee_type	Yes	string	Guarantee Type
internal_created_at	No	string	date of creation of this contact in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'
internal_updated_at	No	string	date of last change for this contact in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'
investor	Yes	string	Name of the entity that has purchased this loan on the secondary market
is_first_time_buyer	Yes	numeric	indicator whether the borrower is a first time borrower. 1=yes, 0=no.
last_modified_date	Yes	string	date/time the loan was last modified. Preferred format: 'YYYY-MM-DD HH:mm:ss'
legal_entity_name	Yes	string	Legal Entity Name
lender_paid_compensation	Yes	string	Dollar amount of lender paid compensation
lien_position	Yes	string	order of priority for the loan payment in the event of default
line_amount	Yes	string	Dollar line amount
loan_amount	Yes	string	loan amount
loan_application_number	Yes	string	loan application number
loan_arm_expiration_date	Yes	string	date/time the ARM expires for the loan. Preferred format: 'YYYY-MM-DD HH:mm:ss'
loan_name	Yes	string	name for the loan
loan_number	Yes	string	loan number
loan_rate	Yes	string	loan rate
lock_status	Yes	string	lock status for the loan
loan_term	Yes	numeric	loan term (in months)
loan_to_value_combined	Yes	string	percentage ratio of loan amount to purchase price, including all loans on the property.
loan_to_value	Yes	string	percentage ratio of loan amount to purchase price
lock_date	Yes	string	date/time the loan was locked. Preferred format: 'YYYY-MM-DD HH:mm:ss'
lock_expiration_date	Yes	string	date/time the loan lock expires. Preferred format: 'YYYY-MM-DD HH:mm:ss'
occupancy_type	Yes	string	occupancy type of the property (e.g. Owner)
origination_fee	Yes	string	Dollar amount of origination fee
master_loc_number	Yes	string	LOC number. Applies to LOC-P loans.
max_acquisition_ltc	Yes	string	Maximum acquistion loan-to-cost
max_ltv	Yes	string	Maximum loan-to-value
max_rehab_ltc	Yes	string	Maximum rehab loan-to-cost
monthly_pi_payment	Yes	numeric	Dollar amount of monthly payment
monthly_pi_with_mi_payment	Yes	numeric	Dollar amount of monthly payment
pre_approval_expiration_date	Yes	string	date/time the pre-approval expires for the loan. Preferred format: 'YYYY-MM-DD HH:mm:ss'
pre_approval_issued	Yes	numeric	indicator whether a pre-approval was issued for this loan. 1=yes, 0=no.
pre_approval_issued_date	Yes	string	date/time the pre-approval was issued for the loan. Preferred format: 'YYYY-MM-DD HH:mm:ss'
pricing_option	Yes	string	Pricing Option
processing_start_date	Yes	string	date/time processing began for the loan. Preferred format: 'YYYY-MM-DD HH:mm:ss'
property_type	Yes	string	type of property (e.g. Single Family)
post_closed_date	Yes	string	date mortgage is completed and funds are disbursed. Preferred format: 'YYYY-MM-DD HH:mm:ss'
purchased_date	Yes	string	date/time purchase occurred. Preferred format: 'YYYY-MM-DD HH:mm:ss'
purchase_price	Yes	string	purchase price for the loan
referral_source	Yes	string	the source of the referral
resubmittal_date	Yes	string	date/time of file is returned to underwriting after rejection. Preferred format: 'YYYY-MM-DD HH:mm:ss'
source	Yes	string	The internal business channel or cost center a loan originated from
state	Yes	string	state portion of the address of the property
underwriting_approval_date	Yes	string	date/time underwriting was approved for the loan. Preferred format: 'YYYY-MM-DD HH:mm:ss'
underwriting_submission_date	Yes	string	date/time the loan was submitted for underwriting
zip_code	Yes	string	zip code portion of the address of the property
pre_approval_issues	Yes	string	Pre approval issues
denial_reason	Yes	string	Denial reason

Uniqueness

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Fields
1	external_id
2	loan_number

Filtering

Use the 'filter=attribute_name=x,attribute_name_2=y' query to return the list of loans that meet the filter criteria. For example, to filter loans modified between Oct. 14, 2017 17:41:01 (UTC) and Oct. 15, 2017 17:41:09 (UTC), sorted by the internal_updated_at attribute in ascending order, the following query could be used:

/loans?sort=internal_updated_at&filter=internal_updated_at_start=2017-10-14T17:41:01Z,internal_updated_at_end=2017-10-15T17:41:09Z

The supported filter attributes are shown in the following table.

Field	Description
internal_updated_at_start	ISO-8601 formatted date. The start of the time range of interest, inclusive.
internal_updated_at_end	ISO-8601 formatted date. The end of the time range of interest, inclusive.
internal_created_at_start	ISO-8601 formatted date. The start of the time range of interest, inclusive.
internal_created_at_end	ISO-8601 formatted date. The end of the time range of interest, inclusive.
owner_id	TE ID of the owning user.
owner_email	Email of the owning user.
owner_username	Username of the owning user.
owner_external_id	External ID of the owning user.
external_id	External ID of the loan.
loan_number	Loan number of loan.
borrower_id	Id of the borrower.
role_system_name	Role system name for the loan participant.
agent_id	ID of the agent participant on the loan.
other_id	ID of the other participant on the loan.
account_class_name	Account Classification Name for the loan.
account_class_type	Account class type for the loan.
loan_type	Type of the loan.
loan_status	Status of the loan.
loan_program	Program of the loan.
loan_purpose	Purpose of the loan.
loan_name_contains	Loan Name for the loan contains the specified string.
funded_date_start	Loan Funded Date
funded_date_end	Loan Funded Date (requires funded_date_start filter)

Relationships

Relationship	Assignable	Type	Settable Fields	Description
owner	Yes*	User	username, id, external_id, email	Owning loan officer for the loan. Many-to-one relationship, so returned as an object. *Only assignable/visible if authenticated as an organization admin.
referring_loan_officer	Yes	User	username, id, external_id	Loan officer who referred the loan. Many-to-one relationship, so returned as an object.
borrower	Yes	contact	See contact documentation for uniqueness options.	Primary borrower for the loan. Many-to-one relationship, so returned as an object.
coborrower	Yes	contact	See contact documentation for uniqueness options.	Co-borrower for the loan. Many-to-one relationship, so returned as an object.
buyers_agent	Yes	contact	See contact documentation for uniqueness options.	Buyer's agent for the loan. Many-to-one relationship, so returned as an object.
sellers_agent	Yes	contact	See contact documentation for uniqueness options.	Seller's agent for the loan. Many-to-one relationship, so returned as an object.
settlement_agent	Yes	contact	See contact documentation for uniqueness options.	Settlement agent for the loan. Many-to-one relationship, so returned as an object.
attorney	Yes	contact	See contact documentation for uniqueness options.	Attorney for the loan. Many-to-one relationship, so returned as an object.
loan_program	Yes	loan-program	id	Program for this loan. Many-to-one relationship, so returned as an object.
loan_purpose	Yes	loan-purpose	id	Purpose for this loan. Many-to-one relationship, so returned as an object.
loan_status	Yes	loan-status	id	Status for this loan. Many-to-one relationship, so returned as an object.
loan_type	Yes	loan-type	id	Type for this loan. Many-to-one relationship, so returned as an object.
loan_subordinate_financing_type	Yes	subordinate-financing-type	subordinate_financing_type	Subordinate financing type for this loan. Many-to-one relationship, so returned as an object.
account_class	Yes	account class	class_name and class_type	Classification of the loan (example: a mortgage). Must match an existing account class. Not required for loans which are mortgages.
custom	Yes	Custom Field	*(See Custom Fields)	*(See Custom Fields)

Subordinate Financing Type Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
subordinate_financing_type	string	The financing / loan type for loans in the secondary lien position. E.g. 'HELOC'

Special POST/PATCH Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Settable Fields	Description
options	Object	See below table.	Options to apply to the request.

POST/PATCH Options

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description	Default Value
suppress_emails	boolean	Whether to suppress auto-campaign emails that would be sent as a direct result of this request. WARNING: Using this option has consequences. Do not use this option before talking with your TE integration consultant.	False

Transferring Loan Ownership

Admin users may transfer loans from one loan officer to another in their organization by changing a loan's 'owner' relationship. This operation can be accomplished through either a POST or a PATCH request. If a POST request is used, the POST body must include the loan's 'id' attribute, otherwise the request is interpreted as a request to create a new loan instead of transferring an existing one.

As part of the loan ownership transfer, contacts for the borrower, co-borrower, and agents are created for the new owner if the new owner does not have them as existing contacts. Existing contacts are detected using the uniqueness constraints documented for the Contacts endpoint. Newly created contacts do not belong to any contact group. The contacts associated with the previous owner remain in the system but are disassociated from the loan.

In the case that the new owner has an existing loan that matches the uniqueness constraints of the loan being transferred, the ownership transfer will fail and return a 422 (Unprocessable Entity) HTTP status code.

Account Classification

Account classifications will allow you to create or update a resource's classification type.
Account classifications are not required. If no classification is provided the loan will be assumed to be a mortgage.
Currently only mortgages are visible/actionable within the CRM

\n","event":[{"listen":"prerequest","script":{"id":"bac3ac72-6b8a-4fcb-a96d-72be313970cd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ebd4969e-f36c-428f-af9b-46fbacc13006","type":"text/javascript","exec":[""]}}],"_postman_id":"ec243dd9-e4e4-a203-d4f7-536db0b2f3e0"},{"name":"Loan Types","item":[{"name":"Fetch Loan Type","id":"2f5b0ec7-6dea-077a-291d-368fdbd7bbde","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{external_api_host}}/v1/loan-types/{{type_id}}","description":"

Fetch a specific loan type specified by ID.

\n","urlObject":{"path":["v1","loan-types","{{type_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2f5b0ec7-6dea-077a-291d-368fdbd7bbde"},{"name":"Fetch Loan Types","id":"9403751a-6bce-0ca0-7f01-737c6f2cdbc1","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{external_api_host}}/v1/loan-types?page[number]=1&page[size]=10","description":"

Fetch a page of loan types. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","loan-types"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"9403751a-6bce-0ca0-7f01-737c6f2cdbc1"},{"name":"Create Loan Type","event":[{"listen":"test","script":{"id":"1c193de9-1abc-4098-8acb-4ac7e42774e0","exec":[""],"type":"text/javascript"}}],"id":"0d4367e8-abec-6d10-d815-783a23ed654e","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"loan_type\": \"Conventional Fixed Rate\",\n \"account_class\": {\n\t\"class_name\": \"mortgage\",\n\t\"class_type\": \"LOAN\"\n }\n}"},"url":"{{external_api_host}}/v1/loan-types","description":"

Create a loan type.\nRequired Attributes:

loan_type

Required Relationships:

owning_organization*

*required if authenticated as an TE admin

\n","urlObject":{"path":["v1","loan-types"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0d4367e8-abec-6d10-d815-783a23ed654e"}],"id":"e1aafc9f-212a-ed44-caf8-ee1e794104a1","description":"

Endpoints for interacting with the loan types resource.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	numeric	Generated identifier for loan type.
loan_type	Yes	string	Name of the loan type.

Uniqueness

\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Fields
1	loan_type

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
account_class	Yes	account class	class_name and class_type	Classification of the type (example: a type which applies to mortgages). Must match an existing account class. Not required for mortgage types.

","event":[{"listen":"prerequest","script":{"id":"689fb084-8ccd-4f8f-8a56-7c8fe39c95aa","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f89e0cbe-80ff-4fcc-8827-6edb8b5b8e3a","type":"text/javascript","exec":[""]}}],"_postman_id":"e1aafc9f-212a-ed44-caf8-ee1e794104a1"},{"name":"Loan Statuses","item":[{"name":"Fetch Loan Status","id":"848c0418-30d3-ad66-2da3-90bb4d247970","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{external_api_host}}/v1/loan-statuses/{{status_id}}","description":"

Fetch a specific loan status specified by ID.

\n","urlObject":{"path":["v1","loan-statuses","{{status_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"848c0418-30d3-ad66-2da3-90bb4d247970"},{"name":"Fetch Loan Statuses","id":"41dc7ccf-b5ad-f2cf-a8e5-82aff09c8fd1","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{external_api_host}}/v1/loan-statuses?page[number]=1&page[size]=10","description":"

Fetch a page of loan statuses. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","loan-statuses"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"41dc7ccf-b5ad-f2cf-a8e5-82aff09c8fd1"},{"name":"Create Loan Status","event":[{"listen":"test","script":{"id":"1d70a9fb-d072-439b-a412-1af82ac3c7ce","exec":[""],"type":"text/javascript"}}],"id":"fd9fc162-8cea-b684-aeb8-db9c3a6d7a87","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"loan_status\": \"Pending\",\n \"account_class\": {\n\t\"class_name\": \"mortgage\",\n\t\"class_type\": \"LOAN\"\n }\n}"},"url":"{{external_api_host}}/v1/loan-statuses","description":"

Create a loan status.\nRequired Attributes:

loan_status

Required Relationships:

owning_organization*

*required if authenticated as an TE admin

\n","urlObject":{"path":["v1","loan-statuses"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fd9fc162-8cea-b684-aeb8-db9c3a6d7a87"}],"id":"199da90c-2546-a988-f43b-b533f53668e5","description":"

Endpoints for interacting with the loan statuses resource.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	numeric	Generated identifier for loan status.
loan_status	Yes	string	Name of the loan status.

Uniqueness

\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Fields
1	loan_status

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
account_class	Yes	account class	class_name and class_type	Classification of the status (example: a status which applies to mortgages). Must match an existing account class. Not required for mortgage statuses.

","event":[{"listen":"prerequest","script":{"id":"ef4da957-a362-47df-b92c-6a5f7b8a0429","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"79931cba-09f2-47a4-9634-2aa3c697fb72","type":"text/javascript","exec":[""]}}],"_postman_id":"199da90c-2546-a988-f43b-b533f53668e5"},{"name":"Loan Purposes","item":[{"name":"Fetch Loan Purpose","id":"24e2d09a-837d-2522-02af-b2defa5dc863","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{external_api_host}}/v1/loan-purposes/{{purpose_id}}","description":"

Fetch a specific loan purpose specified by ID.

\n","urlObject":{"path":["v1","loan-purposes","{{purpose_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"24e2d09a-837d-2522-02af-b2defa5dc863"},{"name":"Fetch Loan Purposes","id":"86d59b25-3512-0b90-d0db-c727227bb917","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{external_api_host}}/v1/loan-purposes?page[number]=1&page[size]=10","description":"

Fetch a page of loan purposes. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","loan-purposes"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"86d59b25-3512-0b90-d0db-c727227bb917"},{"name":"Create Loan Purpose","event":[{"listen":"test","script":{"id":"8cf03866-d957-412e-831f-3eb8fd67d8ab","exec":[""],"type":"text/javascript"}}],"id":"9ff50191-f69d-20ae-7c32-95059d42283d","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"loan_purpose\": \"Refinance\",\n \"account_class\": {\n\t\"class_name\": \"mortgage\",\n\t\"class_type\": \"LOAN\"\n }\n}"},"url":"{{external_api_host}}/v1/loan-purposes","description":"

Create a loan purpose.\nRequired Attributes:

loan_purpose

Required Relationships:

owning_organization*

*required if authenticated as an TE admin

\n","urlObject":{"path":["v1","loan-purposes"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9ff50191-f69d-20ae-7c32-95059d42283d"}],"id":"e98e9907-8811-db07-0463-8bcba544ea07","description":"

Endpoints for interacting with the loan purposes resource.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	numeric	Generated identifier for loan purpose.
loan_purpose	Yes	string	Name of the loan purpose.

Uniqueness

\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Fields
1	loan_purpose

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
account_class	Yes	account class	class_name and class_type	Classification of the purpose (example: a purpose which applies to mortgages). Must match an existing account class. Not required for mortgage purposes.

","event":[{"listen":"prerequest","script":{"id":"b0f96627-496c-4bb7-bcef-07c2dcb04a20","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4b924c90-fb23-4707-9b81-0f6e4e986465","type":"text/javascript","exec":[""]}}],"_postman_id":"e98e9907-8811-db07-0463-8bcba544ea07"},{"name":"Loan Programs","item":[{"name":"Fetch Loan Program","id":"79a0910b-14a6-f0f5-4d68-5e06a483851b","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{external_api_host}}/v1/loan-programs/{{program_id}}","description":"

Fetch a specific loan program specified by TE ID.

\n","urlObject":{"path":["v1","loan-programs","{{program_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"79a0910b-14a6-f0f5-4d68-5e06a483851b"},{"name":"Fetch Loan Programs","id":"cc7ef492-3708-6353-ab15-c06f79652862","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{external_api_host}}/v1/loan-programs?page[number]=1&page[size]=10","description":"

Fetch a page of loan programs. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","loan-programs"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"cc7ef492-3708-6353-ab15-c06f79652862"},{"name":"Create Loan Program","event":[{"listen":"test","script":{"id":"cfbec8bd-c364-464d-a062-db9d9ddf7aa1","exec":[""],"type":"text/javascript"}}],"id":"bd0fe9e4-b0da-e0bf-f822-048495c35350","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"loan_program\": \"10-year Fixed\",\n \"account_class\": {\n\t\"class_name\": \"mortgage\",\n\t\"class_type\": \"LOAN\"\n }\n}"},"url":"{{external_api_host}}/v1/loan-programs","description":"

Create a loan program.\nRequired Attributes:

loan_program

Required Relationships:

owning_organization*

*required if authenticated as an TE admin

\n","urlObject":{"path":["v1","loan-programs"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bd0fe9e4-b0da-e0bf-f822-048495c35350"}],"id":"71f7bba6-2ed8-44ed-15e0-a2fb7974983f","description":"

Endpoints for interacting with the loan programs resource.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	numeric	Generated identifier for loan program.
loan_program	Yes	string	Name of the loan program.

Uniqueness

\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Fields
1	loan_program

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
account_class	Yes	account class	class_name and class_type	Classification of the program (example: a program which applies to mortgages). Must match an existing account class. Not required for mortgage programs.

","event":[{"listen":"prerequest","script":{"id":"716abdda-a08b-4f29-9945-9d2f613c5c70","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9f669f6d-4518-4b00-8743-e3b976b6743f","type":"text/javascript","exec":[""]}}],"_postman_id":"71f7bba6-2ed8-44ed-15e0-a2fb7974983f"}],"id":"3801c9b2-dfce-48d0-b8fd-f18ef8ed65eb","_postman_id":"3801c9b2-dfce-48d0-b8fd-f18ef8ed65eb","description":""},{"name":"Account Endpoints","item":[{"name":"Accounts","item":[{"name":"Fetch Account","event":[{"listen":"prerequest","script":{"id":"7443d00a-47bb-422c-804c-05dafdf89c4c","exec":[""],"type":"text/javascript"}}],"id":"4abd79d3-f659-4b14-ae2b-4b2553804af9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/accounts/{{account_id}}","description":"

Fetch a specific account specified by ID.

\n","urlObject":{"path":["v1","accounts","{{account_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4abd79d3-f659-4b14-ae2b-4b2553804af9"},{"name":"Fetch Accounts","id":"7fd4d9fc-7e7f-4866-a37f-d42480b9c71a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/accounts?page[number]=1&page[size]=10","description":"

Fetch a page of accounts. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","accounts"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"7fd4d9fc-7e7f-4866-a37f-d42480b9c71a"},{"name":"Create Accounts","event":[{"listen":"test","script":{"id":"e5c083cd-f5ea-4cf2-87c7-45d7dcd6ea14","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"account_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"1299f327-7e69-46cc-b681-80c751a1d204","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"Test5\",\r\n \"account_name\": \"Test5 Checking Account\",\r\n \"account_number\": \"Test5\",\r\n \"address\": \"132 Fake St.\",\r\n \"address_2\": \"Suite 12\",\r\n \"application_number\": \"123654789\",\r\n \"city\": \"Smallton\",\r\n \"open_date\": \"2018-10-16 04:20:00\",\r\n \"zip_code\": \"55442\",\r\n \"source\": \"An Account source\",\r\n \"state\": \"Minnesota\",\r\n \"primary_account_holder\": {\r\n \"source\": \"Test\",\r\n \"email\": \"test@test.com\",\r\n \"first_name\": \"Firstname\",\r\n \"last_name\": \"Lastname\",\r\n \"custom\": [\r\n {\r\n \"field_name\": \"custom_string\",\r\n \"value\": \"the custom field string value\"\r\n }\r\n ]\r\n },\r\n \"owner\": {\r\n \"username\": \"testacct\"\r\n },\r\n \"account_class\": {\r\n \"class_name\": \"checking_account\",\r\n \"class_type\": \"ACCOUNT\"\r\n },\r\n \"account_status\": {\r\n \"account_status\": \"Status One - Checking\"\r\n },\r\n \"account_type\": {\r\n \"account_type\": \"Type One - Checking\"\r\n },\r\n \"custom\": [\r\n {\r\n \"field_name\": \"custom_string\",\r\n \"value\": \"the custom field string value\"\r\n }\r\n ]\r\n}"},"url":"{{external_api_host}}/v1/accounts","description":"

Create an account

\n","urlObject":{"path":["v1","accounts"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1299f327-7e69-46cc-b681-80c751a1d204"},{"name":"Update Account","event":[{"listen":"prerequest","script":{"id":"a6c139dd-e234-4854-934f-7a177520774d","exec":["// postman.setEnvironmentVariable(\"loan_id\", \"7769878\");"],"type":"text/javascript"}}],"id":"1dc3fdf4-15e5-49af-8c42-55f9ec498826","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"external_id\": \"Test7\",\r\n \"account_name\": \"Test7 Checking Account\",\r\n \"account_number\": \"Test7\",\r\n \"address\": \"132 Fake St.\",\r\n \"address_2\": \"Suite 12\",\r\n \"application_number\": \"123654789\",\r\n \"city\": \"Smallton\",\r\n \"last_modified_date\": \"2019-08-28 04:20:00\",\r\n \"open_date\": \"2018-10-16 04:20:00\",\r\n \"zip_code\": \"55442\",\r\n \"source\": \"An Account source\",\r\n \"state\": \"Minnesota\",\r\n \"primary_account_holder\": {\r\n \"source\": \"Test\",\r\n \"email\": \"test@nationslending.com\",\r\n \"first_name\": \"Firstname\",\r\n \"last_name\": \"Lastname\"\r\n },\r\n \"owner\": {\r\n \"username\": \"testacct\"\r\n },\r\n \"account_class\": {\r\n \"class_name\": \"checking_account\",\r\n \"class_type\": \"ACCOUNT\"\r\n },\r\n \"account_status\": {\r\n \"account_status\": \"Status One - Checking\"\r\n },\r\n \"account_type\": {\r\n \"account_type\": \"Type One - Checking\"\r\n }\r\n}"},"url":"{{external_api_host}}/v1/accounts/{{account_id}}","description":"

Update an existing account by ID.

\n","urlObject":{"path":["v1","accounts","{{account_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1dc3fdf4-15e5-49af-8c42-55f9ec498826"}],"id":"2b86cb31-24d3-4dec-89d6-782894d62063","description":"

Endpoints for interacting with the accounts resource.

Attributes

Field	Assignable	Type	Description
account_name	Yes	varchar(255)	name of the account
account_number	Yes	varchar(255)	number of the account
account_rate	Yes	decimal(8,5)	Interest rate of the account
address	Yes	varchar(255)	Mailing street address for account communication
address_2	Yes	varchar(255)	Mailing suite/unit number for account communication
application_number	Yes	varchar(255)	number of the application
city	Yes	varchar(255)	Mailing city for account communication
external_id	Yes	varchar(255)	ID of account in source system
id	No	bigint(10) unsigned	generated identifier for account
internal_created_at	Yes	datetime	date/time when the account was created Preferred format: 'YYYY-MM-DD HH:mm:ss'
internal_updated_at	Yes	string	date/time when the account was updated. Preferred format: 'YYYY-MM-DD HH:mm:ss'
last_modified_date	Yes	string	date/time the account was modified. Preferred format: 'YYYY-MM-DD HH:mm:ss'
open_date	Yes	datetime	Date account was opened
source	Yes	string	Account origination source
state	Yes	varchar(100)	Mailing state for account communication
zip_code	Yes	varchar(10)	Mailing postal code for account communication

Uniqueness

\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Fields
1	id

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
owner	Yes	User	username, id, external_id, email	Owning loan officer for the account. Many-to-one relationship, so returned as an object.
account_class	Yes	account	class_name, class_type	Account classification. Many-to-one relationship, so returned as an object.
account_status	Yes	account	account_status	Account status. Many-to-one relationship, so returned as an object.
account_type	Yes	account	account_type	Account type. Many-to-one relationship, so returned as an object.

Filtering

Use the 'filter=attribute_name=x,attribute_name_2=y' query to return the list of accounts that meet the filter criteria. For example, to filter contacts modified between Oct. 14, 2017 17:41:01 (UTC) and Oct. 15, 2017 17:41:09 (UTC), the following query could be used:

/contacts?filter=internal_updated_at_start=2017-10-14T17:41:01Z,internal_updated_at_end=2017-10-15T17:41:09Z

The supported filter attributes are shown in the following table.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
internal_updated_at_start	ISO-8601 formatted date. The start of the time range of interest, inclusive.
internal_updated_at_end	ISO-8601 formatted date. The end of the time range of interest, inclusive.
internal_created_at_start	ISO-8601 formatted date. The start of the time range of interest, inclusive.
internal_created_at_end	ISO-8601 formatted date. The end of the time range of interest, inclusive.
owner_id	TE ID of the owning user.
owner_email	Email of the owning user.
owner_username	Username of the owning user.
owner_external_id	External ID of the owning user.
account_number	Account Number for the account.
account_class_name	Account Classification Name for the account.
account_status	Account Status for the account.
account_type	Account Type for the account.
account_name_contains	Account Name for the account contains the specified string.
role_system_name	Role system name for the account participant.
borrower_id	ID of the borrower participant on the account.
agent_id	ID of the agent participant on the account.
other_id	ID of the other participant on the account.

","_postman_id":"2b86cb31-24d3-4dec-89d6-782894d62063"},{"name":"Account Types","item":[{"name":"Fetch Account Type","event":[{"listen":"prerequest","script":{"id":"a843e381-bbc5-43e6-bbe7-8e1330a4181b","exec":[""],"type":"text/javascript"}}],"id":"f0d2d254-5881-491b-b307-c44d1efbda95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/account-types/{{type_id}}","description":"

Fetch a specific account type specified by ID.

\n","urlObject":{"path":["v1","account-types","{{type_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f0d2d254-5881-491b-b307-c44d1efbda95"},{"name":"Fetch Account Types","id":"dd8a16d0-f93d-4365-94c0-1b421caafc6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/account-types?page[number]=1&page[size]=10","description":"

Fetch a page of account types. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","account-types"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"dd8a16d0-f93d-4365-94c0-1b421caafc6a"},{"name":"Create Account Type","event":[{"listen":"test","script":{"id":"d4b5e195-d6c5-4c4e-8ea1-c64b4f1ff518","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"type_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"53f82ca5-c1f5-4e7b-b051-f1386a7f3d65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account_type\": \"new type 3\",\n \"account_class\": {\n \t\"class_name\": \"cd_account\",\n \t\"class_type\":\"ACCOUNT\"\n }\n \n}"},"url":"{{external_api_host}}/v1/account-types","description":"

Create an account type.\nRequired Attributes:

account_type

Required Relationships:

owning_organization*

*required if authenticated as an TE admin

\n","urlObject":{"path":["v1","account-types"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"53f82ca5-c1f5-4e7b-b051-f1386a7f3d65"},{"name":"Update Account Type","event":[{"listen":"test","script":{"id":"e1f1a389-f4d4-4003-abb4-5993cc7558a7","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"type_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"00422ac9-2ef0-46cf-9312-bfcd6105492e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account_type\": \"new type 3\",\n \"account_class\": {\n \t\"class_name\": \"cd_account\",\n \t\"class_type\":\"ACCOUNT\"\n }\n}"},"url":"{{external_api_host}}/v1/account-types/{{type_id}}","description":"

Update an existing account type by ID.

Endpoints for interacting with the account types resource.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	numeric	Generated identifier for account type.
account_type	Yes	string	Name of the account type.

Uniqueness

\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Fields
1	id

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
account_class_id	Yes	account class	class_name and class_type	Classification of the type. Must match an existing account class id.

","_postman_id":"d04b7356-ff2f-4b39-8b0a-3ba81bab90cb"},{"name":"Account Classifications","item":[{"name":"Fetch Classes","id":"ca65460c-ef2e-48aa-b834-3a238a7fb59c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/account-classifications","urlObject":{"path":["v1","account-classifications"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ca65460c-ef2e-48aa-b834-3a238a7fb59c"}],"id":"2ad4c76e-d23e-47cf-8692-58db5f849d30","_postman_id":"2ad4c76e-d23e-47cf-8692-58db5f849d30","description":""},{"name":"Account Statuses","item":[{"name":"Fetch Status","event":[{"listen":"prerequest","script":{"id":"8dd3a573-e62b-4695-a528-9ffe1249c8ae","exec":[""],"type":"text/javascript"}}],"id":"fbe4b65e-c25b-4f05-a103-9d33578bf5e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/account-statuses/{{status_id}}","description":"

Fetch a specific account status specified by ID.

\n","urlObject":{"path":["v1","account-statuses","{{status_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fbe4b65e-c25b-4f05-a103-9d33578bf5e1"},{"name":"Fetch Statuses","id":"abe35d1d-7250-46cb-890e-d0dbd7bbf4af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/account-statuses?page[number]=1&page[size]=10","description":"

Fetch a page of account statuses. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","account-statuses"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"abe35d1d-7250-46cb-890e-d0dbd7bbf4af"},{"name":"Create Status","event":[{"listen":"test","script":{"id":"eb617e94-1b7a-457b-927b-dda670604468","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"status_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"abd970f6-2e72-4f07-961c-cc3c27ca76a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account_status\": \"New status\",\n \"account_class\": {\n \"class_name\": \"checking_account\",\n \"class_type\": \"ACCOUNT\"\n }\n}"},"url":"{{external_api_host}}/v1/account-statuses","description":"

Create an account status.

Required Attributes:

account_status

Required Relationships:

owning_organization*

*required if authenticated as an TE admin

\n","urlObject":{"path":["v1","account-statuses"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"abd970f6-2e72-4f07-961c-cc3c27ca76a6"},{"name":"Update Status","event":[{"listen":"test","script":{"id":"57e421c4-3f72-4ad0-838e-172c80d50d3a","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"status_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"c8ba9e42-9bb5-4cb7-9ed8-19136fdb6b4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account_status\": \"New status\",\n \"account_class\": {\n \"class_name\": \"checking_account\",\n \"class_type\": \"ACCOUNT\"\n }\n}"},"url":"{{external_api_host}}/v1/account-statuses/{{status_id}}","description":"

Update an existing account status by ID.

\n","urlObject":{"path":["v1","account-statuses","{{status_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c8ba9e42-9bb5-4cb7-9ed8-19136fdb6b4a"}],"id":"7e130a21-657b-46a2-a273-9a95c8c1342e","_postman_id":"7e130a21-657b-46a2-a273-9a95c8c1342e","description":""}],"id":"188e7ff1-ea6a-4c1b-ab5f-b565960fc3cc","event":[{"listen":"prerequest","script":{"id":"a6795d0a-b13e-4c48-9d52-999985701c3f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dfeb5f63-4eaf-4d09-85d3-0aa02db84476","type":"text/javascript","exec":[""]}}],"_postman_id":"188e7ff1-ea6a-4c1b-ab5f-b565960fc3cc","description":""},{"name":"Scenarios","item":[{"name":"Fetch Scenario","id":"d994ac93-06c1-4905-9bab-72b064dc4e5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/scenarios/{{scenario_id}}","description":"

Fetch a specific scenario specified by ID.

\n","urlObject":{"path":["v1","scenarios","{{scenario_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d994ac93-06c1-4905-9bab-72b064dc4e5c"},{"name":"Fetch Scenarios","id":"6b96eacd-4b2f-4a59-885e-e3e60b726edf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/scenarios?page[number]=1&page[size]=10","description":"

Fetch a page of scenarios. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters. Can also filter by name, display_name, or expiration_date.

\n","urlObject":{"path":["v1","scenarios"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"6b96eacd-4b2f-4a59-885e-e3e60b726edf"},{"name":"Create Scenario (as Admin)","event":[{"listen":"test","script":{"id":"26ad4cd3-6c72-498e-932c-708f1d42389f","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"contact_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"3861da81-f881-4f53-aaa4-3619d8b02c3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"name\": \"123 Street Road, City, MN 12345\",\r\n \"display_name\": \"123 Street Road Pricing\",\r\n \"expiration_date\": \"2020-03-01 12:00:00\",\r\n \"owner\":{\r\n \"id\":50\r\n },\r\n \"tags\": [\r\n {\r\n \t\"type\": \"MLS_NUMBER\",\r\n \t\"value\":\"123456\"\r\n \t},\r\n \t{\r\n \t\t\"type\": \"CONTACT\",\r\n \t\t\"value\": 12345\r\n \t}\r\n ],\r\n \"data\": {\r\n \"loan_scenarios\": [\r\n {\r\n \"product_name\": \"Conv 30 Year Fixed\",\r\n \"rate\": 3.875,\r\n \"apr\": 3.901,\r\n \"monthly_payment\": 940,\r\n \"monthly_premium\": 0,\r\n \"is_arm\": false,\r\n \"ltv\": 80,\r\n \"num_payments\": 360,\r\n \"term_total\": 30,\r\n \"closing_costs\": 1200,\r\n \"list_price\": 240000,\r\n \"loan_amount\": 200000,\r\n \"base_loan_amount\": 200000,\r\n \"down_payment\": 40000,\r\n \"down_payment_pct\": 20,\r\n \"raw_down_payment_pct\": 0.2,\r\n \"conforming\": true,\r\n \"non_conforming\": false,\r\n \"fha\": false,\r\n \"va\": false,\r\n \"fico_score\": 740,\r\n \"arm_term\": null,\r\n \"arm_index_value\": null,\r\n \"arm_index\": null,\r\n \"arm_margin\": null,\r\n \"arm_cap_1\": null,\r\n \"arm_cap_2\": null,\r\n \"arm_cap_3\": null,\r\n \"indexed_rate\": null\r\n },\r\n {\r\n \"product_name\": \"Conv 30 Year Fixed\",\r\n \"rate\": 3.875,\r\n \"apr\": 3.901,\r\n \"monthly_payment\": 1115,\r\n \"monthly_premium\": 80,\r\n \"is_arm\": false,\r\n \"ltv\": 90,\r\n \"num_payments\": 360,\r\n \"term_total\": 30,\r\n \"closing_costs\": 1200,\r\n \"list_price\": 240000,\r\n \"loan_amount\": 220000,\r\n \"base_loan_amount\": 220000,\r\n \"down_payment\": 20000,\r\n \"down_payment_pct\": 10,\r\n \"raw_down_payment_pct\": 0.1,\r\n \"conforming\": true,\r\n \"non_conforming\": false,\r\n \"fha\": false,\r\n \"va\": false,\r\n \"fico_score\": 740,\r\n \"arm_term\": null,\r\n \"arm_index_value\": null,\r\n \"arm_index\": null,\r\n \"arm_margin\": null,\r\n \"arm_cap_1\": null,\r\n \"arm_cap_2\": null,\r\n \"arm_cap_3\": null,\r\n \"indexed_rate\": null\r\n },\r\n {\r\n \"product_name\": \"Conv 7/1 ARM\",\r\n \"rate\": 3.675,\r\n \"apr\": 3.812,\r\n \"monthly_payment\": 900,\r\n \"monthly_premium\": 0,\r\n \"is_arm\": true,\r\n \"ltv\": 80,\r\n \"num_payments\": 360,\r\n \"term_total\": 30,\r\n \"closing_costs\": 1300,\r\n \"list_price\": 240000,\r\n \"loan_amount\": 200000,\r\n \"base_loan_amount\": 200000,\r\n \"down_payment\": 40000,\r\n \"down_payment_pct\": 20,\r\n \"raw_down_payment_pct\": 0.2,\r\n \"conforming\": true,\r\n \"non_conforming\": false,\r\n \"fha\": false,\r\n \"va\": false,\r\n \"fico_score\": 740,\r\n \"arm_term\": 84,\r\n \"arm_index_value\": 1.72,\r\n \"arm_index\": \"CMT\",\r\n \"arm_margin\": 2.25,\r\n \"arm_cap_1\": 2,\r\n \"arm_cap_2\": 2,\r\n \"arm_cap_3\": 5,\r\n \"indexed_rate\": 3.97\r\n }\r\n ]\r\n }\r\n}"},"url":"{{external_api_host}}/v1/scenarios","description":"

Create a scenario.

Required Attributes (one of the following combinations):

name, data

Required Relationships:

owner*
tags

*required if authenticated as an organization admin

\n","urlObject":{"path":["v1","scenarios"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3861da81-f881-4f53-aaa4-3619d8b02c3c"},{"name":"Update Scenario","id":"98041458-b285-484c-a223-2bba5e592f5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"name\": \"123 Street Road, City, MN 12345\",\r\n \"display_name\": \"123 Street Road Pricing\",\r\n \"expiration_date\": \"2020-03-01 12:00:00\",\r\n \"owner\":{\r\n \"id\":50\r\n },\r\n \"tags\": [\r\n {\r\n \t\"type\": \"MLS_NUMBER\",\r\n \t\"value\":\"654321\"\r\n \t}\r\n ],\r\n \"remove_tags\": [\r\n \t{\r\n \t\t\"type\": \"CONTACT\",\r\n \t\t\"value\": 12345\r\n \t}\r\n ],\r\n \"data\": {\r\n \"loan_scenarios\": [\r\n {\r\n \"product_name\": \"Conv 30 Year Fixed\",\r\n \"rate\": 3.875,\r\n \"apr\": 3.901,\r\n \"monthly_payment\": 940,\r\n \"monthly_premium\": 0,\r\n \"is_arm\": false,\r\n \"ltv\": 80,\r\n \"num_payments\": 360,\r\n \"term_total\": 30,\r\n \"closing_costs\": 1200,\r\n \"list_price\": 240000,\r\n \"loan_amount\": 200000,\r\n \"base_loan_amount\": 200000,\r\n \"down_payment\": 40000,\r\n \"down_payment_pct\": 20,\r\n \"raw_down_payment_pct\": 0.2,\r\n \"conforming\": true,\r\n \"non_conforming\": false,\r\n \"fha\": false,\r\n \"va\": false,\r\n \"fico_score\": 740,\r\n \"arm_term\": null,\r\n \"arm_index_value\": null,\r\n \"arm_index\": null,\r\n \"arm_margin\": null,\r\n \"arm_cap_1\": null,\r\n \"arm_cap_2\": null,\r\n \"arm_cap_3\": null,\r\n \"indexed_rate\": null\r\n }\r\n ]\r\n }\r\n}"},"url":"{{external_api_host}}/v1/scenarios/{{scenario_id}}","description":"

Update an existing scenario by ID.

\n","urlObject":{"path":["v1","scenarios","{{scenario_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"98041458-b285-484c-a223-2bba5e592f5e"},{"name":"Delete Scenario","id":"42cb133b-c6a2-42a4-851e-05d6f6c3a52d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{external_api_host}}/v1/scenarios/{{scenario_id}}","description":"

Delete a scenario by ID.

Endpoints for interacting with the scenarios resource.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	numeric	Generated identifier for scenario.
name	Yes	string	Scenario's system name
display_name	Yes	string	Scenario's display name
data	Yes	json	Scenario data (see \"Scenario Data\" below).
expiration_date	Yes	string	Date of expiration for this scenario. Preferred format: 'YYYY-MM-DD HH:mm:ss'
internal_created_at	No	string	Date of creation of this scenario in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'
internal_updated_at	No	string	Date of last change for this scenario in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'

Scenario Data

The data field is validated against the JSON schema document specific to your organization. This field should not be encoded separately within the request.

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
owner	Yes*	User	username, id, external_id	Owning user of the scenario. One to many relationship, so returned as an object. *Only assignable/visible if authenticated as an organization admin.
tags	Yes	Scenario Tag	type, value	Tags to which this scenario should apply. Many-to-one relationship, so returned as an array of objects. Tags can only be added or removed, they cannot be updated.

Remove Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
remove_tags	Yes	Scenario Tag	type, value	Tags to remove from the scenario.

Filtering

Use the 'filter=attribute_name=x,attribute_name_2=y' query to return the list of scenarios that meet the filter criteria. For example, to filter scenarios expired between Oct. 14, 2017 17:41:01 (UTC) and Oct. 15, 2017 17:41:09 (UTC), the following query could be used:

/scenarios?filter=expiration_date_start=2017-10-14T17:41:01Z,expiration_date_end=2017-10-15T17:41:09Z

The supported filter attributes are shown in the following table.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
expiration_date_start	ISO-8601 formatted date. The start of the time range of interest, inclusive.
expiration_date_end	ISO-8601 formatted date. The end of the time range of interest, inclusive.
name	Scenario's system name
display_name	Scenario's display name

","event":[{"listen":"prerequest","script":{"id":"04d6c4e2-7300-40cd-af13-973609a911bb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a7972dcb-d897-4099-92a9-9f73a6912719","type":"text/javascript","exec":[""]}}],"_postman_id":"f0702a40-ddba-4545-b487-56cf58c4c56f"},{"name":"Email Unsubscribes","item":[{"name":"Fetch Email Domains","id":"7ffe5d17-e167-44b3-ae80-a473d6cd24ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/email-domains","description":"

Fetch a page of email domains. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
domain_name	No	string	The sending domain, e.g. 'totalexpert.com'

","urlObject":{"path":["v1","email-domains"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7ffe5d17-e167-44b3-ae80-a473d6cd24ae"},{"name":"Create Email Unsubscribe","event":[{"listen":"test","script":{"id":"d6a59789-544c-4036-afd6-4e56866f4970","exec":[""],"type":"text/javascript"}}],"id":"7c87f5ba-17ab-4ecf-9a37-50159398acfe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"dontemailmeanymore@domain.com\",\r\n \"organization_wide\": false,\r\n \"users\": [\r\n {\r\n \"email\": \"user1@mycompany.net\"\r\n },\r\n {\r\n \"external_id\": \"mycompany.user2\"\r\n },\r\n {\r\n \"id\": 59\r\n },\r\n {\r\n \"username\": \"user4\"\r\n }\r\n ],\r\n \"domains\": [\r\n \t{\r\n \t\t\"domain_name\":\"mycompany.net\"\r\n \t}\r\n\t]\r\n}"},"url":"{{external_api_host}}/v1/email-unsubscribes","description":"

Change the subscripition status for an email.

Required Attributes:

Required Relationships:\nNone

\n","urlObject":{"path":["v1","email-unsubscribes"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7c87f5ba-17ab-4ecf-9a37-50159398acfe"},{"name":"Fetch Email Unsubscribes","id":"922c1469-f581-4e5c-96ce-110247b3d614","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/email-unsubscribes?page[number]=1&page[size]=10","description":"

Fetch a page of unsubscribes. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	int	The id of the email unsubscribe
email	No	string	The email that is unsubscribed
organization_unsub_at	No	datetime	The timestamp of when an organization unsubscribed
organization_wide	No	bool	The unsubscribe is org-wide

","urlObject":{"path":["v1","email-unsubscribes"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[{"id":"01ba7bdc-bc03-442c-b10c-9eb99a2be54f","name":"Fetch Email Unsubscribes","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"{{external_api_host}}/v1/email-unsubscribes?page[number]=1&page[size]=10","host":["{{external_api_host}}"],"path":["v1","email-unsubscribes"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"email\": \"example-email@domain.com\",\n \"id\": 1,\n \"organization_unsub_at\": \"2021-01-28T16:21:40.000000Z\",\n \"organization_wide\": true,\n \"domains\": [\n {\n \"domain_name\": \"totalexpertinc.com\",\n \"id\": 1,\n \"domain_unsub_at\": \"2021-01-28T16:21:40.000000Z\"\n }\n ],\n \"users\": [\n {\n \"email\": \"test-user@totalexpert.com\",\n \"external_id\": \"test\",\n \"id\": 50,\n \"username\": \"testacct\",\n \"user_unsub_at\": \"2021-01-28T16:21:40.000000Z\"\n }\n ]\n }\n ],\n \"links\": {\n \"first\": 1,\n \"last\": 1,\n \"next\": null,\n \"prev\": null\n }\n}"}],"_postman_id":"922c1469-f581-4e5c-96ce-110247b3d614"},{"name":"Fetch Email Unsubscribe","id":"222a1a7a-2e0d-47ed-adc1-dbf13d44261c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/email-unsubscribes/{{email_unsubscribe_id}}","description":"

Fetch a particular email unsubscribe by id.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	int	The id of the email unsubscribe
email	No	string	The email that is unsubscribed
organization_unsub_at	No	datetime	The timestamp of when an organization unsubscribed
organization_wide	No	bool	The unsubscribe is org-wide

","urlObject":{"path":["v1","email-unsubscribes","{{email_unsubscribe_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"5690cd39-cf59-4b5f-b956-020ab4b65fca","name":"Fetch Email Unsubscribe","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/email-unsubscribes/{{email_unsubscribe_id}}"},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"email\": \"example-email@domain.com\",\n \"id\": 1,\n \"organization_unsub_at\": \"2021-01-28T16:21:40.000000Z\",\n \"organization_wide\": true,\n \"domains\": [\n {\n \"domain_name\": \"totalexpertinc.com\",\n \"id\": 1,\n \"domain_unsub_at\": \"2021-01-28T16:21:40.000000Z\"\n }\n ],\n \"users\": [\n {\n \"email\": \"test-user@totalexpert.com\",\n \"external_id\": \"test\",\n \"id\": 50,\n \"username\": \"testacct\",\n \"user_unsub_at\": \"2021-01-28T16:21:40.000000Z\"\n }\n ]\n}"}],"_postman_id":"222a1a7a-2e0d-47ed-adc1-dbf13d44261c"}],"id":"7692b9f9-1533-463b-a859-e97d8c166dfe","description":"

Endpoints for unsubscribing and tracking unsubscribes in TE.

Unsubscribes are at three tiers - organization-wide unsubscribes, domain-level unsubscribes, and user-level unsubscribes.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	int	The id of the email unsubscribe
email	Yes	string	email to subscribe or unsubscribe.
organization_wide	Yes	boolean	whether the email is unsubscribed for the entire organization
organization_unsub_at	No	datetime	The timestamp of when an organization unsubscribed

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
users	Yes	User	username, id, external_id,email	List of users from which this email is unsubscribed
domains	Yes	EmailDomain	domain_name, id	List of domains from which this email is unsubscribed
remove_users	Yes	User	username, id, external_id,email	List of users from which this email is no longer unsubscribed. Only available in some organizations.
remove_domains	Yes	EmailDomain	domain_name, id	List of domains from which this email is no longer unsubscribed. Only available in some organizations.

Notes

Email unsubscribe changes will be sent via webhook to webhook subscriptions subscribed to the \"EMAIL_UNSUBSCRIBE/UPDATED\" action.

Filtering

Use the 'filter=attribute_name=x,attribute_name_2=y' query to return the list of eamil unsubscribes that meet the filter criteria. For example, to filter email unsubscribes by field 'email', the following query could be used:

/email-unsubscribes?filter=email=somebody@mail.com

The supported filter attributes are shown in the following table.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
email	email used to subscribe or unsubscribe.
organization_unsub_at_start	ISO-8601 formatted date. The start of the time range of interest of ORGANIZATION unsubscribes, inclusive.
organization_unsub_at_end	ISO-8601 formatted date. The end of the time range of interest of ORGANIZATION unsubscribes, inclusive.
user_unsub_at_start	ISO-8601 formatted date. The start of the time range of interest of USER unsubscribes, inclusive.
user_unsub_at_end	ISO-8601 formatted date. The end of the time range of interest of USER unsubscribes, inclusive.
domain_unsub_at_start	ISO-8601 formatted date. The start of the time range of interest of DOMAIN unsubscribes, inclusive.
domain_unsub_at_end	ISO-8601 formatted date. The end of the time range of interest of DOMAIN unsubscribes, inclusive.

","event":[{"listen":"prerequest","script":{"id":"fe813650-17f2-4f28-b9ba-bde4a95b68d9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9045a9f0-2e98-4ad3-adcc-f3fbede3527a","type":"text/javascript","exec":[""]}}],"_postman_id":"7692b9f9-1533-463b-a859-e97d8c166dfe"},{"name":"SMS Opting","item":[{"name":"Create Opt-in","event":[{"listen":"test","script":{"id":"1131a048-c109-493f-8283-ce3005dac37b","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"contact_group_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"0db9474f-bcf2-4bce-b290-a14b0922eb95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"612.555.1234\",\n \"user\": {\n \"id\": 50\n },\n \"status\": \"OPTED_IN\"\n}"},"url":"{{external_api_host}}/v1/sms/opt-in","description":"

Create a SMS Opt-in record.

Required Attributes:

phone_number
user
status

\n","urlObject":{"path":["v1","sms","opt-in"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0db9474f-bcf2-4bce-b290-a14b0922eb95"},{"name":"Create Opt-out","event":[{"listen":"test","script":{"id":"1131a048-c109-493f-8283-ce3005dac37b","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"contact_group_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"c79dbc5b-9817-4ed0-bd2b-67ba13817cbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"612.555.1234\"\n}"},"url":"{{external_api_host}}/v1/sms/opt-out","description":"

Create a SMS Opt-out record.

Required Attributes:

phone_number

\n","urlObject":{"path":["v1","sms","opt-out"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c79dbc5b-9817-4ed0-bd2b-67ba13817cbf"}],"id":"63499b22-10ed-4993-8ef2-84aef75f1018","description":"

Endpoints for interacting with the SMS resources.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
phone_number	Yes	string	Mobile phone number.

Opt-in Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
status	Yes	string	Status of the Opt-in: 'OPTED_IN' !! 'REQUESTED' and 'OPTED_OUT' have been deprecated. The request will not perform an update when passed; will be removed on 2025-12-09

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
user	Yes*	User	username, id, external_id	Owning user of the SMS Opt-in. One to many relationship, so returned as an object. *Only assignable on opt-in.

Fetch a page of the list of subscribable actions. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
action	No	string	name of the subscribed verb, e.g. 'CREATED'
item	Yes	string	name of the subscribed item, e.g. 'CONTACT'

","urlObject":{"path":["v1","webhook-actions",""],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f82fb06a-2b9f-4794-a056-b93e2fdfd1ca"},{"name":"Create Webhook Subscription","event":[{"listen":"test","script":{"id":"d6a59789-544c-4036-afd6-4e56866f4970","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"subscription_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"a3638ece-01cd-42f4-a1d7-831a77c3e631","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://mydomain.example.com/v1/sample-webhook-consume5/\",\n \"secret\":\"abcd1234\",\n \"actions\": [\n {\n \"action\": \"CREATED\",\n \"item\": \"CONTACT\"\n }\n ],\n \"remove_actions\": [\n {\n \"action\":\"DELETED\",\n \"item\":\"CONTACT\"\n }\n ]\n}"},"url":"{{external_api_host}}/v1/webhook-subscriptions","description":"

Create a webhook subscription.

Required Attributes:

Required Relationships:

actions

\n","urlObject":{"path":["v1","webhook-subscriptions"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a3638ece-01cd-42f4-a1d7-831a77c3e631"},{"name":"Fetch Webhook Subscriptions","id":"14e5f165-541b-4b2c-8373-d0ff5a9c7e4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/webhook-subscriptions?page[number]=1&page[size]=10","description":"

Fetch a page of subscriptions. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.

\n","urlObject":{"path":["v1","webhook-subscriptions"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"14e5f165-541b-4b2c-8373-d0ff5a9c7e4c"},{"name":"Fetch Webhook Subscription","id":"fb13de49-f475-4539-95ee-a756522f7fc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/webhook-subscriptions/{{subscription_id}}?page[number]=1&page[size]=10","description":"

Fetch a specific subscription specified by ID.

Deletes a subscription by ID.

\n","urlObject":{"path":["v1","webhook-subscriptions","{{subscription_id}}"],"host":["{{external_api_host}}"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[],"_postman_id":"e52a6c2f-c6f1-44da-b4e2-152ec87b993d"},{"name":"Update Webhook Subscription","event":[{"listen":"test","script":{"id":"857a1572-8cfb-423a-b2d0-2bd9d68f33a5","exec":[""],"type":"text/javascript"}}],"id":"d3aa926c-ee19-42c5-9545-6a317f80acac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://mydomain.example.com/v1/sample-webhook-consume/\",\n \"actions\": [\n {\n \"action\": \"CREATED\",\n \"item\": \"CONTACT\"\n },\n {\n \"action\": \"DELETED\",\n \"item\": \"CONTACT\"\n },\n {\n \"action\": \"UPDATED\",\n \"item\": \"CONTACT\"\n }\n ],\n \"secret\":\"new_secret\"\n}"},"url":"{{external_api_host}}/v1/webhook-subscriptions/{{subscription_id}}","description":"

Update an existing subscription by ID.

This can be used to rotate the webhook secret. The updated secret will be applied for any changes originating after the subscription is patched. Pending webhooks will still be sent using the old secret.

\n","urlObject":{"path":["v1","webhook-subscriptions","{{subscription_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d3aa926c-ee19-42c5-9545-6a317f80acac"}],"id":"936e56d7-e12a-404e-85e1-5ea107bb6a4f","description":"

Webhooks allow you to stay informed on certain events that occur within the platform. They serve as a mechanism that keeps the system in sync by allowing one application to deliver information to another application in real-time. In other words, you receive data immediately.

\n\n

A subscription to a webhook is useful if your organization has a mirrored copy of your TE database, and you want to be informed of any changes that are occurring. Once you have a webhook, you retrieve data about a possible change. At that time, you can make the decision to update your database or not.

Webhook Examples:

Organizations or vendors that have a CRM separate from the TE system could be informed of any contact or lead that is manually added through the TE system and not the CRM first.
When contacts are being updated directly within the TE system and not the CRM. This ensures the other system(s) stay in sync.
Deleting contacts or archiving contacts within TE ensures that the correct contacts are removed from the CRM database as well.
If contacts opt out of email communication within TE, the other CRM database can be updated to ensure communication does not reach them.

Requesting Webhooks

The following must be included during a webhook request:

A URL where notifications are sent. This must be HTTPS protected by a valid certification.
A list of actions to subscribe to. To get a full list of these actions, use the fetch webhooks endpoint.
A secret field that is included in any webhook notification sent by TE to the specified URL. This is used to authenticate that the process is not malicious.
-- A randomly generated HEX string of 32 to 64 characters is suggested. A secret of up to 255 characters is supported.
-- This secret can be rotated by performing a PATCH against the endpoint using the subscription ID you received when first creating the subscription.

Webhook Notification Limitations

NOTE:

Users only receive notifications when the contact record is associated with your organization.
Users do not receive notifications from contacts that are not associated with their organization. Co-marketers of organizational contacts also do not receive notifications.

What Happens When a Request Action Occurs?

TE generates a webhook notification. This consists of an HTTP POST request sent to the URL provided in the request.

Example Webhook Body

{ \n  \"item\":\"<item>\", \n  \"action\":\"<action>\", \n  \"id\":<id>, \n  \"hashValue\":\"<hashValue>\", \n  \"secret\":\"<secret>\" \n} \n

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attributes	Descriptions
item	Name of the subscribed item, ex: ‘CONTACT’
action	Name of the subscribed verb, ex: ‘CREATED’
id	The database ID of the item
hashValue	The value generated from the affected record. (See below for more information.)
secret	Secret that has been specified

What is the Hash Value?

The purpose of a hash value is to allow the user to view if the update has actually been made to the contact or not. Hash values are HEX strings that represent the contents of the affected record.

The hash value does not change if the notification is triggered on the same contact record without any actual changes happening to that specific contact. So, if you receive multiple notifications from one contact record without the hash value being update, you can safely ignore the second, third, fourth, etc. notification.

I.e. If a user saves a contact record within the TE UI without actually adjusting any of the contact’s information.

It is important to compare the hash value only to the most recent notification received. If a contact record has been modified but then reverts to its previous state, the last notification’s hash value would match the one from before the changes.

Webhook Endpoints

Endpoints for registering for webhooks in the TE system.

All webhooks in the TE system subscribe to a set of 'actions'. An action comprises an 'entity' and a 'verb'. Subscribable actions can be fetched from the 'webhook-actions' endpoint.

Each organization can have several webhooks, and each webhook can be registered to multiple actions.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
url	No	string	url to which to send the webhook. Must be https.
secret	Yes	string	an additional secret to send in the body of the webhook.

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
actions	Yes	User	Action	List of subscribed actions for this webhook. One-to-many relationship, so returned as an array.

Special POST/PATCH Attributes

These attributes are used to manipulate the contact but are neither contact attributes or relationships. These attributes will not appear in responses.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Settable Fields	Description
remove_actions	Yes	User	Action

","event":[{"listen":"prerequest","script":{"id":"568b08e9-9cd5-4f0a-94d5-315585edde88","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"09295f92-243d-47ef-82b7-8e81d08fa116","type":"text/javascript","exec":[""]}}],"_postman_id":"936e56d7-e12a-404e-85e1-5ea107bb6a4f"},{"name":"Schema Endpoints","item":[{"name":"Fetch Custom Field Schema","id":"1ea7cbf6-b5b8-43b8-a702-d8a6be2c55e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{external_api_host}}/v1/schema/custom-fields","description":"

Fetch the schema of the custom fields defined for your organization.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
display_name	No	string	Field name that will be displayed in the TE platform
internal_created_at	No	string	Date of creation of this custom field in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'
internal_updated_at	No	string	Date of last change to this custom field in TE systems. Format: 'YYYY-MM-DD HH:mm:ss'
related_entity	No	relationship	Contains two fields that specify the type of entity the custom field is tied to: entity_type (Possible values: loan, contact, account, user, entity) and entity_subtype, which can contain a custom string value

system_name	No	string	Field name that is used internally to identify the custom field
data_type	No	string	Custom field's data type (Possible values: text, datetime, date, boolean, integer, decimal)
account_class	No	relationship	Contains two fields that specify the account classification the custom field is tied to: class_name, which is a custom string, and class_type (Possible values: LOAN, ACCOUNT)

Filtering

Use the 'filter=attribute_name=x,attribute_name_2=y' query to return the list of custom field that meet the filter criteria. For example, to filter custom fields modified between Oct. 14, 2020 17:41:01 (UTC) and Oct. 15, 2020 17:41:09 (UTC), the following query could be used:

/schema/custom-fields?filter=internal_updated_at_start=2017-10-14T17:41:01Z,internal_updated_at_end=2017-10-15T17:41:09Z

The supported filter attributes are shown in the following table.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
internal_updated_at_start	ISO-8601 formatted date. The start of the time range of interest, inclusive.
internal_updated_at_end	ISO-8601 formatted date. The end of the time range of interest, inclusive.
internal_created_at_start	ISO-8601 formatted date. The start of the time range of interest, inclusive.
internal_created_at_end	ISO-8601 formatted date. The end of the time range of interest, inclusive.
system_name	The internal name of the custom field
related_entity_type	The type of the related_entity
account_class_name	Name of the related account class
account_class_type	Type of the related account class

","urlObject":{"path":["v1","schema","custom-fields"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1ea7cbf6-b5b8-43b8-a702-d8a6be2c55e6"},{"name":"Fetch Loan Participant Roles Schema","id":"87c4f245-16e0-4ab8-a8d3-c1c6d1d43de9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{external_api_host}}/v1/schema/participant-roles","description":"

Fetch the schema of the loan participant roles defined for your organization.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
display_name	No	string	Role display name
required	No	tinyint	To describe the role is required
system_name	No	string	Role system name
account_class	No	relationship	Contains two fields that specify the account classification the custom field is tied to: class_name, which is a custom string, and class_type (Possible values: LOAN, ACCOUNT)
role_type	No	relationship	Contains three fields that specify the loan participant role type the custom field is tied to: discrete, rules_type_id and type_name

Filtering

The supported filter attributes are show in the following table.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
system_name	The system name for the role
display_name	The display name for the role
required	To describe if the role is required
account_class_name	The system name for the account classification
account_class_type	The type for the account classification
role_type_name	The name of the loan participant role type
role_type_discrete	To describe if the loan participant role type is discrete
role_type_rules_type_id	The id of the rules type as it relates to the the loan participant role type

","urlObject":{"path":["v1","schema","participant-roles"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"87c4f245-16e0-4ab8-a8d3-c1c6d1d43de9"}],"id":"de8aabe8-61d7-465b-8aeb-828b62fa7492","description":"

Endpoints for viewing custom fields defined at the organization level.

Required:

In order to access these endpoints, you need to be an Organization Admin API user, as they return organization-wide data
Scope: describeSchema

NOTE: These endpoints are GET only

\n","_postman_id":"de8aabe8-61d7-465b-8aeb-828b62fa7492"},{"name":"ALM Leads (formerly Lead Opportunities)","item":[{"name":"Fetch Lead Opportunity","id":"acf116d9-5395-4809-a505-89af4e2eae94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{external_api_host}}/v1/leads/{{lead_id}}","description":"

The GET endpoint returns details about the lead record, including the lead_opportunity details, any existing lead_opportunity_offers, and more.

Attributes unique to GET

owner

Details about the current owner of the lead, including the following:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

attribute	value
email	The user's e-mail address as stored in the Total Expert database
external_id	An assignable identifier of the user as represented in a third-party system
id	The user's internal Total Expert identifier
username	The user's internal Total Expert username

related_entities

Currently returns information about the contact record to which the lead is linked. parent.id represents the contact ID.

\"related_entities\": [\n    {\n        \"relationship_type\": {\n            \"system_name\": \"Contact\"\n        },\n        \"parent\": [\n            {\n                \"id\": \"87987456\"\n            }\n        ]\n    }\n]\n\n

Example GET response:

{\n    \"title\": \"Mr.\",\n    \"first_name\": \"John\",\n    \"last_name\": \"Smith\",\n    \"suffix\": \"Jr.\",\n    \"nickname\": \"Johnathon\",\n    \"email\": \"jsmith@gmail.com\",\n    \"address\": \"2744 Imaginary Ave\",\n    \"address_2\": \"Apartment 8\",\n    \"city\": \"Los Angeles\",\n    \"state\": \"CA\",\n    \"zip_code\": 90210,\n    \"phone_cell\": \"5555555555\",\n    \"phone_home\": \"2222222222\",\n    \"phone_office\": \"7777777777\",\n    \"ok_to_email\": 1,\n    \"referred_by\": \"Jane Smith\",\n    \"credit_score\": \"Excellent\",\n    \"source\": \"leadSourceName\",\n    \"assigned_to\": 50,\n    \"owner_id\": 50,\n    \"lead_opportunity\": {\n        \"property_value\": 350000,\n        \"property_county\": \"Alameda\",\n        \"property_zip\": 90010,\n        \"property_state\": \"CA\",\n        \"property_msa\": \"LA\",\n        \"loan_amount\": 325000,\n        \"loan_down_payment\": 25000,\n        \"loan_cash_out\": 0,\n        \"property_type\": \"Single Family\",\n        \"property_use\": \"Owner Occupied\",\n        \"loan_request_type\": \"Purchase\",\n        \"lead_price\": 50,\n        \"tracking_number\": \"123456\",\n        \"annual_income\": 120000,\n        \"first_time_buyer\": \"true\",\n        \"has_agent\": \"true\",\n        \"is_military\": \"false\",\n        \"self_credit_rating\": \"Good\",\n        \"bankruptcy\": \"fales\",\n        \"foreclosure\": \"false\",\n        \"working_with_agent\": \"true\",\n        \"found_home\": \"true\",\n        \"property_purchase_price\": 350000,\n        \"is_fha_eligible\": \"true\",\n        \"is_va_loan\": \"false\",\n        \"present_ltv\": 92.00,\n        \"proposed_ltv\": 92.00,\n        \"term\": \"30 year fixed\",\n        \"estimated_payment\": 1500,\n        \"apr\": 3.789,\n        \"market_value\": 355000,\n        \"rate_offer\": 3.625\n    },\n    \"lead_opportunity_offers\": [\n        {\n            \"offer_id\": 1,\n            \"offer_type\": \"Fixed\",\n            \"loan_program_name\": \"Conf 30 Yr Fixed\",\n            \"loan_amount\": 255000,\n            \"interest_rate\": 3.625,\n            \"term\": \"30 \",\n            \"points\": 0.75,\n            \"investor\": \"Total Expert(308)\",\n            \"lock_term\": 45,\n            \"monthly_payment\": 1367.34,\n            \"down_payment\": 295000,\n            \"apr\": 5.171\n        },\n        {\n            \"offer_id\": 2,\n            \"offer_type\": \"Fixed\",\n            \"loan_program_name\": \"Conf 15 Yr Fixed \",\n            \"loan_amount\": 255000,\n            \"interest_rate\": 4.625,\n            \"term\": \"180\",\n            \"points\": 0.75,\n            \"investor\": \"Total Expert(308)\",\n            \"lock_term\": 30,\n            \"monthly_payment\": 1067.34,\n            \"down_payment\": 295000.00,\n            \"apr\": 6.171\n        }\n    ],\n    \"custom\": [ \n                {\n                    \"field_name\": \"name\",\n                    \"value\": \"value\"\n                }\n    ],\n    \"owner\": {\n                \"email\": \"billfischer@example.com\",\n                \"external_id\": \"\",\n                \"id\": \"218923\",\n                \"username\": \"billfischer-example\"\n            },\n    \"related_entities\": [\n        {\n            \"relationship_type\": {\n                \"system_name\": \"Contact\"\n            },\n            \"parent\": [\n                {\n                    \"id\": \"87987456\"\n                }\n            ]\n        }\n    ]\n}\n\n

\n","urlObject":{"path":["v1","leads","{{lead_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"acf116d9-5395-4809-a505-89af4e2eae94"},{"name":"Create Lead Opportunity","id":"e8a78f12-5f00-4cb2-965c-956c6c37edec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Dr.\",\n \"first_name\": \"Bill\",\n \"last_name\": \"Nye\",\n \"email\": \"the_science_guy@aol.com\",\n \"address\": \"1234 Science Blvd\",\n \"city\": \"Los Angeles\",\n \"state\": \"CA\",\n \"zip_code\": \"90210\",\n \"phone_cell\": \"2134447777\",\n \"phone_home\": \"2134447777\",\n \"phone_office\": \"2134447777\",\n \"ok_to_email\": true,\n \"referred_by\": \"Albert Einstein\",\n \"credit_score\": \"Excellent\",\n \"source\": \"GoodLeads\",\n \"owner\": {\n \"id\": 1234,\n \"external_id\": \"external-system-123\",\n \"email\": \"test@example.com\",\n \"username\": \"testtesterson-te\"\n },\n \"lead_opportunity\": {\n \"property_value\": 850000,\n \"property_county\": \"Alameda\",\n \"property_zip\": \"90010\",\n \"property_state\": \"CA\",\n \"property_msa\": \"LA\",\n \"loan_amount\": 850000,\n \"loan_down_payment\": 25000.00,\n \"loan_cash_out\": 0.00,\n \"property_type\": \"Single Family\",\n \"property_use\": \"Owner Occupied\",\n \"loan_request_type\": \"Purchase\",\n \"lead_price\": 50,\n \"tracking_number\": \"123456\",\n \"annual_income\": 250000,\n \"first_time_buyer\": true,\n \"has_agent\": true,\n \"is_military\": false,\n \"self_credit_rating\": \"Good\",\n \"bankruptcy\": false,\n \"foreclosure\": false,\n \"working_with_agent\": true,\n \"found_home\": true,\n \"property_purchase_price\": 850000,\n \"is_fha_eligible\": true,\n \"present_ltv\": 92.00,\n \"proposed_ltv\": 92.00,\n \"term\": \"30 year fixed\",\n \"estimated_payment\": 1500,\n \"apr\": 5.789,\n \"market_value\": 355000,\n \"rate_offer\": 3.625\n },\n \"lead_opportunity_offers\": [\n {\n \"offer_id\": 1,\n \"offer_type\": \"Fixed\",\n \"loan_program_name\": \"Conf 30 Yr Fixed \",\n \"loan_amount\": 855000.00\n },\n {\n \"offer_id\": 2,\n \"offer_type\": \"Fixed\",\n \"loan_program_name\": \"Conf 15 Yr Fixed \",\n \"loan_amount\": 855000.00\n }\n ],\n \"custom\": [\n {\n \"field_name\": \"my_custom_field\", \n \"value\": \"Super special value\"\n }\n ]\n}"},"url":"{{external_api_host}}/v1/leads","description":"

Leads and Contacts

A POST request for a new lead wil also create a new contact record, but only if a matching contact is not found. A matching contact is one that meets this criteria:

Has a first name identical to the request first_name
Has a last name identical tp the request last_name
Has an e-mail address or phone number field identical to those in the request
If owner_id is not in the request, the contact meets the above matching criteria and is owned by the same organization
If an owner_id is in the request, the contact meets the above matching criteria and is owned by the exact same user ID

A successful response from will return the ID of the new lead, and the ID of either the new contact or the existing, matched contact:

{\n    \"contact_id\": 144558,\n    \"lead_id\": 144559\n}\n\n

Required Fields

One of the following combinations:

first_name, last_name, source, email
first_name, last_name, source, address, city, state, zip
first_name, last_name, source, phone_home
first_name, last_name, source, phone_cell
first_name, last_name, source, phone_office

Optional fields:

owner_id
All lead_opportunity fields,
All lead_opportunity_offers fields
custom fields

Lead Attributes

Field	Data Type	Description
tile	string	The contact's honorific/title, e.g. \"Doctor\"
first_name	string	The contact's first name
last_name	string	The contact's last name
suffix	string	The contact's suffix, e.g. \"Jr.\"
nickname	string	The contact's preferred name
owner_id	integer	The Total Expert user ID that owns the contact/lead
address	string	Street address portion of contact's current address.
address_2	string	Line 2 portion of contact's current address.
city	string	City portion of contact's current address.
state	string	State portion of current contact's address. Preferred format: Two character state abbreviation, e.g. 'CA'
zip_code	string	Zip code portion of contact's current address. Preferred format: 5 digit postal code, e.g. '90210'
birthday	string	Contact's birthday, formatted as a date with 1970 as the year. Preferred format: '1970-MM-DD'
creation_date	string	Date of creation of this contact. Preferred format: 'YYYY-MM-DD HH:mm:ss'
last_contacted_date	string	Date/time of last interaction with contact. Preferred format: 'YYYY-MM-DD HH:mm:ss'
email	string	Contact's personal email address.
email_work	string	Contact's work email address.
phone_cell	string	Contact's cell phone number, preferred format: '(555)555-1234'
phone_home	string	Contact's home phone number, preferred format: '(555)555-1234'
phone_office	string	Contact's office phone number, preferred format: '(555)555-1234'
ok_to_call	boolean	Indicator whether it is OK to call this contact. True or 1 - Yes False or 0 -No
ok_to_email	boolean	Indicator whether it is OK to call this contact. True or 1 - Yes False or 0 -No
ok_to_mail	boolean	Indicator whether it is OK to call this contact. True or 1 - Yes False or 0 -No
referred_by	string	Name of person by whom this contact was referred.
source	string	Source of the contact.
credit_score	string	Total Expert credit rating of the lead. Available values: Excellent, Good, Fair, Poor, Very Poor.
credit_score_date	string	Date/time of contact's last received credit score. Preferred format: 'YYYY-MM-DD HH:mm:ss'

Opportunity Attributes

Field	Data Type	Description
property_value	integer
property_county	string	County which the property to be financed is located, e.g. Alameda
property_zip	string	Postal Code of the property to be financed, e.g. 90210
property_state	string	State which the property is located. Preferred format is two character state abbreviation, e.g. 'CA'
property_msa	string	Metropolitan area which the property is located, e.g. 'Greater Los Angeles'
loan_amount	integer	Estimated loan amount requested, e.g. 250000
loan_down_payment	integer	Estimated down payment requested, e.g. 100000
loan_cash_out	integer	Estimated additional cash out amount requested, e.g. 10000
property_type	string	Type of property to be financed, e.g. 'Single Family Dettached'
property_use	string	Occupancy of the property to be financed, e.g. 'Owner Occupied'
loan_request_type	string	Loan purpose, e.g. “Purchase’ or “Cash-out Refinance’
lead_price	string	Amount charged by source to generate lead
tracking_number	string	Unique identifier assigned by the source for the lead
annual_income	decimal	Annual income of the lead.
first_time_buyer	boolean	Indicator if lead is a first time home buyer. True or 1 = Is a First Time Home Buyer
has_agent	boolean	Indicator if lead is working with a real estate agent. True or 1 = Is working with an Agent
is_military	boolean	Indicator if lead is active duty or a veteran. True or 1 = is active duty or a veteran
self_credit_rating	string	Estimated credit rating of contact. Preferred values: 'Excellent', 'Good', 'Fair', 'Poor', 'Very Poor'
bankruptcy	boolean	Indicator if lead has had bankruptcy. True or 1 = has had bankruptcy
foreclosure	boolean	Indicator if lead has had foreclosure. True or 1 = has had foreclosure
found_home	boolean	Indicator if lead has located the property they intend to finance. True or 1 = They have located a home.
property_purchase_price	decimal	Contracted purchase price of the property to be financed, e.g. 350000
is_fha_eligible	boolean	Indicator if lead is eligible for FHA product. True or 1 = Is eligible for FHA product.
is_va_loan	boolean	Indicator of the offer selected is VA eligible. True or 1 = VA Offer
present_ltv	decimal	Current Loan To Value ratio of the property to be financed. Rounded to the nearest thousandth, e.g. 71.123
proposed_ltv	decimal	Requested Loan To Value ratio of the property to be financed. Rounded to the nearest thousandth, e.g. 74.123
term	string	Requested or selected term of the offer, e.g. 30 year fixed
estimated_payment	decimal	Estimated payment of the selected offer, e.g. 1234.55
apr	decimal	Annual Percentage Rate of the selected offer. Rounded to the nearest thousandth, e.g. 3.625
market_value	decimal	Market value of the property to be financed. Rounded to the nearest thousandth, e.g. 350000.000
rate_offer	decimal	Note Rate of the selected offer. Rounded to the nearest thousandth, e.g. 3.125

Offers Attributes

The following represents the attributes of one offer object. Offers can be passed in an array [ ].

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description
offer_id	integer
offer_type	string	Amortization type of the offer, ex. Fixed
loan_program_name	string	Name of the loan program of the offer, ex. Conf 30 Yr Fixed
loan_amount	decimal	Loan amount used to generate the offer, ex. 250000
interest_rate	decimal	Interest rate of the offer, ex. 3.750
term	string	Amortization term of the offer, ex. 30
points	decimal	Price of the offer, ex. 1
investor	string	Investor used to generate the offer, ex. Wells Fargo
lock_term	integer	Lock period used to generate the offer, ex. 45
monthly_payment	decimal	Monthly Principle and Interest payment of the offer
down_payment	decimal	Down payment used to generate the offer
apr	decimal	Annual Percentage Rate of the offer

Custom Field Attributes

The optional custom attribute, if specified, should contain one or more objects, each object representing one custom field name and its value. The custom fields should be wrapped in an array:

\"custom\": [\n        {\n            \"field_name\": \"first_datetime\", \n            \"value\": \"07/21/2023 00:00:00\"\n        },\n        {\n            \"field_name\": \"date\", \n            \"value\": \"10/30/2023\"\n        }\n    ]\n\n

A custom field definition of type \"contact\" that matches the given field_name must already exist for the POST to succeed. A POST request will not create new, adhoc custom field definitions.

Attributes of a custom field

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description
field_name	string	The system name of the custom field.
value	variable, according to definition	A custom value matching the data type of the custom field definition.

","urlObject":{"path":["v1","leads"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"1115517a-8170-4394-aef5-ee2a00dc7e6c","name":"With Owner","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"owner_id\": 64,\n \"title\": \"Dr.\",\n \"first_name\": \"Bill\",\n \"last_name\": \"Nye\",\n \"email\": \"the_science_guy@aol.com\",\n \"address\": \"1234 Science Blvd\",\n \"city\": \"Los Angeles\",\n \"state\": \"CA\",\n \"zip_code\": \"90210\",\n \"phone_cell\": \"2134447777\",\n \"phone_home\": \"2134447777\",\n \"phone_office\": \"2134447777\",\n \"ok_to_email\": true,\n \"referred_by\": \"Albert Einstein\",\n \"credit_score\": \"Excellent\",\n \"source\": \"LeadSource\",\n \"owner\": {\n \"id\": 1234,\n \"external_id\": \"external-system-123\",\n \"email\": \"test@example.com\",\n \"username\": \"testtesterson-te\"\n },\n \"lead_opportunity\": {\n \"property_value\": 850000,\n \"property_county\": \"Alameda\",\n \"property_zip\": \"90010\",\n \"property_state\": \"CA\",\n \"property_msa\": \"LA\",\n \"loan_amount\": 850000,\n \"loan_down_payment\": 25000.00,\n \"loan_cash_out\": 0.00,\n \"property_type\": \"Single Family\",\n \"property_use\": \"Owner Occupied\",\n \"loan_request_type\": \"Purchase\",\n \"lead_price\": 50,\n \"tracking_number\": \"123456\",\n \"annual_income\": 250000,\n \"first_time_buyer\": true,\n \"has_agent\": true,\n \"is_military\": false,\n \"self_credit_rating\": \"Good\",\n \"bankruptcy\": false,\n \"foreclosure\": false,\n \"working_with_agent\": true,\n \"found_home\": true,\n \"property_purchase_price\": 850000,\n \"is_fha_eligible\": true,\n \"present_ltv\": 92.00,\n \"proposed_ltv\": 92.00,\n \"term\": \"30 year fixed\",\n \"estimated_payment\": 1500,\n \"apr\": 5.789,\n \"market_value\": 355000,\n \"rate_offer\": 3.625\n },\n \"lead_opportunity_offers\": [\n {\n \"offer_id\": 1,\n \"offer_type\": \"Fixed\",\n \"loan_program_name\": \"Conf 30 Yr Fixed \",\n \"loan_amount\": 855000.00\n },\n {\n \"offer_id\": 2,\n \"offer_type\": \"Fixed\",\n \"loan_program_name\": \"Conf 15 Yr Fixed \",\n \"loan_amount\": 855000.00\n }\n ],\n \"custom\": [\n {\n \"field_name\": \"my_custom_field\", \n \"value\": \"Super special value\"\n }\n ]\n}"},"url":"{{external_api_host}}/v1/leads"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"contact_id\": 58,\n \"lead_id\": 61\n}"},{"id":"57178638-d06f-46b3-bb13-570e4eb24d75","name":"With Lead Source","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Dr.\",\n \"first_name\": \"Bill\",\n \"last_name\": \"Nye\",\n \"email\": \"the_science_guy@aol.com\",\n \"address\": \"1234 Science Blvd\",\n \"city\": \"Los Angeles\",\n \"state\": \"CA\",\n \"zip_code\": \"90210\",\n \"phone_cell\": \"2134447777\",\n \"phone_home\": \"2134447777\",\n \"phone_office\": \"2134447777\",\n \"ok_to_email\": true,\n \"referred_by\": \"Albert Einstein\",\n \"credit_score\": \"Excellent\",\n \"source\": \"GoodLeads\",\n \"lead_opportunity\": {\n \"property_value\": 850000,\n \"property_county\": \"Alameda\",\n \"property_zip\": \"90010\",\n \"property_state\": \"CA\",\n \"property_msa\": \"LA\",\n \"loan_amount\": 850000,\n \"loan_down_payment\": 25000.00,\n \"loan_cash_out\": 0.00,\n \"property_type\": \"Single Family\",\n \"property_use\": \"Owner Occupied\",\n \"loan_request_type\": \"Purchase\",\n \"lead_price\": 50,\n \"tracking_number\": \"123456\",\n \"annual_income\": 250000,\n \"first_time_buyer\": true,\n \"has_agent\": true,\n \"is_military\": false,\n \"self_credit_rating\": \"Good\",\n \"bankruptcy\": false,\n \"foreclosure\": false,\n \"working_with_agent\": true,\n \"found_home\": true,\n \"property_purchase_price\": 850000,\n \"is_fha_eligible\": true,\n \"present_ltv\": 92.00,\n \"proposed_ltv\": 92.00,\n \"term\": \"30 year fixed\",\n \"estimated_payment\": 1500,\n \"apr\": 5.789,\n \"market_value\": 355000,\n \"rate_offer\": 3.625\n },\n \"lead_opportunity_offers\": [\n {\n \"offer_id\": 1,\n \"offer_type\": \"Fixed\",\n \"loan_program_name\": \"Conf 30 Yr Fixed \",\n \"loan_amount\": 855000.00\n },\n {\n \"offer_id\": 2,\n \"offer_type\": \"Fixed\",\n \"loan_program_name\": \"Conf 15 Yr Fixed \",\n \"loan_amount\": 855000.00\n }\n ],\n \"custom\": [\n {\n \"field_name\": \"my_custom_field\", \n \"value\": \"Super special value\"\n }\n ]\n}"},"url":"{{external_api_host}}/v1/leads"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"contact_id\": 58,\n \"lead_id\": 61\n}"},{"id":"141fc0ef-92a3-43df-92a8-17869591fb32","name":"With Custom Fields","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Dr.\",\n \"first_name\": \"Bill\",\n \"last_name\": \"Nye\",\n \"email\": \"the_science_guy@aol.com\",\n \"address\": \"1234 Science Blvd\",\n \"city\": \"Los Angeles\",\n \"state\": \"CA\",\n \"zip_code\": \"90210\",\n \"phone_cell\": \"2134447777\",\n \"phone_home\": \"2134447777\",\n \"phone_office\": \"2134447777\",\n \"ok_to_email\": true,\n \"referred_by\": \"Albert Einstein\",\n \"credit_score\": \"Excellent\",\n \"source\": \"GoodLeads\",\n \"lead_opportunity\": {\n \"property_value\": 850000,\n \"property_county\": \"Alameda\",\n \"property_zip\": \"90010\",\n \"property_state\": \"CA\",\n \"property_msa\": \"LA\",\n \"loan_amount\": 850000,\n \"loan_down_payment\": 25000.00,\n \"loan_cash_out\": 0.00,\n \"property_type\": \"Single Family\",\n \"property_use\": \"Owner Occupied\",\n \"loan_request_type\": \"Purchase\",\n \"lead_price\": 50,\n \"tracking_number\": \"123456\",\n \"annual_income\": 250000,\n \"first_time_buyer\": true,\n \"has_agent\": true,\n \"is_military\": false,\n \"self_credit_rating\": \"Good\",\n \"bankruptcy\": false,\n \"foreclosure\": false,\n \"working_with_agent\": true,\n \"found_home\": true,\n \"property_purchase_price\": 850000,\n \"is_fha_eligible\": true,\n \"present_ltv\": 92.00,\n \"proposed_ltv\": 92.00,\n \"term\": \"30 year fixed\",\n \"estimated_payment\": 1500,\n \"apr\": 5.789,\n \"market_value\": 355000,\n \"rate_offer\": 3.625\n },\n \"lead_opportunity_offers\": [\n {\n \"offer_id\": 1,\n \"offer_type\": \"Fixed\",\n \"loan_program_name\": \"Conf 30 Yr Fixed \",\n \"loan_amount\": 855000.00\n },\n {\n \"offer_id\": 2,\n \"offer_type\": \"Fixed\",\n \"loan_program_name\": \"Conf 15 Yr Fixed \",\n \"loan_amount\": 855000.00\n }\n ],\n \"custom\": [\n {\n \"field_name\": \"text_field\", \n \"value\": \"Super special value\"\n },\n {\n \"field_name\": \"integer_field\", \n \"value\": 5000\n },\n {\n \"field_name\": \"decimal_field\", \n \"value\": 349.99\n },\n {\n \"field_name\": \"boolean_field\", \n \"value\": true\n },\n {\n \"field_name\": \"date_field\", \n \"value\": \"04/30/1999\"\n },\n {\n \"field_name\": \"datetime_field\", \n \"value\": \"04/30/1999 15:10:11\"\n }\n ]\n}"},"url":"{{external_api_host}}/v1/leads"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"contact_id\": 58,\n \"lead_id\": 61\n}"}],"_postman_id":"e8a78f12-5f00-4cb2-965c-956c6c37edec"},{"name":"Update Lead Opportunity","id":"8a85a5ee-a44e-434b-9fe4-87cfe522067a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Mr.\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"suffix\": \"Jr.\",\n \"nickname\": \"Johnathon\",\n \"email\": \"jsmithtest@example.com\",\n \"address\": \"1234 Fake St\",\n \"address_2\": \"Apartment 8\",\n \"city\": \"Los Angeles\",\n \"state\": \"CA\",\n \"zip_code\": \"90210\",\n \"phone_cell\": \"5555555555\",\n \"phone_home\": \"2222222222\",\n \"phone_office\": \"7777777777\",\n \"ok_to_email\": true,\n \"referred_by\": \"Jane Smith\",\n \"credit_score\": \"Excellent\",\n \"source\": \"leadSourceName\",\n \"assigned_to\": 50,\n \"owner_id\": 50,\n \"lead_opportunity\": {\n \"property_value\": 350000,\n \"property_county\": \"Alameda\",\n \"property_zip\": \"90010\",\n \"property_state\": \"CA\",\n \"property_msa\": \"LA\",\n \"loan_amount\": 325000,\n \"loan_down_payment\": 25000,\n \"loan_cash_out\": 0,\n \"property_type\": \"Single Family\",\n \"property_use\": \"Owner Occupied\",\n \"loan_request_type\": \"Purchase\",\n \"lead_price\": 50,\n \"lead_stage\": 3,\n \"tracking_number\": \"123456\",\n \"annual_income\": 120000,\n \"first_time_buyer\": true,\n \"has_agent\": true,\n \"is_military\": false,\n \"self_credit_rating\": \"Good\",\n \"assigned_credit_value\": 700,\n \"bankruptcy\": false,\n \"foreclosure\": false,\n \"working_with_agent\": true,\n \"found_home\": true,\n \"property_purchase_price\": 350000,\n \"is_fha_eligible\": true,\n \"is_va_loan\": false,\n \"present_ltv\": 92.01,\n \"proposed_ltv\": 92.01,\n \"term\": \"30 year fixed\",\n \"estimated_payment\": 1500,\n \"apr\": 3.789,\n \"market_value\": 355000,\n \"rate_offer\": 3.625,\n \"contact_phone_extension\": \"55555\",\n \"consumer_geo_phone_area_code\": \"55555\"\n },\n \"lead_opportunity_offers\": [\n {\n \"offer_id\": 1,\n \"offer_type\": \"Fixed\",\n \"loan_program_name\": \"Conf 30 Yr Fixed \",\n \"loan_amount\": 255000.01,\n \"interest_rate\": 3.625,\n \"term\": \"30\",\n \"points\": 0.75,\n \"investor\": \"Total Expert(308)\",\n \"lock_term\": 45,\n \"monthly_payment\": 1367.34,\n \"down_payment\": 295000.99,\n \"apr\": 5.171\n },\n {\n \"offer_id\": 2,\n \"offer_type\": \"Fixed\",\n \"loan_program_name\": \"Conf 15 Yr Fixed \",\n \"loan_amount\": 255000.01,\n \"interest_rate\": 4.625,\n \"term\": \"180\",\n \"points\": 0.75,\n \"investor\": \"Total Expert\",\n \"lock_term\": 30,\n \"monthly_payment\": 1067.34,\n \"down_payment\": 295000.01,\n \"apr\": 6.171\n }\n ],\n \"custom\": [\n {\n \"field_name\": \"my_custom_field\", \n \"value\": \"Super special value\"\n }\n ]\n}\n"},"url":"{{external_api_host}}/v1/leads/{{lead_id}}","description":"

The PATCH request accepts any variant of the body specified below, allowing for partial modifications of the existing lead resource. Fields that are

Data Types

The PATCH is sensitive to data types, and will error if types do not align with the types in the request body below.

If the value of a given attribute does not match the type specified in PATCH validation, the request should fail and tell you why.

Accepted type details:

Integer values, real, positive values only
String values must be wrapped in double quotation marks, as in \"hello there\"
Decimals can be decimal values or integer values
Booleans must be true, false, 0, or 1. Strings 'true' and 'false' are NOT accepted.

Updating Lead Stage

lead_stage can be updated with an integer, 1 through 5, represneting the following lifecycle stages of a lead:

New Lead
Contacted
Application
In Process
Closed

Other values can be updated concurrently with lead_stage.

Updating Lead Opportunity Offers

offers can also be updated, but for each desired offer update, the offer_id of the given offer must be included, along with at least one other offer attribute

{\n    \"lead_opportunity\": { \n        \"property_value\": 50000000\n    },\n    \"lead_opportunity_offers\": [\n        {\n            \"offer_id\": 1,\n            \"investor\": \"Duckberg Inc\"\n        },\n        {\n            \"offer_id\": 2,\n            \"investor\": \"Duckberg Inc\"\n        },\n    ]\n}\n\n

Examples of Partial Modification Requests

As long as attributes are nested in their correct parent attribute, they will be considered valid for updating.

{\n    \"lead_stage\": 2,\n}\n\n

{\n    \"first_name\": \"Scrooge\",\n    \"lead_stage\": 2,\n}\n\n

{\n    \"lead_opportunity\": { \n        \"property_value\": 50000000\n    },\n    \"lead_opportunity_offers\": [\n        {\n            \"offer_id\": 2,\n            \"investor\": \"Duckberg Inc\"\n        }\n    ]\n}\n\n

{\n    \"first_name\": \"Scrooge\",\n    \"last_name\": \"McDuck\",\n    \"lead_opportunity\": { \n        \"property_value\": 50000000\n    },\n    \"lead_opportunity_offers\": [\n        {\n            \"offer_id\": 2,\n            \"investor\": \"Duckberg Inc\"\n        }\n    ]\n}\n\n

","urlObject":{"path":["v1","leads","{{lead_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[{"id":"177cb296-2998-4977-942c-968b002ba9ea","name":"Partial Modification","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Scrooge\",\n \"last_name\": \"McDuck\",\n \"city\": \"Duckberg\",\n}"},"url":"{{external_api_host}}/v1/leads/{{lead_id}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully updated lead.\"\n}"},{"id":"c0f5bfaa-b03f-40d0-9f44-8236f2b2b866","name":"Update Stage","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"lead_stage\": 2,\n}"},"url":"{{external_api_host}}/v1/leads/{{lead_id}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully updated lead.\"\n}"},{"id":"2a1444e6-27f4-410c-b7e9-d2004c4b5430","name":"Update Offers","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Scrooge\",\n \"last_name\": \"McDuck\",\n \"lead_opportunity\": { \n \"property_value\": 50000000\n },\n \"lead_opportunity_offers\": [\n {\n \"offer_id\": 2,\n \"investor\": \"Duckberg Inc\"\n }\n ]\n}"},"url":"{{external_api_host}}/v1/leads/{{lead_id}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully updated lead.\"\n}"}],"_postman_id":"8a85a5ee-a44e-434b-9fe4-87cfe522067a"}],"id":"deb7e9be-d797-4dfb-b02b-4f3c6519077e","description":"

Important Note: As part of Total Expert’s new Lead Management feature, a new endpoint has been created. Because both the new endpoint (v1/lead-opportunities) and this existing (v1/leads) endpoint deal with “leads” in the platform, there is a conflict with the nomenclature used by both endpoints.

This section of the documentation refers exclusively to the existing, older v1/leads endpoint designed for Advanced Lead Management (ALM).

For information on the new v1/lead-opportunities endpoint, please see the “Lead Opportunities (New)” section.

No functional changes were made to the endpoint.

Unless and until further notice, users cannot utilize both endpoints concurrently.

The Lead Opportunities endpoints allow lead providers to POST, GET, and PATCH lead and lead opportunity details, including offer details and custom fields.

Authentication and Authorization

There are two means of authenticating for Lead Opportunity endpoints.

The first is the typical bearer authentication flow, documented under the \"Authentication\" header above.
\n
Alternatively, the Lead Opportunities endpoints support \"Simple Auth,\" which can be enabled by Total Expert. \"Simple Auth\" supports authentication via an api_key attribute/value within request bodies, or else sending a header of api-key. Note the underscore and hypen differentiation, which is by design.
\n

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Settable Fields	Description
owner	Yes*	User	username, id, external_id, email	Owning user of the lead. One to many relationship, so returned as an object. *Only available on POST - changing owner on patch is not currently supported

Note: the use of the owner_id property is still supported, but deprecated in favor of this relationship.

Both means of authentication require the credentials to contain the leadOpportunityInteraction scope.

Optional: The _getUsers_ scope is required to retrieve unique user IDs from the _v1/users_ endpoint. User IDs are used to as _owner_id_ in _POST_ requests, should the request sender desire to assign a lead directly to a user.

\n","_postman_id":"deb7e9be-d797-4dfb-b02b-4f3c6519077e"},{"name":"Activity Endpoints","item":[{"name":"Fetch Activities","id":"4ac1ed2f-a8d2-4508-83a9-74b881223b4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{external_api_host}}/v1/activity","urlObject":{"path":["v1","activity"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4ac1ed2f-a8d2-4508-83a9-74b881223b4b"},{"name":"Fetch Activity","id":"f280597a-efff-4518-a66f-fb364f673e2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{external_api_host}}/v1/activity/{{activity_id}}","urlObject":{"path":["v1","activity","{{activity_id}}"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f280597a-efff-4518-a66f-fb364f673e2a"}],"id":"bff7e9af-f251-41a5-8938-ff89bcc95402","description":"

Endpoints for interacting with the activity resource.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Assignable	Type	Description
id	No	numeric	Generated identifier for activity.
details	No	string	Activity details
owner_id	No	numeric	Owner id of the activity
type	No	string	Activity type
title	No	string	Activity title
notes	No	text	Activity notes
note_id	No	numeric	Activity note id
contact_id	No	numeric	Contact id
created_at	No	timestamp	Date of the creation date for the activity. Format: 'YYYY-MM-DD HH:mm:ss'

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Relationship	Assignable	Type	Description
owner	No	User	Owning user of the activity.

Filtering

Use the 'filter=attribute_name=x,attribute_name_2=y' query to return the list of activities that meet the filter criteria. For example, to filter activities created between Oct. 14, 2017 17:41:01 (UTC) and Oct. 15, 2017 17:41:09 (UTC), the following query could be used:

/activity?filter=internal_created_at_start=2017-10-14T17:41:01Z,internal_created_at_end=2017-10-15T17:41:09Z

The supported filter attributes are shown in the following table.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
internal_created_at_start	ISO-8601 formatted date. The start of the time range of interest, inclusive.
internal_created_at_end	ISO-8601 formatted date. The end of the time range of interest, inclusive.
contact_id	Activity's contact id
type	Activity's type
owner_id	Activity's owner id

","_postman_id":"bff7e9af-f251-41a5-8938-ff89bcc95402"},{"name":"Email APIs","item":[{"name":"Archive Email","item":[{"name":"Archive Email - Encoded (id-{orgId}-{msgId})","id":"581a5272-b8f4-4127-94c1-84f4c9a490d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/email-archive/id-42-9001?filter=user_id=12345","description":"

Retrieves archived email content using the encoded messageId format: id-{organizationId}-{messageId}.

The organization ID embedded in the messageId is validated against the authenticated caller's organization. A mismatch returns 404 — not 403 — to avoid leaking whether a message exists.

Path parameter: id-{orgId}-{msgId} — replace 42 with the org ID and 9001 with the message ID.

Required filter: user_id={userId} — the user must belong to the caller's org.

\n","urlObject":{"path":["v1","email-archive","id-42-9001"],"host":["{{external_api_host}}"],"query":[{"description":{"content":"

Required. Comma-separated key=value pairs. Must include user_id. The user must belong to the caller's organization.

\n","type":"text/plain"},"key":"filter","value":"user_id=12345"}],"variable":[]}},"response":[{"id":"ea853154-38fb-4a6e-99b8-8fb12a0ae9e2","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": {\n \"file_name\": \"id-42-9001\",\n \"content\": \"Email content here\"\n },\n \"links\": {\n \"first\": 1,\n \"last\": 1,\n \"next\": null,\n \"prev\": null\n }\n}"}],"_postman_id":"581a5272-b8f4-4127-94c1-84f4c9a490d6"},{"name":"Archive Email - Raw numeric ({msgId})","id":"df633e17-9186-4538-be10-55ef9e893dbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{external_api_host}}/v1/email-archive/9001?filter=user_id=12345","description":"

Retrieves archived email content using a plain numeric messageId.

The organization is inferred from the authenticated caller's token — no org ID is embedded in the messageId. The caller's org is validated against the message sender's org inside the DataManager.

Path parameter: plain integer string — replace 9001 with the message ID.

Required filter: user_id={userId} — the user must belong to the caller's org.

\n","urlObject":{"path":["v1","email-archive","9001"],"host":["{{external_api_host}}"],"query":[{"description":{"content":"

Required. Comma-separated key=value pairs. Must include user_id. The user must belong to the caller's organization.

\n","type":"text/plain"},"key":"filter","value":"user_id=12345"}],"variable":[]}},"response":[{"id":"20936dd6-04f7-4289-8a82-47af738e55f5","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": {\n \"file_name\": \"9001\",\n \"content\": \"Email content here\"\n },\n \"links\": {\n \"first\": 1,\n \"last\": 1,\n \"next\": null,\n \"prev\": null\n }\n}"}],"_postman_id":"df633e17-9186-4538-be10-55ef9e893dbb"}],"id":"ef91c933-1f5d-45be-a159-394b80dcc78a","description":"

Endpoints for retrieving archived email content.

All requests require an OAuth2 Bearer token with the emailInteraction scope.

messageId Formats

Two formats are accepted for the {messageId} path parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Format	Example	Description
`id-{organizationId}-{messageId}`	`id-42-9001`	Encoded. Org ID must match caller's org or a `404` is returned.
`{messageId}`	`9001`	Raw numeric. Org is inferred from the caller's token.

Filter Parameter

The filter query parameter accepts comma-separated key=value pairs.

Required key: user_id — must be a TE user ID belonging to the caller's organization.

Example: filter=user_id=12345

Notes

Read-only endpoint — no POST, PATCH, or DELETE operations are supported.
\n
content is raw HTML — render it in a sandboxed context to avoid XSS exposure.
\n
404 instead of 403 on org mismatch — when the org embedded in an encoded messageId does not match the caller's org, the API returns 404 (not 403) intentionally, to avoid leaking whether a message exists.
\n
Raw numeric format has no early org check — for plain numeric messageId, the org is only validated inside the data layer by comparing the caller's org against the message sender's org fetched from the database. If they don't match, a 404 is returned.
\n
user_id must be in the caller's org — the user_id passed in the filter is verified against the organization_users table before any message lookup occurs.
\n
Caller must belong to an org — if the authenticated token has no associated organization, the request is rejected with 400.
\n

Response Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`items.file_name`	string	The `messageId` value passed in the request, returned as-is.
`items.content`	string	The full HTML content of the archived email.
`links.first`	numeric	Always `1` — pagination anchor.
`links.last`	numeric	Always `1` — single result, no paging.
`links.next`	null	Always `null` — no next page.
`links.prev`	null	Always `null` — no previous page.

Error Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Trigger
`400 Bad Request`	`messageId` is missing from the path.
`400 Bad Request`	`messageId` is not a plain integer and does not match the `id-{orgId}-{msgId}` pattern.
`400 Bad Request`	`user_id` is missing or non-numeric in the `filter` query parameter.
`400 Bad Request`	Authenticated caller has no associated organization.
`400 Bad Request`	`user_id` does not exist in the caller's organization.
`400 Bad Request`	Email archive file is missing or empty in storage.
`404 Not Found`	Encoded `messageId` contains an org ID that does not match the caller's org.
`404 Not Found`	No message found for the given ID, or message belongs to a different org.
`500 Internal Server Error`	Unexpected server-side failure retrieving the archive.

","_postman_id":"ef91c933-1f5d-45be-a159-394b80dcc78a"},{"name":"Email Template Render","item":[{"name":"Email Template Render - By template ID","id":"614c7bb0-e564-4067-9e97-d31ff5d8070f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"id\": 101,\n \"sender_id\": 12345,\n \"recipient\": {\n \"id\": 67890\n },\n \"loan_id\": 555,\n \"comarketer_id\": 9999,\n \"odc_push_result_id\": 77,\n \"video\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{external_api_host}}/v1/email-templates/render","description":"

Renders a saved email template by its id with placeholders resolved for the given sender, recipient, and optional context.

The template must belong to the caller's organization and be accessible to the sender.

Required: id, sender_id

Optional: recipient, loan_id, account_id, comarketer_id, odc_push_result_id, video, content.subject (overrides template subject)

\n","urlObject":{"path":["v1","email-templates","render"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"614c7bb0-e564-4067-9e97-d31ff5d8070f"},{"name":"Email Template Render - By inline HTML","id":"6785baa2-9559-484c-a93a-d1eade591fbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"content\": {\n \"html\": \"

Hello {{first_name}}, your rate is ready.

\",\n \"subject\": \"Hi {{first_name}}, a message from {{sender_first_name}}\"\n },\n \"sender_id\": 12345,\n \"recipient\": {\n \"id\": 67890\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{external_api_host}}/v1/email-templates/render","description":"

Renders inline HTML with placeholders resolved for the given sender and optional recipient context. No saved template is required.

Required: content.html, sender_id

Optional: content.subject, recipient, loan_id, account_id, comarketer_id, odc_push_result_id, video

\n","urlObject":{"path":["v1","email-templates","render"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6785baa2-9559-484c-a93a-d1eade591fbe"}],"id":"b6b27182-bbf0-4d8a-ac73-36880a645ab5","description":"

Endpoints for rendering email templates with variable substitution.

All requests require an OAuth2 Bearer token with the emailInteraction scope.

Overview

Renders an email template (by template ID or inline HTML) with placeholders resolved for a given sender, recipient, and optional context (loan, account, comarketer, video, ODC push result).

Request Body Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Required	Type	Description
`id`	Yes*	numeric	Template ID to render. Must be a positive integer. *Either `id` or `content.html` must be provided.
`content.html`	Yes*	string	Inline HTML to render instead of a saved template. *Either `id` or `content.html` must be provided.
`content.subject`	No	string	Custom subject line. If omitted, falls back to the saved template's subject.
`sender_id`	Yes	numeric	TE user ID of the sender. Must belong to the caller's organization.
`recipient`	No	object	Contact to resolve placeholders for. See Recipient Object below.
`comarketer_id`	No	numeric	TE user ID of a comarketer. Must be a valid comarketer for the sender.
`loan_id`	No	numeric	Loan ID to use for loan placeholder resolution. Must belong to the caller's org. Mutually exclusive with `account_id`.
`account_id`	No	numeric	Account ID to use for product placeholder resolution. Must belong to the caller's org. Mutually exclusive with `loan_id`.
`odc_push_result_id`	No	numeric	ODC push result ID for ODC placeholder resolution.
`video`	No	object	Video metadata to inject into the template.

Recipient Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Required	Type	Description
`id`	No	numeric	TE lead/contact ID. Must be a positive integer and belong to the caller's org.

Response Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`results[].recipient_id`	numeric	null
`results[].rendered_html`	string	Fully rendered HTML with all placeholders substituted.
`results[].rendered_subject`	string	Fully rendered subject line. Empty string if no subject was provided.

Org Validation

sender_id must belong to the caller's organization.
\n
loan_id (if provided) is validated via the loan officer's org.
\n
account_id (if provided) is validated via the account manager's org.
\n
recipient.id (if provided) is validated via the lead owner's org.
\n
Template id (if provided) must belong to the caller's org.
\n

Error Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Trigger
`400 Bad Request`	Neither `id` nor `content.html` is provided.
`400 Bad Request`	`id` is not a positive integer.
`400 Bad Request`	`sender_id` is missing or not a positive integer.
`400 Bad Request`	`sender_id` does not exist or does not belong to the caller's org.
`400 Bad Request`	`comarketer_id` is not a positive integer, or is not a valid comarketer for the sender.
`400 Bad Request`	`loan_id` is not a positive integer, or does not belong to the caller's org.
`400 Bad Request`	`account_id` is not a positive integer, or does not belong to the caller's org.
`400 Bad Request`	Both `loan_id` and `account_id` are provided (mutually exclusive).
`400 Bad Request`	`recipient` is not an object, or `recipient.id` is missing or not a positive integer.
`400 Bad Request`	`recipient.id` does not belong to the caller's org.
`403 Forbidden`	Authenticated user has no user ID or organization context.
`404 Not Found`	Template `id` not found for the sender, or belongs to a different org.
`500 Internal Server Error`	Template render failed unexpectedly.

Notes

id and content.html are mutually inclusive of at least one — if id is given, the saved template's HTML and subject are used as the base; content.html and content.subject override them if also provided.
\n
loan_id and account_id are mutually exclusive — providing both returns a 400.
\n
Recipient resolves contact placeholders — if recipient.id is provided, placeholders for contact, journey contact, and opportunity offers are all populated.
\n
Template org check uses org_id on the email record — not just the sender relationship.
\n

\n","_postman_id":"b6b27182-bbf0-4d8a-ac73-36880a645ab5"},{"name":"Upload Image","item":[{"name":"POST /user-images","id":"0cc8188f-9988-40bd-b96e-10d12622a2dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"image/jpeg","description":"

MIME type of the image. Allowed: image/jpeg, image/png, image/gif.

\n"},{"key":"X-User-Id","value":"12345","description":"

Required. TE user ID to upload the image for. Must be an integer and belong to the caller's organization.

\n"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"file","file":{"src":"/Users/amolp/Downloads/Photo.jpeg"}},"url":"{{external_api_host}}/v1/user-images","description":"

Uploads a user image as raw binary in the request body.

The image is stored in S3 under the target user's marketing images path and a record is created in the database.

Headers required:

Content-Type — MIME type of the image (image/jpeg, image/png, image/gif)
X-User-Id — TE user ID of the target user. Must belong to the same org as the caller.

Body: raw binary bytes of the image file. Max 5 MB.

\n","urlObject":{"path":["v1","user-images"],"host":["{{external_api_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0cc8188f-9988-40bd-b96e-10d12622a2dc"}],"id":"b1f21aae-f3f9-4fda-9169-fda18e0012b4","description":"

Endpoints for uploading user images.

All requests require an OAuth2 Bearer token with the emailInteraction scope.

Request Format

The image is sent as raw binary in the request body. The Content-Type header determines the image format.

Allowed Content Types

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Content-Type	Extension
`image/jpeg`	`.jpg`
`image/png`	`.png`
`image/gif`	`.gif`

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Required	Description
`Authorization`	Yes	Bearer token with `emailInteraction` scope.
`Content-Type`	Yes	MIME type of the image. Must be `image/jpeg`, `image/png`, or `image/gif`.
`X-User-Id`	Yes	TE user ID of the user to upload the image for. Must be an integer. Must belong to the same organization as the caller.

Org Validation

The caller and the target user (X-User-Id) must belong to the same organization. If they differ, a 404 is returned.

File Constraints

Maximum file size: 5 MB
\n
MIME type must match the Content-Type header — mismatches are rejected with 422.
\n

Response Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	numeric	Generated identifier for the uploaded image record.
`user_id`	numeric	TE user ID the image belongs to.
`url`	string	Public URL to access the uploaded image.
`filename`	string	Generated filename used to store the image.
`created_on`	string	Timestamp of upload. Format: `YYYY-MM-DD HH:mm:ss`.

Error Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Trigger
`400 Bad Request`	`Content-Type` header is missing or not one of the allowed types.
`400 Bad Request`	`X-User-Id` header is missing.
`400 Bad Request`	`X-User-Id` is not a valid integer.
`400 Bad Request`	Request body is empty.
`400 Bad Request`	File size exceeds 5 MB.
`404 Not Found`	Target user does not exist or is inactive.
`404 Not Found`	Target user belongs to a different organization than the caller.
`422 Unprocessable Entity`	MIME type of the uploaded file does not match the `Content-Type` header.
`500 Internal Server Error`	Upload to S3 failed.
`500 Internal Server Error`	Database record creation failed after successful upload.

Notes

Binary body only — the image must be sent as raw bytes in the request body, not as multipart/form-data.
\n
404 on org mismatch — a 404 (not 403) is returned when the target user belongs to a different org, to avoid leaking user existence.
\n
Filename is auto-generated — the original filename is not used; a random filename is generated server-side.
\n
Image is stored in S3 — the returned url is a public link to the uploaded file under the user's marketing images path.
\n

\n","_postman_id":"b1f21aae-f3f9-4fda-9169-fda18e0012b4"}],"id":"35e3ba1a-2c86-41eb-b9c1-5283d9f7757b","_postman_id":"35e3ba1a-2c86-41eb-b9c1-5283d9f7757b","description":""}],"event":[{"listen":"prerequest","script":{"id":"6c37aef8-cb52-497c-9d99-6e441335ff72","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a49376ad-a837-4fa8-9096-4d348c75180b","type":"text/javascript","exec":[""]}}]}

Documentation Layout

Authentication in the TE API

Endpoint Standards

Attributes

Data Types

Data Types

Phone Numbers

Uniqueness in the TE API

Relationships

'GET'ing

POST and PATCH Requests

Interacting with the API

Admin Calls vs User Calls

'GET'ing

Getting Individual Entities

Getting Multiple Entities (Paging)

Paging Links

'POST'ing

Deduplication

'PATCH'ing

'DELETE'ing

Return Codes

HTTP CODES

Authorization Header Encoding

Using The Token

Authorization Header Encoding

Authorization Code Encoding

Using The Token

Authorization Header Encoding

Refresh Token Encoding

Using The Token

Attributes

Contact Preferences

Relationships

Special POST/PATCH Relationships

Special POST/PATCH Attributes

POST/PATCH Options

Sorting

Filtering

Deduplication Logic

Attributes

Uniqueness

Relationships

Overview

Advantages of using the surveys endpoint

General Flow

Attributes

Contact Survey Question Attributes

Contact Survey Question Choice Answer Attributes

Filtering

Attributes

Contact Survey Question Response Attributes

Relationships

Attributes

Uniqueness

Relationships

Special POST/PATCH relationships

Type IDs

Filtering

Attributes

Recruit Info Attributes

Recruit Info Relationships

Recruit State License Attributes

Recruit Metric Attributes

Recruit Metric Relationships

Special POST/PATCH Attributes

Restrictions on Metrics

Attributes

Attributes

Attributes

Parameters

API Example

Granting Consent

Revoking Consent

Attributes

Attributes

Attributes

Uniqueness

Filtering

Attributes