{ "info": { "_postman_id": "99bf37ec-6dd2-4d01-9b7e-e43711ad83a9", "name": "Total Expert Public Account Endpoints Contact Endpoints API", "description": "The Total Expert REST API allows you to programmatically create, retrieve, update, and delete information through various endpoints.\n\nDocumentation Layout\n\nEach section of this documentation describes a collection of related endpoints that affect a given resource.\n\nWhere 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.\n\nNOTE: 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.\n\nAuthentication in the TE API\n\nInteraction with the TE API is protected with OAuth 2.0. A client ID/secret pair is required to use the API.\n\nThe 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.\n\nNOTE: See the 'Authentication' endpoint collection for more information. See the 'Heartbeats' endpoint collection for more information on how to test your authentication.\n\nEndpoint Standards\n\nEach endpoint provides interaction with two aspects of an entity:\n\n'Attributes' - Attributes of the entity itself. Includes things like first name, phone number, or birthday of the contact.\nE.g. A 'Contact'\n\n'Relationships' - Describe a relationship between that entity and another entity.\nE.g. A contact that has an owner in the TE System OR a set of contact groups (separate entities with their own endpoint).\n\nAttributes\n\nEach 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.\n\nData Types\n\nEach attribute has a type. There are four data types in the TE API - Numeric, String, Boolean, and Date.\n\nData Types\n\nType\nDescription\n\nNumeric\nInteger or floating point numbers. Supplied with no surrounding quotes. e.g. { \"loan_rate\":4.5 }\n\nString\nString of characters - supplied surrounded with quotes. e.g. { \"first_name\":\"Clark\" }\n\nBoolean\nTruth value - supplied in one of two ways - see Boolean (String) and Boolean (Numeric) for details\n\nBoolean (String)\nTruth value - supplied as the word \"True\" or \"False\", surrounded by quotes. e.g. { \"first_time_buyer\":\"True\" }\n\nBoolean (Numeric)\nTruth value - supplied as the number 1 or 0, not surrounded by quotes. e.g. { \"first_time_buyer\":0 }\n\nDate\nA 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\".\n\nPhone Numbers\n\nPhone 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.\n\nAll 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.\n\nUniqueness in the TE API\n\nEach 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.\n\nRelationships\n\nRelationships in the TE API are very flexible.\n\n'GET'ing\n\nWhen 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.\n\nPOST and PATCH Requests\n\nWhen setting a relationship (by POST or PATCH), the target entity is specified using one or more attributes that uniquely identify the entity.\n\nThe 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:\n\n{\n \"group_name\": \"Hot Leads\",\n \"owner\":{\"username\": \"alfred\"}\n }\n OR\n\n{\n \"group_name\": \"Hot Leads\",\n \"owner\":{\"id\": \"123589\"}\n }\n\nIn 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.\n\nInteracting with the API\n\nAdmin Calls vs User Calls\n\nYou'll notice that many sections of the documentation have samples for POSTs and GETs that are labeled \"As Admin\" or \"As User\".\nWhen 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.\n\n'GET'ing\n\nThere 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.\n\nGetting Individual Entities\n\nIndividual 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).\n\nGetting Multiple Entities (Paging)\n\nPaging 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.\n\nPaging Links\n\nThe 'links' attribute on a page object will have four attributes, specifying metadata about the number of entities available to page.\n\n'first' will be the page number of the first page of entities (always '1').\n\n'last' will be the page number of the last page of entities.\n\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\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\n'POST'ing\n\nEntities can be created in the TE system by POSTing to paging endpoints. E.g. sending a POST to '/contacts' will create a contact.\n\nDeduplication\n\nWhen 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.\n\n'PATCH'ing\n\nEntities 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'.\n\n'DELETE'ing\n\nEntities can be deleted only by TE ID. Send a DELETE request to the appropriate individual entity endpoint to delete it.\n\nReturn Codes\n\nWhere applicable, the API will respond with an HTTP status code that indicates what happened during the request. Possible values include:\n\nHTTP CODES\n\nStatus Code\nGeneral Description\n\n200 SUCCESS\nThe operation completed successfully. See the response body for details (if applicable).\n\n201 CREATED\nThe object was created successfully. See the response body for details (if applicable).\n\n400 BAD REQUEST\nThe JSON supplied to the API was malformed and unparseable.\n\n401 UNAUTHORIZED\nThe request's credentials are invalid. This could mean your token has expired and should be renewed. See the response body for details.\n\n403 FORBIDDEN\nAn attempt was made to access a resource for which you do not have permission\n\n405 METHOD NOT ALLOWED\nAn attempt was made to interact with an endpoint in an unsupported manner, e.g. sending a POST to '/contacts/1'\n\n415 UNSUPPORTED MEDIA TYPE\nThe API endpoints expect a content type of 'media/json'\n\n422 UNPROCESSABLE ENTITY\nThe 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.\n\n418 I'M A TEAPOT\nThe API is a teapot (See the 'Heartbeat' section for details).\n\n503 SERVICE UNAVAILABLE\nThe 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.1.0/collection.json", "createdAt": "2026-07-28T03:17:12.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "lastUpdatedBy": "35240", "uid": "35240-99bf37ec-6dd2-4d01-9b7e-e43711ad83a9" }, "item": [ { "name": "v1", "item": [ { "name": "contacts", "item": [ { "name": "{contact_id}", "item": [ { "name": "Fetch Contact", "id": "e52d1e70-72f5-443a-b20b-ed6639682841", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contacts/:contact_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", ":contact_id" ], "variable": [ { "id": "1d26c454-503c-4e35-b548-b7ff6b0a224c", "key": "contact_id", "value": "", "description": "(Required) " } ] }, "description": "Fetch a specific contact specified by ID." }, "response": [ { "id": "a1a446ef-4efd-428c-bd6a-39be0f416377", "name": "Fetch Contact (as User)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contacts/:contact_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", ":contact_id" ], "variable": [ { "key": "contact_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\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 \"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_name\": \"BigIndustry Co, Inc. LLC\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"external_id\": \"101010\",\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_name\": \"Gable\",\n \"license_number\": \"Q10101010101011\",\n \"list_date\": \"2016-12-25\",\n \"ok_to_call\": false,\n \"ok_to_email\": false,\n \"ok_to_mail\": false,\n \"phone_cell\": \"(763)555-0123\",\n \"phone_home\": \"(612)-555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"referred_by\": \"\",\n \"referred_to\": \"\",\n \"source\": \"OurSystem\",\n \"state\": \"MN\",\n \"title\": \"Doctor\",\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 \"username\": \"ironExpert\"\n },\n \"owner\": {\n \"email\": \"stevie.dodgers@expert.com\",\n \"external_id\": \"captainExpertExternal\",\n \"username\": \"captainExpert\"\n },\n \"shared_with_users\": [\n {\n \"email\": \"pete.park@expert.com\",\n \"external_id\": \"spiderExpertExternal\",\n \"username\": \"spiderExpert\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-a1a446ef-4efd-428c-bd6a-39be0f416377" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-e52d1e70-72f5-443a-b20b-ed6639682841" }, { "name": "Update Contact", "id": "4591f86b-f39d-48b5-95a0-f70f239497ba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"example\": {\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 }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contacts/:contact_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", ":contact_id" ], "variable": [ { "id": "b075ca7d-f0b5-4cd5-a050-a301b96deb26", "key": "contact_id", "value": "", "description": "(Required) " } ] }, "description": "Update an existing contact by ID." }, "response": [ { "id": "5955ce79-d179-4ee0-aaa3-512e386b61ea", "name": "Success. See the Total Expert Public API documentation for the response shape.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"example\": {\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 }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contacts/:contact_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", ":contact_id" ], "variable": [ { "key": "contact_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-5955ce79-d179-4ee0-aaa3-512e386b61ea" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-4591f86b-f39d-48b5-95a0-f70f239497ba" }, { "name": "Delete Contact", "id": "84000cef-2d54-471f-9ba3-8b77aad3338e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/contacts/:contact_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", ":contact_id" ], "variable": [ { "id": "12114239-b272-407e-9996-20facde77533", "key": "contact_id", "value": "", "description": "(Required) " } ] }, "description": "Delete a contact by ID." }, "response": [ { "id": "d268492d-58aa-4d6c-ba16-bc4cbe82dd5d", "name": "Success. See the Total Expert Public API documentation for the response shape.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contacts/:contact_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", ":contact_id" ], "variable": [ { "key": "contact_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-d268492d-58aa-4d6c-ba16-bc4cbe82dd5d" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-84000cef-2d54-471f-9ba3-8b77aad3338e" } ], "id": "98fbc864-945e-4744-89b3-9b60a5b8792c", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-98fbc864-945e-4744-89b3-9b60a5b8792c" }, { "name": "Fetch Contacts", "id": "98919743-cd45-4b62-b884-fb39bfa210ab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/contacts?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] }, "description": "Fetch a page of contacts. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters." }, "response": [ { "id": "df7007a8-1b48-4a4c-85ff-a9dd0ba022bb", "name": "Success. See the Total Expert Public API documentation for the response shape.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contacts?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-df7007a8-1b48-4a4c-85ff-a9dd0ba022bb" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-98919743-cd45-4b62-b884-fb39bfa210ab" }, { "name": "Create Contact (as Admin)", "id": "889c7f29-0272-4d1a-9340-5d27eb598fa3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\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 {\n \"field_name\": \"custom_string\",\n \"value\": \"the custom field string value\"\n }\n ],\n \"external_ids\": [\n {\n \"source\": \"local\",\n \"external_id\": \"abcd\"\n }\n ],\n \"external_status\": {\n \"status_name\": \"Processing\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contacts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts" ] }, "description": "Create a contact.\n\nRequired Attributes (one of the following combinations):\n\nsource, first_name, last_name, email\n\nsource, first_name, last_name, phone_cell\n\nsource, first_name, last_name, phone_home\n\nsource, first_name, last_name, phone_office\n\nsource, first_name, last_name, address, city, state, zip_code\n\nRequired Relationships:\n\nowner*\n\n*required if authenticated as an organization admin\n\nAlternate documented request: Create Contact (as User).\n\nAlternate documented request: Create Contact (as Admin) with Entity.\n\nAlternate documented request: Grant Consent on Create." }, "response": [ { "id": "3b00e733-5f5d-4840-a8b2-d3e529a0ee6e", "name": "Update Contact (as Admin)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\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 {\n \"field_name\": \"custom_string\",\n \"value\": \"the custom field string value\"\n }\n ],\n \"external_ids\": [\n {\n \"source\": \"local\",\n \"external_id\": \"abcd\"\n }\n ],\n \"external_status\": {\n \"status_name\": \"Processing\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contacts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\n \"duplicate\": \"external-api.totaldev.us/v1/contacts/56495\",\n \"id\": 56495\n }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-3b00e733-5f5d-4840-a8b2-d3e529a0ee6e" }, { "id": "be455497-ea03-4655-9793-aff513bf7f15", "name": "Create Contact (as Admin)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\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 {\n \"field_name\": \"custom_string\",\n \"value\": \"the custom field string value\"\n }\n ],\n \"external_ids\": [\n {\n \"source\": \"local\",\n \"external_id\": \"abcd\"\n }\n ],\n \"external_status\": {\n \"status_name\": \"Processing\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contacts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\n \"created\": \"{external_api_host}/v1/contacts/56495\",\n \"id\": 56495\n }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-be455497-ea03-4655-9793-aff513bf7f15" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-889c7f29-0272-4d1a-9340-5d27eb598fa3" }, { "name": "Grant Consent on Update", "id": "0f9333d6-abf0-4c71-9467-eda1a45fcd10", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\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 }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contacts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts" ] }, "description": "Alternate documented request: Revoke Consent." }, "response": [ { "id": "dd20e74a-61b2-41d1-9cd3-d16ab7b2166e", "name": "Success. See the Total Expert Public API documentation for the response shape.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\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 }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contacts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-dd20e74a-61b2-41d1-9cd3-d16ab7b2166e" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-0f9333d6-abf0-4c71-9467-eda1a45fcd10" } ], "id": "51a1043b-e8fd-4c18-9036-35f649750069", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-51a1043b-e8fd-4c18-9036-35f649750069" }, { "name": "contact-groups", "item": [ { "name": "{contact_group_id}", "item": [ { "name": "Fetch Contact Group", "id": "8d056380-182b-4e95-b171-cf200576f6d4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contact-groups/:contact_group_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-groups", ":contact_group_id" ], "variable": [ { "id": "6098cc4b-282c-443d-b0f3-67be37d56d08", "key": "contact_group_id", "value": "", "description": "(Required) " } ] }, "description": "Fetch a contact group by ID." }, "response": [ { "id": "f13dd9c7-276b-48ee-8961-3dd79da4e6a7", "name": "Fetch Contact Group (as User)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contact-groups/:contact_group_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-groups", ":contact_group_id" ], "variable": [ { "key": "contact_group_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\n \"group_name\": \"My Group\",\n \"id\": 15643,\n \"user_editable\": false\n }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-f13dd9c7-276b-48ee-8961-3dd79da4e6a7" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-8d056380-182b-4e95-b171-cf200576f6d4" }, { "name": "Update Contact Group", "id": "23a3d7a5-c127-461d-a270-17b2217d73a6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"example\": {\n \"group_name\": \"My Group\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-groups/:contact_group_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-groups", ":contact_group_id" ], "variable": [ { "id": "868621be-b567-44b7-8402-a221193ed7fb", "key": "contact_group_id", "value": "", "description": "(Required) " } ] }, "description": "Update an existing contact group by ID." }, "response": [ { "id": "8ea211cc-29cc-44f8-b6e6-11f4832fcd08", "name": "Update Contact Group", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"example\": {\n \"group_name\": \"My Group\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-groups/:contact_group_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-groups", ":contact_group_id" ], "variable": [ { "key": "contact_group_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": []\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-8ea211cc-29cc-44f8-b6e6-11f4832fcd08" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-23a3d7a5-c127-461d-a270-17b2217d73a6" }, { "name": "Delete Contact Group", "id": "6f6ff605-8bcd-4ae9-b6f6-348718375992", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contact-groups/:contact_group_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-groups", ":contact_group_id" ], "variable": [ { "id": "82e52dcf-0795-46f6-b199-0c30db358ccc", "key": "contact_group_id", "value": "", "description": "(Required) " } ] }, "description": "Deletes a contact group by ID." }, "response": [ { "id": "5d847f4a-17e9-49da-a768-261c9d4c4054", "name": "Delete Contact Group", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contact-groups/:contact_group_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-groups", ":contact_group_id" ], "variable": [ { "key": "contact_group_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": []\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-5d847f4a-17e9-49da-a768-261c9d4c4054" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-6f6ff605-8bcd-4ae9-b6f6-348718375992" } ], "id": "dc5dfb39-8f19-48b5-926d-e03c83635df5", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-dc5dfb39-8f19-48b5-926d-e03c83635df5" }, { "name": "Fetch Contact Groups", "id": "e0e332e1-fb78-4e5e-9ca7-8733dcaec7f3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contact-groups?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-groups" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] }, "description": "Fetch a page of contact groups. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters." }, "response": [ { "id": "2f7f517c-86ea-46e6-ae87-f074c4c6469f", "name": "Fetch Contact Groups (as Admin)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contact-groups?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-groups" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": [\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}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-2f7f517c-86ea-46e6-ae87-f074c4c6469f" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-e0e332e1-fb78-4e5e-9ca7-8733dcaec7f3" }, { "name": "Create Contact Group (as Admin)", "id": "a3be0035-3d86-4f14-800c-9ec2379263c9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\n \"group_name\": \"My Group\",\n \"owner\": {\n \"external_id\": \"userExternal1\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-groups" ] }, "description": "Create a contact group.\n\nRequired Attributes:\n\ngroup_name\n\nRequired Relationships:\n\nowner*\n\n*required if authenticated as an organization admin\n\nAlternate documented request: Create Contact Group (as User)." }, "response": [ { "id": "31b5e6ee-6dcd-457b-894a-4fafda49b208", "name": "Create Contact Group (as Admin)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\n \"group_name\": \"My Group\",\n \"owner\": {\n \"external_id\": \"userExternal1\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-groups" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\n \"created\": \"{{external_api_host}}/v1/contact-groups/15643\",\n \"id\": 15643\n }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-31b5e6ee-6dcd-457b-894a-4fafda49b208" }, { "id": "24259fba-75d8-4dff-a036-4daa10d8c013", "name": "Owner not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\n \"group_name\": \"My Group\",\n \"owner\": {\n \"external_id\": \"userExternal1\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-groups" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\n \"error\": \"Unable to find target for relationship: 'owner'\"\n }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-24259fba-75d8-4dff-a036-4daa10d8c013" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-a3be0035-3d86-4f14-800c-9ec2379263c9" } ], "id": "be56761a-2fb2-45fa-b1cc-a6bc82d9e57c", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-be56761a-2fb2-45fa-b1cc-a6bc82d9e57c" }, { "name": "contact-surveys", "item": [ { "name": "{contact_survey_id}", "item": [ { "name": "Get Contact Survey", "id": "7d9c27a2-b94a-431c-b256-62d9633400bd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contact-surveys/:contact_survey_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-surveys", ":contact_survey_id" ], "variable": [ { "id": "fa16f719-cde2-4a0f-8e8a-69201b9e833e", "key": "contact_survey_id", "value": "", "description": "(Required) " } ] }, "description": "Fetch a specific survey specified by ID." }, "response": [ { "id": "69e9ce26-50aa-4d78-aa46-2ef586859727", "name": "Get Contact Survey", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contact-surveys/:contact_survey_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-surveys", ":contact_survey_id" ], "variable": [ { "key": "contact_survey_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\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 \"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 \"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 \"question_text\": \"What is your maximum price range?\",\n \"sort_order\": \"1\",\n \"system_name\": \"max_price\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-69e9ce26-50aa-4d78-aa46-2ef586859727" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-7d9c27a2-b94a-431c-b256-62d9633400bd" }, { "name": "Update Contact Survey", "id": "291a71fe-5936-4107-aac0-80f51a6acbb5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"example\": {\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 }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-surveys/:contact_survey_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-surveys", ":contact_survey_id" ], "variable": [ { "id": "bf03f694-cde5-4c96-876d-b556891340b9", "key": "contact_survey_id", "value": "", "description": "(Required) " } ] }, "description": "Update a survey.\n\nRequired Attributes:\n\nAt least one questions array, which could be empty." }, "response": [ { "id": "050b2a0f-f7da-4ce3-9b08-960ca0173894", "name": "Update Contact Survey", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"example\": {\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 }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-surveys/:contact_survey_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-surveys", ":contact_survey_id" ], "variable": [ { "key": "contact_survey_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\n \"created\": \"public.totalexpert.net/v1/contact-surveys/69003b93703638cf\"\n }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-050b2a0f-f7da-4ce3-9b08-960ca0173894" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-291a71fe-5936-4107-aac0-80f51a6acbb5" } ], "id": "07080bdb-6b2d-4fce-843a-03c5601776ad", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-07080bdb-6b2d-4fce-843a-03c5601776ad" }, { "name": "Get Contact Surveys", "id": "8ce75658-07b4-4402-959d-264843d1a94c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/contact-surveys?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-surveys" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] }, "description": "Fetch a page of surveys. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters." }, "response": [ { "id": "723d32bd-87a9-45b2-a918-a159e299f8e7", "name": "Success. See the Total Expert Public API documentation for the response shape.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contact-surveys?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-surveys" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-723d32bd-87a9-45b2-a918-a159e299f8e7" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-8ce75658-07b4-4402-959d-264843d1a94c" }, { "name": "Create Contact Survey", "id": "7ff6c4ea-d159-4f4d-b624-661f2e87e913", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"example\": {\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 }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-surveys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-surveys" ] }, "description": "Create a survey.\n\nRequired Attributes:\n\nsource\n\nsurvey_name\n\nquestions\n\nquestions.question_text\n\nquestions.system_name\n\nquestions.data_type" }, "response": [ { "id": "87091da2-464d-400c-ac28-3e1d2bacc12f", "name": "Create Contact Survey", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"example\": {\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 }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-surveys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-surveys" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\n \"created\": \"public.totalexpert.net/v1/contact-surveys/69003b93703638cf\"\n }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-87091da2-464d-400c-ac28-3e1d2bacc12f" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-7ff6c4ea-d159-4f4d-b624-661f2e87e913" } ], "id": "de50e15a-77b0-4686-a6a7-8275ccc432b4", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-de50e15a-77b0-4686-a6a7-8275ccc432b4" }, { "name": "contact-survey-responses", "item": [ { "name": "{contact_survey_response_id}", "item": [ { "name": "Get Contact Survey Response", "id": "dcb5eebe-dce0-4a66-b74e-6e3e89da1460", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contact-survey-responses/:contact_survey_response_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-survey-responses", ":contact_survey_response_id" ], "variable": [ { "id": "66b9747d-e504-4158-9549-9c934c14dc7b", "key": "contact_survey_response_id", "value": "", "description": "(Required) " } ] }, "description": "Fetch a specific survey response specified by ID." }, "response": [ { "id": "2aaef56c-bf0a-42af-91c7-bc0105647b5a", "name": "Get Contact Survey Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contact-survey-responses/:contact_survey_response_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-survey-responses", ":contact_survey_response_id" ], "variable": [ { "key": "contact_survey_response_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\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 \"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 \"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 \"question_text\": \"Any additional information you would like to leave?\",\n \"sort_order\": \"3\",\n \"system_name\": \"comments\"\n }\n }\n ]\n }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-2aaef56c-bf0a-42af-91c7-bc0105647b5a" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-dcb5eebe-dce0-4a66-b74e-6e3e89da1460" } ], "id": "c10a1206-72fd-4836-91db-1f15cec23c68", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-c10a1206-72fd-4836-91db-1f15cec23c68" }, { "name": "Get Contact Survey Responses", "id": "ae3e114e-8b46-4752-8a12-00fea4c95069", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/contact-survey-responses?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-survey-responses" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] }, "description": "Fetch a page of survey responses. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters." }, "response": [ { "id": "7a44a9b2-e540-468a-90f8-fbc204ca5bbf", "name": "Success. See the Total Expert Public API documentation for the response shape.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contact-survey-responses?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-survey-responses" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-7a44a9b2-e540-468a-90f8-fbc204ca5bbf" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-ae3e114e-8b46-4752-8a12-00fea4c95069" }, { "name": "Create Contact Survey Response (As User)", "id": "180f2690-22d4-4173-99c4-e1218b82b8e8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\n \"contact\": {\n \"id\": 4\n },\n \"survey\": {\n \"id\": \"69003b93703638cf\"\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 }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-survey-responses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-survey-responses" ] }, "description": "Create a response to a survey. Once created, responses may not be modified.\n\nRequired Attributes:\n\nquestion_responses\n\nRequired Relationships:\n\nsurvey\n\ncontact\n\nAlternate documented request: Create Contact Survey Response (As Admin)." }, "response": [ { "id": "5910be4a-b7d4-4b55-8541-b54c7e73c410", "name": "Create Contact Survey Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\n \"contact\": {\n \"id\": 4\n },\n \"survey\": {\n \"id\": \"69003b93703638cf\"\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 }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-survey-responses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-survey-responses" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\n \"created\": \"public.totalexpert.net/v1/contact-survey-responses/192c0803946dab25\"\n }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-5910be4a-b7d4-4b55-8541-b54c7e73c410" }, { "id": "ffd1fa4c-3fe2-4197-a6a4-c1111165aef0", "name": "Unknown contact", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\n \"contact\": {\n \"id\": 4\n },\n \"survey\": {\n \"id\": \"69003b93703638cf\"\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 }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-survey-responses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-survey-responses" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\n \"error\": \"Unable to find target for relationship: 'contact'\"\n }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-ffd1fa4c-3fe2-4197-a6a4-c1111165aef0" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-180f2690-22d4-4173-99c4-e1218b82b8e8" } ], "id": "47138fb0-1b2e-4c2a-a012-f5096e08ccc9", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-47138fb0-1b2e-4c2a-a012-f5096e08ccc9" }, { "name": "contact-notes", "item": [ { "name": "{contact_note_id}", "item": [ { "name": "Fetch Contact Note", "id": "fb90a9f3-b18a-4e76-837a-d881b9ccd8b7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contact-notes/:contact_note_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-notes", ":contact_note_id" ], "variable": [ { "id": "7cc958ed-b3a5-4e34-8424-d74cdebc3d3b", "key": "contact_note_id", "value": "", "description": "(Required) " } ] }, "description": "Fetch a contact notes by ID." }, "response": [ { "id": "2d5f4050-b779-4d74-9f70-29ca04be7030", "name": "Fetch Contact Note", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contact-notes/:contact_note_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-notes", ":contact_note_id" ], "variable": [ { "key": "contact_note_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\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 }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-2d5f4050-b779-4d74-9f70-29ca04be7030" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-fb90a9f3-b18a-4e76-837a-d881b9ccd8b7" }, { "name": "Update Contact Note", "id": "00078c86-8a00-48f8-859f-dfa9b47eea9a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"example\": {\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 }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-notes/:contact_note_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-notes", ":contact_note_id" ], "variable": [ { "id": "f6f85ceb-adbd-43f8-86c6-36e499a16cbb", "key": "contact_note_id", "value": "", "description": "(Required) " } ] }, "description": "Update an existing contact note by ID." }, "response": [ { "id": "2a5b198a-2a5d-4499-9ef4-a4795fbfe3a1", "name": "Update Contact Note", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"example\": {\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 }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-notes/:contact_note_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-notes", ":contact_note_id" ], "variable": [ { "key": "contact_note_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": []\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-2a5b198a-2a5d-4499-9ef4-a4795fbfe3a1" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-00078c86-8a00-48f8-859f-dfa9b47eea9a" }, { "name": "Delete Contact Note", "id": "be51dcda-41d2-4478-a412-a90051bc6a2f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contact-notes/:contact_note_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-notes", ":contact_note_id" ], "variable": [ { "id": "56945dd6-831d-4260-9f43-ff09c2d24f9a", "key": "contact_note_id", "value": "", "description": "(Required) " } ] }, "description": "Deletes a contact note by ID." }, "response": [ { "id": "7b81c7ad-5a99-4521-be33-14874654e213", "name": "Delete Contact Note", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contact-notes/:contact_note_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-notes", ":contact_note_id" ], "variable": [ { "key": "contact_note_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": []\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-7b81c7ad-5a99-4521-be33-14874654e213" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-be51dcda-41d2-4478-a412-a90051bc6a2f" } ], "id": "132022ce-c55e-4b43-bdce-cb41b7f1ab9c", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-132022ce-c55e-4b43-bdce-cb41b7f1ab9c" }, { "name": "Fetch Contact Notes", "id": "fba5f6eb-66ca-46a7-8031-8b0f75962862", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contact-notes?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-notes" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] }, "description": "Fetch a page of contact notes. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters." }, "response": [ { "id": "7522965a-d652-438b-828a-e7065328ebda", "name": "Fetch Contact Notes (as User)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contact-notes?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-notes" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": [\n {\n \"id\": 1,\n \"note\": \"Additional information pending\",\n \"title\": \"Contact info\",\n \"type_id\": \"1\",\n \"contact\": {\n \"id\": 45613\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 },\n {\n \"id\": 3,\n \"note\": \"This needs attention\",\n \"title\": \"Contact update success\",\n \"type_id\": \"2\",\n \"contact\": {\n \"id\": 65548\n }\n },\n {\n \"id\": 4,\n \"note\": \"Failed to push contact\",\n \"title\": \"Integration Note\",\n \"type_id\": \"2\",\n \"contact\": {\n \"id\": 65548\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-7522965a-d652-438b-828a-e7065328ebda" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-fba5f6eb-66ca-46a7-8031-8b0f75962862" }, { "name": "Create Contact Note (as User)", "id": "7976d537-1f8a-4457-82a4-0600f0de8f78", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\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 }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-notes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-notes" ] }, "description": "Create a contact note.\n\nRequired Attributes:\n\ntitle\n\nnote\n\ntype_id\n\nRequired Relationships:\n\ncontact\n\nAlternate documented request: Create Contact Note (as Admin)." }, "response": [ { "id": "73381466-ff0a-4929-8c9a-25c39e11cb57", "name": "Create Contact Note (as User)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\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 }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-notes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-notes" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\n \"created\": \"{external_api_host}/v1/contact-notes/14\",\n \"id\": 14\n }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-73381466-ff0a-4929-8c9a-25c39e11cb57" }, { "id": "d126a1b0-f7ae-4060-8e6b-c0c1e16fda72", "name": "Contact not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\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 }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-notes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-notes" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\n \"error\": \"Unable to find target for relationship: 'contact'\"\n }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-d126a1b0-f7ae-4060-8e6b-c0c1e16fda72" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-7976d537-1f8a-4457-82a4-0600f0de8f78" } ], "id": "944cf165-e33e-4dea-b635-7fb370d7b462", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-944cf165-e33e-4dea-b635-7fb370d7b462" }, { "name": "contact-recruits", "item": [ { "name": "{contact_id}", "item": [ { "name": "Fetch Contact Recruit", "id": "f9c2eb42-48e6-455b-8df4-16de88bde706", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contact-recruits/:contact_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruits", ":contact_id" ], "variable": [ { "id": "3be70f18-02b8-4904-bf43-eab5624cd0f8", "key": "contact_id", "value": "", "description": "(Required) " } ] }, "description": "Fetch a specific contact specified by ID." }, "response": [ { "id": "d04cf31e-b085-457f-8b34-6698d3caabb3", "name": "Fetch Contact Recruit", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contact-recruits/:contact_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruits", ":contact_id" ], "variable": [ { "key": "contact_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\n \"address\": \"1234 Bermuda St\",\n \"address_2\": \"Apt. 3\",\n \"birthday\": \"1900-01-01\",\n \"city\": \"Pleasantville\",\n \"classification\": \"\",\n \"creation_date\": \"2017-01-01 11:11:11\",\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_name\": \"Other Lender LLC\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"external_id\": \"101010\",\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_name\": \"Smith\",\n \"license_number\": \"Q10101010101011\",\n \"ok_to_call\": false,\n \"ok_to_email\": false,\n \"ok_to_mail\": false,\n \"phone_cell\": \"(763)555-0123\",\n \"phone_home\": \"(612)-555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"referred_by\": \"\",\n \"referred_to\": \"\",\n \"source\": \"Recruit Intake System\",\n \"state\": \"MN\",\n \"title\": \"Ms.\",\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 \"value\": \"30\",\n \"metric\": {\n \"metric_name\": \"Builders\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n }\n },\n {\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}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-d04cf31e-b085-457f-8b34-6698d3caabb3" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-f9c2eb42-48e6-455b-8df4-16de88bde706" }, { "name": "Update Contact Recruit", "id": "5247aa00-48cb-4c4b-b06a-9cb8d2bf9f54", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"example\": {\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\": \"50\"\n },\n {\n \"metric\": {\n \"metric_name\": \"Realtors\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"20\"\n },\n {\n \"metric\": {\n \"metric_name\": \"Sales Production\",\n \"metric_type\": \"sales_production\"\n },\n \"unit\": {\n \"unit_name\": \"dollars\"\n },\n \"value\": \"10123\",\n \"on_date\": \"2018\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-recruits/:contact_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruits", ":contact_id" ], "variable": [ { "id": "470419b6-6067-43d6-b170-ef92cf2f5f63", "key": "contact_id", "value": "", "description": "(Required) " } ] }, "description": "Update an existing contact by ID." }, "response": [ { "id": "c89e0624-9d27-45a0-af25-df34d65960bf", "name": "Remove Metric", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"example\": {\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\": \"50\"\n },\n {\n \"metric\": {\n \"metric_name\": \"Realtors\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n },\n \"value\": \"20\"\n },\n {\n \"metric\": {\n \"metric_name\": \"Sales Production\",\n \"metric_type\": \"sales_production\"\n },\n \"unit\": {\n \"unit_name\": \"dollars\"\n },\n \"value\": \"10123\",\n \"on_date\": \"2018\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-recruits/:contact_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruits", ":contact_id" ], "variable": [ { "key": "contact_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": []\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-c89e0624-9d27-45a0-af25-df34d65960bf" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-5247aa00-48cb-4c4b-b06a-9cb8d2bf9f54" }, { "name": "Delete Contact Recruit", "id": "e8594f36-13a3-4b96-bf0e-29209b418065", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/contact-recruits/:contact_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruits", ":contact_id" ], "variable": [ { "id": "c3c50daa-beae-4e06-9d28-c3797d4c8e75", "key": "contact_id", "value": "", "description": "(Required) " } ] }, "description": "Delete a contact by ID." }, "response": [ { "id": "66af693d-bd23-4181-a0a9-0da1be2acdb2", "name": "Success. See the Total Expert Public API documentation for the response shape.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contact-recruits/:contact_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruits", ":contact_id" ], "variable": [ { "key": "contact_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-66af693d-bd23-4181-a0a9-0da1be2acdb2" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-e8594f36-13a3-4b96-bf0e-29209b418065" } ], "id": "9fa4ac39-5191-4c89-ae0d-ad17933a5641", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-9fa4ac39-5191-4c89-ae0d-ad17933a5641" }, { "name": "Fetch Contact Recruits", "id": "a507a63f-f6b1-441e-bed8-47fa72e67d7b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contact-recruits?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruits" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] }, "description": "Fetch a page of contacts. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters." }, "response": [ { "id": "152b6622-d795-4872-841e-ff1fc007f291", "name": "Fetch Contact Recruits", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contact-recruits?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruits" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": [\n {\n \"address\": \"1234 Bermuda St\",\n \"address_2\": \"Apt. 3\",\n \"birthday\": \"1900-01-01\",\n \"city\": \"Pleasantville\",\n \"classification\": \"\",\n \"creation_date\": \"2017-01-01 11:11:11\",\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_name\": \"Other Lender LLC\",\n \"employer_state\": \"WI\",\n \"employer_zip\": \"54321\",\n \"external_id\": \"101010\",\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_name\": \"Smith\",\n \"license_number\": \"Q10101010101011\",\n \"ok_to_call\": false,\n \"ok_to_email\": false,\n \"ok_to_mail\": false,\n \"phone_cell\": \"(763)555-0123\",\n \"phone_home\": \"(612)-555-0123\",\n \"phone_office\": \"(763)555-1234\",\n \"referred_by\": \"\",\n \"referred_to\": \"\",\n \"source\": \"Recruit Intake System\",\n \"state\": \"MN\",\n \"title\": \"Ms.\",\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 \"value\": \"30\",\n \"metric\": {\n \"metric_name\": \"Builders\",\n \"metric_type\": \"business_source\"\n },\n \"unit\": {\n \"unit_name\": \"percent\"\n }\n },\n {\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}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-152b6622-d795-4872-841e-ff1fc007f291" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-a507a63f-f6b1-441e-bed8-47fa72e67d7b" }, { "name": "Create Contact Recruit (as Admin)", "id": "cc540451-d987-4e04-8bbc-5fa028be7ae4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\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 {\n \"metric\": {\n \"metric_name\": \"Sales Production\",\n \"metric_type\": \"sales_production\"\n },\n \"unit\": {\n \"unit_name\": \"dollars\"\n },\n \"value\": \"10123\",\n \"on_date\": \"2018\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-recruits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruits" ] }, "description": "Create a contact.\n\nRequired Attributes (one of the following combinations):\n\nsource, first_name, last_name, email\n\nsource, first_name, last_name, phone_cell\n\nsource, first_name, last_name, phone_home\n\nsource, first_name, last_name, phone_office\n\nsource, first_name, last_name, address, city, state, zip_code\n\nRequired Relationships:\n\nowner*\n\n*required if authenticated as an organization admin\n\nAlternate documented request: Create Contact Recruit (as User)." }, "response": [ { "id": "3776066b-1942-4cac-8162-ed4ed4b53123", "name": "Update Contact Recruit (as Admin)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\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 {\n \"metric\": {\n \"metric_name\": \"Sales Production\",\n \"metric_type\": \"sales_production\"\n },\n \"unit\": {\n \"unit_name\": \"dollars\"\n },\n \"value\": \"10123\",\n \"on_date\": \"2018\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-recruits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruits" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\n \"duplicate\": \"external-api.totaldev.us/v1/contact-recruits/520\",\n \"id\": 520\n }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-3776066b-1942-4cac-8162-ed4ed4b53123" }, { "id": "0f37d271-3838-477b-b525-439055134650", "name": "Create Contact Recruit (as Admin)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\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 {\n \"metric\": {\n \"metric_name\": \"Sales Production\",\n \"metric_type\": \"sales_production\"\n },\n \"unit\": {\n \"unit_name\": \"dollars\"\n },\n \"value\": \"10123\",\n \"on_date\": \"2018\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-recruits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruits" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\n \"created\": \"external-api.totaldev.us/v1/contact-recruits/520\",\n \"id\": 520\n }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-0f37d271-3838-477b-b525-439055134650" }, { "id": "5505f70e-f571-49e4-bb50-dc8bb0e4fd7c", "name": "Insufficient Scope", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"examples\": {\n \"value\": {\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 {\n \"metric\": {\n \"metric_name\": \"Sales Production\",\n \"metric_type\": \"sales_production\"\n },\n \"unit\": {\n \"unit_name\": \"dollars\"\n },\n \"value\": \"10123\",\n \"on_date\": \"2018\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contact-recruits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruits" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\n \"error\": \"insufficient_scope\",\n \"error_description\": \"The request requires higher privileges than provided by the access token\"\n }\n}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-5505f70e-f571-49e4-bb50-dc8bb0e4fd7c" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-cc540451-d987-4e04-8bbc-5fa028be7ae4" } ], "id": "e058e30c-6505-40ce-b4e4-aa67768cb609", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-e058e30c-6505-40ce-b4e4-aa67768cb609" }, { "name": "contact-recruit-statuses", "item": [ { "name": "Fetch Contact Recruit Statuses", "id": "bfa77a75-bc03-4ec9-9e45-2c4a291ae402", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contact-recruit-statuses?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruit-statuses" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] } }, "response": [ { "id": "70c32d53-7276-45f9-8a5d-96583cd1ee0a", "name": "Fetch Contact Recruit Statuses", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contact-recruit-statuses?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruit-statuses" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": [\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}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-70c32d53-7276-45f9-8a5d-96583cd1ee0a" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-bfa77a75-bc03-4ec9-9e45-2c4a291ae402" } ], "id": "5221715a-33ae-46a4-b3ff-32acc158fc93", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-5221715a-33ae-46a4-b3ff-32acc158fc93" }, { "name": "contact-recruit-metrics", "item": [ { "name": "Fetch Contact Recruit Metrics", "id": "3d681501-3e4c-45bf-91e0-3ece913ca17e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contact-recruit-metrics?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruit-metrics" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] } }, "response": [ { "id": "cca794ed-be23-4a50-b448-c00b13c71914", "name": "Fetch Contact Recruit Metrics", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contact-recruit-metrics?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruit-metrics" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": [\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}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-cca794ed-be23-4a50-b448-c00b13c71914" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-3d681501-3e4c-45bf-91e0-3ece913ca17e" } ], "id": "f4ae00ec-c0f6-47ed-ac67-a519a317b34e", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-f4ae00ec-c0f6-47ed-ac67-a519a317b34e" }, { "name": "contact-recruit-metric-units", "item": [ { "name": "Fetch Contact Recruit Metric Units", "id": "5de3d847-ebf1-4f4b-ac9e-922b1259312f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contact-recruit-metric-units?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruit-metric-units" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] } }, "response": [ { "id": "7a9f5d4a-fa25-44bf-844e-1ed7b69117be", "name": "Fetch Contact Recruit Metric Units", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/contact-recruit-metric-units?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact-recruit-metric-units" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": [\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}", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-7a9f5d4a-fa25-44bf-844e-1ed7b69117be" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-5de3d847-ebf1-4f4b-ac9e-922b1259312f" } ], "id": "90f0078f-d12d-4a05-bb4e-2647444d7681", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-90f0078f-d12d-4a05-bb4e-2647444d7681" }, { "name": "channels", "item": [ { "name": "Fetch Channels", "id": "83c1ee81-188c-4e2a-b534-9bc12985184e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/channels?page[number]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels" ], "query": [ { "key": "page[number]", "value": "" } ] }, "description": "Fetch a page of channels. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters." }, "response": [ { "id": "aa768af8-3067-4384-814b-12cc00def25f", "name": "Success. See the Total Expert Public API documentation for the response shape.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/channels?page[number]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "channels" ], "query": [ { "key": "page[number]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-aa768af8-3067-4384-814b-12cc00def25f" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-83c1ee81-188c-4e2a-b534-9bc12985184e" } ], "id": "78d7c587-831b-45b8-9e60-e6f175964830", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-78d7c587-831b-45b8-9e60-e6f175964830" }, { "name": "wlp-access-types", "item": [ { "name": "Fetch WLP Access Types", "id": "88b096f1-cdb5-4e18-b5ea-3cad5383add9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/wlp-access-types?page[number]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wlp-access-types" ], "query": [ { "key": "page[number]", "value": "" } ] }, "description": "Fetch a page of wlp access types. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters." }, "response": [ { "id": "9a4f1d79-fc23-4511-a6a6-18e8fa6ad1ae", "name": "Success. See the Total Expert Public API documentation for the response shape.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/wlp-access-types?page[number]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wlp-access-types" ], "query": [ { "key": "page[number]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-9a4f1d79-fc23-4511-a6a6-18e8fa6ad1ae" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-88b096f1-cdb5-4e18-b5ea-3cad5383add9" } ], "id": "bfc637ce-23da-4ab4-abf8-a7b3ab2dbce1", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-bfc637ce-23da-4ab4-abf8-a7b3ab2dbce1" }, { "name": "campaigns", "item": [ { "name": "{campaign_id}", "item": [ { "name": "Fetch Campaign", "id": "1110ca43-d51a-4094-bf82-8353a53d796e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id" ], "variable": [ { "id": "f3b7f43d-590f-4a40-855b-cac1d3493090", "key": "campaign_id", "value": "", "description": "(Required) " } ] }, "description": "Fetch a campaign by id." }, "response": [ { "id": "7302fbc0-7686-452f-95a7-61c6f92632cf", "name": "Success. See the Total Expert Public API documentation for the response shape.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/campaigns/:campaign_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id" ], "variable": [ { "key": "campaign_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-7302fbc0-7686-452f-95a7-61c6f92632cf" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-1110ca43-d51a-4094-bf82-8353a53d796e" } ], "id": "e106ded0-9ad3-4a52-bd95-bc5c817910a8", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-e106ded0-9ad3-4a52-bd95-bc5c817910a8" }, { "name": "Fetch Campaigns", "id": "9d7bd0f8-5739-4c5b-8a06-2636f8a6300d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns" ] }, "description": "Fetch a page of campaigns. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters." }, "response": [ { "id": "2f11883c-7748-41b0-9055-00c0762dc06c", "name": "Success. See the Total Expert Public API documentation for the response shape.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-2f11883c-7748-41b0-9055-00c0762dc06c" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-9d7bd0f8-5739-4c5b-8a06-2636f8a6300d" }, { "name": "Create Campaign", "id": "b3b1e126-c0f5-4138-816d-ee1a122e28bf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"example\": {\n \"name\": \"Campaign Test Name\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns" ] }, "description": "Create a campaign.\n\nRequired Attributes:\n\nname" }, "response": [ { "id": "7420feb9-ef79-4a59-b516-2255b5380e6f", "name": "Success. See the Total Expert Public API documentation for the response shape.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"example\": {\n \"name\": \"Campaign Test Name\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-7420feb9-ef79-4a59-b516-2255b5380e6f" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-b3b1e126-c0f5-4138-816d-ee1a122e28bf" } ], "id": "6bf35dc9-4365-4a49-8b24-fe0b0c0bea79", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-6bf35dc9-4365-4a49-8b24-fe0b0c0bea79" }, { "name": "campaign-activity", "item": [ { "name": "{campaign_activity_id}", "item": [ { "name": "Fetch Campaign Activity", "id": "9cdacc9e-fac5-431a-982c-c6ba4ae1a4cc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/campaign-activity/:campaign_activity_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaign-activity", ":campaign_activity_id" ], "variable": [ { "id": "1904eb50-0fbe-4031-bcc0-967e042447f4", "key": "campaign_activity_id", "value": "", "description": "(Required) " } ] }, "description": "Fetch a campaign activity by id." }, "response": [ { "id": "03d4eda3-7b1d-4425-805b-1591690f6df6", "name": "Success. See the Total Expert Public API documentation for the response shape.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/campaign-activity/:campaign_activity_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaign-activity", ":campaign_activity_id" ], "variable": [ { "key": "campaign_activity_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-03d4eda3-7b1d-4425-805b-1591690f6df6" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-9cdacc9e-fac5-431a-982c-c6ba4ae1a4cc" } ], "id": "230b65f5-1e3b-4e61-a257-245eebfa4f1f", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-230b65f5-1e3b-4e61-a257-245eebfa4f1f" }, { "name": "Create Campaign Activity", "id": "aa413b4a-8eee-4e25-a67e-30181a0f6e86", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"example\": {\n \"touched_at\": \"2019-01-01 10:00:00\",\n \"owner\": {\n \"id\": 50\n },\n \"contact\": {},\n \"campaign\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/campaign-activity", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaign-activity" ] }, "description": "Create a campaign activity.\n\nRequired Attributes:\n\n[none]\n\nRequired Relationsips:\n\ncontact\n\ncampaign" }, "response": [ { "id": "27829651-7ade-4f5f-a874-2901b9dd6297", "name": "Success. See the Total Expert Public API documentation for the response shape.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"example\": {\n \"touched_at\": \"2019-01-01 10:00:00\",\n \"owner\": {\n \"id\": 50\n },\n \"contact\": {},\n \"campaign\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/campaign-activity", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaign-activity" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-27829651-7ade-4f5f-a874-2901b9dd6297" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-aa413b4a-8eee-4e25-a67e-30181a0f6e86" }, { "name": "Delete Campaign Activity", "id": "8075a079-b840-46db-8871-f00fd463d1ba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/campaign-activity", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaign-activity" ] }, "description": "Delete a campaign activity record by id." }, "response": [ { "id": "c5264c0b-09df-4253-aae6-2aec48706a1d", "name": "Success. See the Total Expert Public API documentation for the response shape.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/campaign-activity", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaign-activity" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-c5264c0b-09df-4253-aae6-2aec48706a1d" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-8075a079-b840-46db-8871-f00fd463d1ba" }, { "name": "Fetch Campaign Activities", "id": "dee30dc6-94c0-45d7-b20e-70715b79434e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/campaign-activity?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaign-activity" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] }, "description": "Fetch a page of campaign activity records. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters." }, "response": [ { "id": "52bbdc37-8043-4587-9e1d-34bc30cac19a", "name": "Success. See the Total Expert Public API documentation for the response shape.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/campaign-activity?page[number]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaign-activity" ], "query": [ { "key": "page[number]", "value": "" }, { "key": "page[size]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-52bbdc37-8043-4587-9e1d-34bc30cac19a" } ], "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-dee30dc6-94c0-45d7-b20e-70715b79434e" } ], "id": "5aa6ad8d-b066-4cb5-bf1d-b55a1e59fd24", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-5aa6ad8d-b066-4cb5-bf1d-b55a1e59fd24" } ], "id": "532f1924-7c14-4496-9c3e-6180c337e3b3", "createdAt": "2026-07-28T03:17:13.000Z", "updatedAt": "2026-07-28T03:17:13.000Z", "uid": "35240-532f1924-7c14-4496-9c3e-6180c337e3b3" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "crm leadInteraction loanInteraction leadSurveyInteraction postLeads", "type": "string" }, { "key": "accessTokenUrl", "value": "https://public.totalexpert.net/v1/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://public.totalexpert.net" } ] }