This API endpoint allows you to create a new client record in the system via Thumbtack. Simply provide the Business Id and Business Name, along with any additional information about the client such as Customer Id, Name, and Phone. The data must be provided in JSON format for the API to function correctly.
\n","urlObject":{"protocol":"https","path":["v1","external-api","thumbtack","lead"],"host":["api","clienttether","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f98278ba-e874-4f2a-b7d3-743cafd0bea9"},{"name":"Create Manual Email","event":[{"listen":"prerequest","script":{"id":"31b21427-ee62-4028-aff4-c04d05196519","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"7bc242e0-5ad5-4b67-90d5-a80984d74fc1","exec":[""],"type":"text/javascript","packages":{}}}],"id":"92f82aef-3af7-4f24-8dad-0a924126e4c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.clienttether.com/v2/api/create_manual_email?client_id=22439909&email_subject=This is a test from create manual email API by Angel&email_body=This is the test body from an API call. It will send an email.","description":"This API endpoint facilitates the preparation for sending a manual email. The email, along with its subject and body, will be queued for delivery and logged in the History Notes as an Integration Assignment. If no specific date or time is supplied, the email will be sent immediately upon execution. The required parameters include the client ID, email subject, and email body. Upon successful execution, the API returns a status indicating either Success or Failure, based on the outcome of the operation.
\nExample of the successful response from the Create Manual Email API
\nExample of Email creation in ClientTether
\nRequired
\n","type":"text/plain"},"key":"client_id","value":"22439909"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"email_subject","value":"This is a test from create manual email API by Angel"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"email_body","value":"This is the test body from an API call. It will send an email."}],"variable":[]}},"response":[],"_postman_id":"92f82aef-3af7-4f24-8dad-0a924126e4c9"},{"name":"Create Client","event":[{"listen":"prerequest","script":{"id":"5e7d7738-ae12-41c2-aff2-937ef89cd504","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"83a455ec-6db8-41b3-bde0-988b3c2ffa0d","exec":[""],"type":"text/javascript","packages":{}}}],"id":"68d8dd54-0db7-418e-b01b-1d043b8a7b2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/create_client?firstName=AngelApi3&lastName=Api Testing&phone=5555555555&smsok=1&email=angel+1@clienttether.com&state=California","description":"This API endpoint allows you to create a new client record in the system. Simply provide the first name, last name, phone number, email address, and any additional information such as SMS permission, whiteboard details, notifications preference, and tags. Upon successful execution, a new client entry will be added to the system with the provided details.
\nExample of the successful response from the create client API
\nExample of client creation in ClientTether
\nRequired
\n","type":"text/plain"},"key":"firstName","value":"AngelApi3"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"lastName","value":"Api Testing"},{"description":{"content":"Phone Number (MAX LENGTH 10)
\n","type":"text/plain"},"key":"phone","value":"5555555555"},{"description":{"content":"1 = on 0 = off
\n","type":"text/plain"},"key":"smsok","value":"1"},{"description":{"content":"Valid Email Adress
\n","type":"text/plain"},"key":"email","value":"angel+1@clienttether.com"},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"lead_source_id","value":"219347"},{"disabled":true,"description":{"content":"This text will appear on the Whiteboard
\n","type":"text/plain"},"key":"whiteboard","value":"Api Test Angel"},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"new_lead_notification","value":"2"},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"tag","value":"test, API"},{"disabled":true,"key":"zip","value":"23564"},{"key":"state","value":"California"}],"variable":[]}},"response":[],"_postman_id":"68d8dd54-0db7-418e-b01b-1d043b8a7b2e"},{"name":"Create Client Event","event":[{"listen":"prerequest","script":{"id":"b98f00cb-dae0-4ba8-a926-e733eac85a39","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"3e9f8b3f-ae95-47a3-bf18-e82582184235","exec":[""],"type":"text/javascript","packages":{}}}],"id":"f77d2ab2-23df-4a61-ae26-9a822655da13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/create_client_event?client_id=9465522&event_type=Appointment&event_date=2023-12-25&event_time=08:30:00&event_note=This is a christmas event&event_manual_action_plan_id=182516&user_id=11672&event_end_date=2023-12-25&event_end_time=14:30:00","urlObject":{"protocol":"https","path":["v2","api","create_client_event"],"host":["api","clienttether","com"],"query":[{"key":"client_id","value":"9465522"},{"key":"event_type","value":"Appointment"},{"key":"event_date","value":"2023-12-25"},{"key":"event_time","value":"08:30:00"},{"key":"event_note","value":"This is a christmas event"},{"key":"event_manual_action_plan_id","value":"182516"},{"key":"user_id","value":"11672"},{"key":"event_end_date","value":"2023-12-25"},{"key":"event_end_time","value":"14:30:00"}],"variable":[]}},"response":[],"_postman_id":"f77d2ab2-23df-4a61-ae26-9a822655da13"},{"name":"Create Client via Parser","event":[{"listen":"prerequest","script":{"id":"2a5edec4-df8d-44aa-b43e-e44dcdf1c347","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"ee3f110b-50ce-448b-8508-b3a64514d9c0","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"19587be8-3079-4168-b5c2-2578c9102394","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":"{{X-Access-Token}}"},{"key":"X-Web-Key","value":"{{X-Web-Key}}"}],"body":{"mode":"formdata","formdata":[{"key":"subject","value":"Special Test Parse","type":"text"},{"key":"body-html","value":"Name: OLGA NICOARA\nPhone: 5715940562\nEmail: olganicoara@gmail.com\nAddress: 135 Revere Ct, Collegeville, 19426\nNotes: We would like to install hard wood floors in our living room. Thank you!\nGa Source: google\nGa Medium: organic\nGa Campaign: (organic)\nGa Term: (not provided)\nHow You Heard About Us: Home Advisor","type":"text"},{"key":"from","value":"angel@clienttether.com","type":"text"},{"key":"recipient","value":"ctdefault264-1@parse.ClientTether.com","type":"text"},{"key":"action_type","value":"1","type":"text"}]},"url":"https://ct.clienttether.com/internal/process-email","urlObject":{"protocol":"https","path":["internal","process-email"],"host":["ct","clienttether","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"19587be8-3079-4168-b5c2-2578c9102394"},{"name":"Create Manual Text","event":[{"listen":"prerequest","script":{"id":"126590f1-5457-4534-96c8-4a655605fc11","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"3b5f8bb0-3620-4f51-9ce3-6d77df8ca408","exec":[""],"type":"text/javascript","packages":{}}}],"id":"29329dcc-8654-4331-a2fc-fbf8794654cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/create_manual_text?client_id=22439909&text_body=This is a test of the create manual text by Angel","description":"This API endpoint facilitates the preparation for sending a manual text. The text will be queued for delivery and logged in the History Notes as an Integration Assignment. If no specific date or time is supplied, the text message will be sent immediately upon execution. The required parameters include the client ID and text body. Upon successful execution, the API returns a status indicating either Success or Failure, based on the outcome of the operation.
\nExample of the successful response from the Create Manual Text API
\nRequired
\n","type":"text/plain"},"key":"client_id","value":"22439909"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"text_body","value":"This is a test of the create manual text by Angel"}],"variable":[]}},"response":[],"_postman_id":"29329dcc-8654-4331-a2fc-fbf8794654cd"},{"name":"Create Client History Note","event":[{"listen":"prerequest","script":{"id":"874e05f5-66b7-4f63-b4b7-c0be9307dbf1","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"08701c1d-746f-4e67-8060-b47d7a602893","exec":[""],"type":"text/javascript","packages":{}}}],"id":"66f6fb84-2649-453b-9d12-5c4f12447b94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/create_client_history_note?client_id=22439909¬e_body=This is a test from Create Client History Notes API by Angel","description":"This API endpoint enables the creation of a history note for a specific client. The note will be logged in the History Notes section as an Integration Assigned action. The required parameters for this operation include the client ID and the content of the note. Upon successful execution, the API returns a status indicating either Success or Failure, reflecting the outcome of the action.
\nExample of the successful response from the Create Client History Note API
\nExample of client history note creation in ClientTether
\nRequired
\n","type":"text/plain"},"key":"client_id","value":"22439909"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"note_body","value":"This is a test from Create Client History Notes API by Angel"}],"variable":[]}},"response":[],"_postman_id":"66f6fb84-2649-453b-9d12-5c4f12447b94"},{"name":"Create Client Event","event":[{"listen":"prerequest","script":{"id":"3f933537-9b68-4c25-a571-8425d7083eca","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"adad9e90-4aaf-4439-94b3-c3ed358eb7fa","exec":[""],"type":"text/javascript","packages":{}}}],"id":"95e10b94-128d-48d2-90de-79b054060022","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/create_client_event?client_id=22439909&event_type=appt&event_date=2024-05-28&event_time=15:00:00&event_note=This is an event Note creation from Create client Event by Angel&event_manual_action_plan_id=&user_id=264&event_end_date=2024-05-29&event_end_time=17:00:00","description":"This API endpoint facilitates the creation of events associated with a specific client. The event will be scheduled in the assigned user's calendar and logged accordingly. The parameters required for this operation include the client ID, event type, start date, start time, end date, end time, event note, and user ID. Additionally, you can optionally provide an event manual action plan ID.
\nPlease note the following constraints:
\nThe event start date cannot be later than the event end date.
\nSimilarly, the event start time cannot be later than the event end time.
\nAll parameters are required except for the event manual action plan ID. Upon successful execution, the API returns a status indicating either Success or Failure, reflecting the outcome of the action.
\nExample of the successful response from the Create Client Event API
\nExample of client event creation in ClientTether
\nRequired
\n","type":"text/plain"},"key":"client_id","value":"22439909"},{"description":{"content":"Required (Call, Contact Reminder, Appointment)
\n","type":"text/plain"},"key":"event_type","value":"appt"},{"description":{"content":"Required (YYYY-MM-DD)
\n","type":"text/plain"},"key":"event_date","value":"2024-05-28"},{"description":{"content":"Required Required Format(Hour:Minutes:seconds)
\n","type":"text/plain"},"key":"event_time","value":"15:00:00"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"event_note","value":"This is an event Note creation from Create client Event by Angel"},{"description":{"content":"Optional (you can assign an Event Action Plans but only those that are set for Manual Schedule.) TYPE (Int)
\n","type":"text/plain"},"key":"event_manual_action_plan_id","value":""},{"description":{"content":"Required (264 for testing purposes)
\n","type":"text/plain"},"key":"user_id","value":"264"},{"description":{"content":"Required (YYYY-MM-DD)
\n","type":"text/plain"},"key":"event_end_date","value":"2024-05-29"},{"description":{"content":"Required Format(Hour:Minutes:seconds)
\n","type":"text/plain"},"key":"event_end_time","value":"17:00:00"}],"variable":[]}},"response":[],"_postman_id":"95e10b94-128d-48d2-90de-79b054060022"},{"name":"Create Tag","event":[{"listen":"prerequest","script":{"id":"d3b9b419-03aa-4b07-b89c-68120c932ad9","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"9c2200a1-6924-45db-ac34-bb1561e90eaf","exec":[""],"type":"text/javascript","packages":{}}}],"id":"4e0ce915-b056-4fe7-91eb-da03f012a280","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/create_tag?tag_value=AngelApiTest2","description":"This API endpoint enables the creation of a new tag in the account's list of tags. The provided tag value will be added to the tag list. The only required parameter for this operation is the tag value itself. Upon successful execution, the API returns a status indicating either Success or Failure, reflecting the outcome of the action.
\nExample of the successful response from the Create Tag API
\nExample of tag creation in ClientTether
\nRequired (String)
\n","type":"text/plain"},"key":"tag_value","value":"AngelApiTest2"}],"variable":[]}},"response":[],"_postman_id":"4e0ce915-b056-4fe7-91eb-da03f012a280"},{"name":"Create Lead Source","event":[{"listen":"prerequest","script":{"id":"5dacade3-cff1-449f-ae5a-288d2c92c944","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"309e1e4b-e42d-4873-9254-0ae6b61954fc","exec":[""],"type":"text/javascript","packages":{}}}],"id":"386689c6-5522-4269-ab1b-014846485023","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/create_lead_source?lead_source_name=AngelLeadTestApi","description":"This API endpoint allows the addition of a new lead source to the Accounts system. Upon creation, a unique web key is generated for the lead source. The only required parameter for this operation is the lead source name. After successful execution, the API generates a web key and integrates the new lead source into the system.
\nExample of the successful response from the Create Lead Source API
\nExample of Lead Source creation in ClientTether
\nRequired (String)
\n","type":"text/plain"},"key":"lead_source_name","value":"AngelLeadTestApi"}],"variable":[]}},"response":[],"_postman_id":"386689c6-5522-4269-ab1b-014846485023"},{"name":"Create Action Plan","event":[{"listen":"prerequest","script":{"id":"df486a4c-edc8-40f2-8764-26f9db96e7fe","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"fc908482-aebf-493d-b90c-897de7f5b918","exec":[""],"type":"text/javascript","packages":{}}}],"id":"fb032356-fd22-4314-bdc1-d8fbd3262168","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/create_action_plan?action_plan_name=Angel Action Plan TEST API&action_plan_type=1","description":"This API endpoint facilitates the addition of a new action plan to the Account’s Action Plan List. Upon execution, a new action plan with the specified name and type is inserted into the list. The required parameters for this operation include the action plan name and the action plan type. The action plan type parameter accepts integer values corresponding to three options: 1 for Connection, 2 for Conversion, and 3 for Retention. Upon successful execution, the API integrates the new action plan into the system.
\n","urlObject":{"protocol":"https","path":["v2","api","create_action_plan"],"host":["api","clienttether","com"],"query":[{"description":{"content":"Required (String)
\n","type":"text/plain"},"key":"action_plan_name","value":"Angel Action Plan TEST API"},{"description":{"content":"Required (INT) action plan type parameter accepts integer values corresponding to three options:\n1 for Connection, \n2 for Conversion, \n3 for Retention.
\n","type":"text/plain"},"key":"action_plan_type","value":"1"}],"variable":[]}},"response":[],"_postman_id":"fb032356-fd22-4314-bdc1-d8fbd3262168"},{"name":"Create Sales Cycle","event":[{"listen":"prerequest","script":{"id":"436ba202-a95e-4249-9da1-3df22900b023","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"9c060685-0662-406b-95f6-0aed12466a09","exec":[""],"type":"text/javascript","packages":{}}}],"id":"80beccbc-063d-4491-9cb7-21a710501078","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/create_sales_cycle?sales_cycle_name=Angel Sales Cycle Test Api&sales_cycle_active_status=1&sales_cycle_order=1","description":"This API endpoint facilitates the insertion of a new sales cycle into the Account’s Sales Cycle List. The operation requires three parameters: the sales cycle name, the sales cycle active status, and the sales cycle order.
\nThe sales cycle name is the name of the new sales cycle being added.
\nThe sales cycle active status determines whether the sales cycle is active or inactive, with possible values of 1 for active and 0 for inactive.
\nThe sales cycle order specifies the order of the sales cycle within the list, with an integer value indicating its position.
\nUpon successful execution, the API integrates the new sales cycle into the system's sales cycle list.
\nExample of the successful response from the Create Sales Cycle API
\nExample of Sales Cycle creation in ClientTether
\nRequired
\n","type":"text/plain"},"key":"sales_cycle_name","value":"Angel Sales Cycle Test Api"},{"description":{"content":"Required (1 for active and 0 for inactive)
\n","type":"text/plain"},"key":"sales_cycle_active_status","value":"1"},{"description":{"content":"Required (The sales cycle order specifies the order of the sales cycle within the list, with an integer value indicating its position)
\n","type":"text/plain"},"key":"sales_cycle_order","value":"1"}],"variable":[]}},"response":[],"_postman_id":"80beccbc-063d-4491-9cb7-21a710501078"},{"name":"Create Immed Call","event":[{"listen":"prerequest","script":{"id":"80783988-cffa-40da-8d63-29c8f25cd065","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"9d5ea625-d23a-40b2-b2f2-f12c18bbd176","exec":[""],"type":"text/javascript","packages":{}}}],"id":"2f1844ae-b7f2-465a-b977-4cde40e47098","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"body":{"mode":"formdata","formdata":[{"key":"agent_phone","value":"3039291447","type":"text"},{"key":"client_full_name","value":"Angel Api Test Name","type":"text"},{"key":"client_phone","value":"3333333333","type":"text"},{"key":"say","value":"Please ignore this TESTING, Thanks","type":"text"}]},"url":"https://api.clienttether.com/v2/api/create_immed_call","description":"This API endpoint enables the initiation of an immediate call, providing all four pieces of data from the Immediate Call Parameters table.
\nThe required parameters for this operation are as follows:
\nagent_phone: This should be the phone number of a user in the account, who will be called by the system. The phone number should consist of 10 digits only.
\nclient_full_name: This is the name that will be announced to the agent when they answer the phone. It should be provided as text.
\nclient_phone: This should be the phone number of a contact who wants to receive a call immediately. The phone number should consist of 10 digits only.
\nsay: By default, the system will say: \"This is ClientTether connecting you to {{client_full_name}}.\" Additionally, you can provide additional text that will be stated after this default information.
\nUpon successful execution, the API initiates an immediate call with the specified parameters.
\n","urlObject":{"protocol":"https","path":["v2","api","create_immed_call"],"host":["api","clienttether","com"],"query":[{"disabled":true,"description":{"content":"Required (10 digits only)
\n","type":"text/plain"},"key":"agent_phone","value":"3039291447"},{"disabled":true,"description":{"content":"Required (String)
\n","type":"text/plain"},"key":"client_full_name","value":"Angel Api Test Name"},{"disabled":true,"description":{"content":"Required (10 digits only)
\n","type":"text/plain"},"key":"client_phone","value":"3333333333"},{"disabled":true,"description":{"content":"Required (String)
\n","type":"text/plain"},"key":"say","value":"Please ignore this TESTING, Thanks"}],"variable":[]}},"response":[],"_postman_id":"2f1844ae-b7f2-465a-b977-4cde40e47098"},{"name":"Create History Notes","event":[{"listen":"prerequest","script":{"id":"fc871e9d-1612-4643-8c95-4674c36f048b","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"bfdcdc7d-0cce-44db-8588-29e102bf82f3","exec":[""],"type":"text/javascript","packages":{}}}],"id":"444d91a6-fa0e-4083-86c6-47f2604cfbcc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"notes\": [\n {\n \"client_id\": \"22439909\",\n \"type\": \"email_out\",\n \"utc_datetime\": \"2024-05-30T12:00:00Z\",\n \"subject\": \"Follow-up Email TEST API\",\n \"body_content\": \"This is a follow-up email regarding our recent conversation. (API TEST)\",\n \"user_name\": \"Angel API TEST\"\n },\n {\n \"client_id\": \"22439909\",\n \"type\": \"sms_out\",\n \"utc_datetime\": \"2024-05-30T13:00:00Z\",\n \"subject\": \"Reminder SMS TEST API\",\n \"body_content\": \"Don't forget our appointment tomorrow! (API TEST)\",\n \"user_name\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.clienttether.com/v2/api/create_history_notes","description":"This API endpoint enables the insertion of one or more history notes into the system using a JSON object called 'notes'. Each history note must contain the following six field keys:
\nclient_id: This is the client ID from ClientTether and can be obtained via API or export.
\ntype: This specifies the type of history note, which can be one of the following: sms_in, sms_out, email_in, email_out, or note. Any other value will be saved as 'note'.
\nutc_datetime: This must follow the format yyyy-mm-ddT00:00:00Z to represent the date and time of the history note in UTC.
\nsubject: This is a text string representing the subject of the history note.
\nbody_content: This is a text string representing the body content of the history note.
\nuser_name: This can be any string and will appear in reporting. If left blank, the account owner’s name will be used. The maximum length is 120 characters, and longer strings will be truncated
\nExample of the successful response from the Create History Notes API
\nExample of History Notes creation in ClientTether
\nThis API endpoint allows you to create a new client record in the system using a JSON body. Simply provide the first name, last name, phone number, email address, and any additional information such as SMS permission, whiteboard details, notifications preference, and tags. Upon successful execution, a new client entry will be added to the system with the provided details.
\nExample of the successful response from the create client (JSON) API
\nBody JSON example:
\nThe read_all_payments endpoint reads all payments collected by a specific account. The created_date parameter allows you to specify a date to retrieve all payments since that date.
\nNotes
\nThe created_date parameter is required and should be in the format YYYY-MM-DD.
\nThis endpoint retrieves all payments collected by a specific account since the provided created_date.
\nRequired\nString\nDate to retrieve all payments since (format: YYYY-MM-DD)
\n","type":"text/plain"},"key":"created_date","value":"2022-06-21"}],"variable":[]}},"response":[],"_postman_id":"3166b9ad-801b-47e8-8f4f-e9f071ab6c20"},{"name":"Read Proposals","event":[{"listen":"prerequest","script":{"id":"12f94d63-6692-4fc4-a726-73e61ad013a5","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"aa1f2596-cd2d-4bff-9ccb-0b91eaa86fd6","exec":[""],"type":"text/javascript","packages":{}}}],"id":"cabaa1a0-8961-4aa4-b15e-164654b0f3d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/read_proposals?client_id=9465522","description":"The read_proposals endpoint reads the proposals for a specific Client/Opportunity.
\nResponse
\nRequired\nInteger
\n","type":"text/plain"},"key":"client_id","value":"9465522"}],"variable":[]}},"response":[],"_postman_id":"cabaa1a0-8961-4aa4-b15e-164654b0f3d9"},{"name":"Read All Payments","event":[{"listen":"prerequest","script":{"id":"73dc3d18-c141-43aa-9839-61ab3961e7dd","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"4430d65f-0616-45e9-91bc-b594b7fafcb8","exec":[""],"type":"text/javascript","packages":{}}}],"id":"36dbcc35-3185-45d9-aeb3-7dc80bd758c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/read_all_payments?created_date=2025-05-13","description":"The read_all_payments endpoint reads all payments collected by a specific account since a specified date.
\nThe date from which payments are retrieved in the format \"YYYY-MM-DD\"
\nRequired\nString\nThe date from which payments are retrieved in the format \"YYYY-MM-DD\"
\n","type":"text/plain"},"key":"created_date","value":"2025-05-13"}],"variable":[]}},"response":[],"_postman_id":"36dbcc35-3185-45d9-aeb3-7dc80bd758c1"}],"id":"f033fdda-4957-41bc-a050-af99c4d4c7d1","_postman_id":"f033fdda-4957-41bc-a050-af99c4d4c7d1","description":""},{"name":"Action Plans","item":[{"name":"Read Action Plan List","event":[{"listen":"prerequest","script":{"id":"5ca1ca1f-d93f-465f-bf8b-96c67423e9fb","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"485bceac-b91d-4e11-855d-63b550ed6f16","exec":[""],"type":"text/javascript","packages":{}}}],"id":"4d4d1366-5cae-4dd4-87d9-dcbea4c87c02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/read_action_plan_list?action_plan_name=!Z Email Test only","description":"The read_action_plan_list endpoint retrieves a list of action plans matching the specified query criteria. It includes the action plan ID in the returned data. If no parameters are provided, it returns all action plans associated with the account.
\nOptional\n(Name of the action plan)\nString
\n","type":"text/plain"},"key":"action_plan_name","value":"!Z Email Test only"}],"variable":[]}},"response":[],"_postman_id":"4d4d1366-5cae-4dd4-87d9-dcbea4c87c02"},{"name":"Read Action Plan by ID","event":[{"listen":"prerequest","script":{"id":"3def5838-a9cd-43ac-9d81-27c375daa580","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"cd2b05ae-6447-4d64-a654-5fcdaf214719","exec":[""],"type":"text/javascript","packages":{}}}],"id":"13d016a6-b81c-45e6-aaa7-09b7abc1b432","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/read_action_plan_by_id?plan_id=140802","description":"The read_action_plan_by_id endpoint retrieves details of an action plan identified by the provided action plan ID.
\nRequire\nInteger
\n","type":"text/plain"},"key":"plan_id","value":"140802"}],"variable":[]}},"response":[],"_postman_id":"13d016a6-b81c-45e6-aaa7-09b7abc1b432"},{"name":"Read Pending Actions","event":[{"listen":"prerequest","script":{"id":"6f5c2d71-29bf-46f6-bad4-646e1fe8ef9b","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"399b9956-05fd-4c75-9e7d-25bc05061631","exec":[""],"type":"text/javascript","packages":{}}}],"id":"3d8ba463-1e2c-4660-b6f2-cef10cf755c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/read_all_client_events?client_id=22439909","description":"The read_pending_actions endpoint retrieves a list of pending actions for a given contact identified by the client ID or external ID.
\nOptional\nInteger\nClient ID of the contact
\n","type":"text/plain"},"key":"client_id","value":"22439909"},{"disabled":true,"description":{"content":"Optional\nInteger\nExternal ID of the contact
\n","type":"text/plain"},"key":"external_id","value":null}],"variable":[]}},"response":[],"_postman_id":"3d8ba463-1e2c-4660-b6f2-cef10cf755c2"}],"id":"3be70da3-7d67-48ea-9300-664212506711","_postman_id":"3be70da3-7d67-48ea-9300-664212506711","description":""},{"name":"Clients","item":[{"name":"Read Custom Fields By Contact","event":[{"listen":"prerequest","script":{"id":"e793bc39-4c3c-4125-a852-e9f0dff3b11c","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"324a198c-f983-44fd-8c60-34134021256e","exec":[""],"type":"text/javascript","packages":{}}}],"id":"2f26df2a-ad64-4fba-a8f5-fa9a89f7c408","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.clienttether.com/v2/api/read_custom_field_by_contact/9465522","description":"The read_custom_field_by_contact endpoint provides data with all custom fields associated with the contact of the provided id.
\nThe Id is a required path parameter and must be included in the URL.
\nNo additional parameters are needed.
\nThe read_client_by_external_id endpoint provides data with all parameters associated with the client of the provided external_id.
\nString\nRequired
\n","type":"text/plain"},"key":"external_id","value":"1198549"}],"variable":[]}},"response":[],"_postman_id":"e8b043f9-8f99-40cd-817a-66e08638d993"},{"name":"Read Client By ID v2","event":[{"listen":"prerequest","script":{"id":"4638b2a6-df20-4dfb-a649-b91b6b9ad3b9","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"50e6c258-8e13-43a8-8021-5ccd05c40a32","exec":[""],"type":"text/javascript","packages":{}}}],"id":"832aa92c-8b3c-4626-9ed1-35834b1daab6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/read_client_by_id/22439909","description":"The read_client_by_id endpoint provides data with all parameters associated with the client of the provided client_id.
\nNotes
\nThe read_all_client_events endpoint returns events for all clients in a specific account (100 at a time) and includes user details in each event object. By default, it returns records from today's date with an option to set a custom date using the from_date parameter. Additionally, you can set the offset parameter to paginate the results, with a default of returning 100 records per API call.
\nRequired\nString
\n","type":"text/plain"},"key":"client_id","value":"26220001"},{"disabled":true,"description":{"content":"Optional\nString\nCustom date to start retrieving records from (format: YYYY-MM-DD HH:MM\n)
\n","type":"text/plain"},"key":"from_date","value":"2020-01-01"},{"disabled":true,"description":{"content":"Optional\nInteger\nPagination offset, default is 0
\n","type":"text/plain"},"key":"offset","value":""}],"variable":[]}},"response":[],"_postman_id":"dbc8251e-ca75-45da-9da5-de02e207b9e5"},{"name":"Read All Events","event":[{"listen":"prerequest","script":{"id":"baa24515-7067-4cfd-8dee-d61005603614","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"66955535-f6bb-4e4e-b25b-2e04ee8d1d1e","exec":[""],"type":"text/javascript","packages":{}}}],"id":"ab70cf15-8e78-460a-94b9-954157987f3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/read_all_events","description":"The read_all_client_events endpoint returns events for all clients in a specific account (100 at a time) and includes user details in each event object. By default, it returns records from today's date with an option to set a custom date using the from_date parameter. Additionally, you can set the offset parameter to paginate the results, with a default of returning 100 records per API call.
\nOptional\nString\nCustom date to start retrieving records from (format: YYYY-MM-DD HH:MM\n)
\n","type":"text/plain"},"key":"from_date","value":"2020-01-01"},{"disabled":true,"description":{"content":"Optional\nInteger\nPagination offset, default is 0
\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[]}},"response":[],"_postman_id":"ab70cf15-8e78-460a-94b9-954157987f3b"},{"name":"Read Client Exist","event":[{"listen":"prerequest","script":{"id":"1e6c4c79-0e42-4bd6-8f0f-00cf3bf2230e","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"c1dae251-d250-4c0f-bc46-5254afe66278","exec":[""],"type":"text/javascript","packages":{}}}],"id":"58b55af1-e262-4b03-85c4-2fa287bf94af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/read_client_exist?firstName=AngelApi","description":"read_client_exist endpoint is used to check if a client already exists in ClientTether before making the call to create a new client (create_client). This endpoint can verify the existence of a client using one or more of the following parameters: firstName, lastName, phone, or email.
\nRESPONSES
\nClient Not Found
If the client does not exist in the system, the response will be:
Client Found
\nIf the client exists in the system, the response will be:
\nString\nRequires: firstName or lastName or phone or email
\n","type":"text/plain"},"key":"firstName","value":"AngelApi"},{"disabled":true,"description":{"content":"String\nRequires: firstName or lastName or phone or email
\n","type":"text/plain"},"key":"lastName","value":""},{"disabled":true,"description":{"content":"String\nRequires: firstName or lastName or phone or email
\n","type":"text/plain"},"key":"phone","value":""},{"disabled":true,"description":{"content":"String\nRequires: firstName or lastName or phone or email
\n","type":"text/plain"},"key":"email","value":""}],"variable":[]}},"response":[],"_postman_id":"58b55af1-e262-4b03-85c4-2fa287bf94af"},{"name":"Read Client List","event":[{"listen":"prerequest","script":{"id":"65806c93-c978-4207-bb5d-85d418aa5718","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"b4e89573-4f91-4658-9706-356f484eb348","exec":[""],"type":"text/javascript","packages":{}}}],"id":"fe1dbf1b-34ef-4cf2-a546-a3206b949d32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/read_client_list","description":"read_client_list endpoint provides a data dump of all parameters associated with the first 100 \"Main\" clients. This call focuses on \"all\" main contacts and accepts an optional parameter active_flag to filter the results based on their status. Additionally, it supports pagination using the limit and offset parameters, and can filter results by creation date using from_date and to_date.
\nThe response will include a list of clients based on the provided parameters.
\nThe active_flag parameter determines which contacts are included in the response:
\n0: Archived Contacts only
\n1: Active Contacts only
\n2: Both Active and Archived Contacts (default if not provided)
\nThe limit parameter controls the number of clients returned (maximum value is 100).
\nThe offset parameter is used for pagination to skip a set number of records.
\nThe from_date and to_date parameters filter clients based on their creation date.
\nInteger\nFilters clients based on their status:\n0 = Archived Contacts only\n1 = Active Contacts only\n2 = Both Active and Archived Contacts (default if active_flag not provided)
\n","type":"text/plain"},"key":"active_flag","value":"1"},{"disabled":true,"description":{"content":"Integer\nOptional
\n","type":"text/plain"},"key":"lead_source_id","value":""},{"disabled":true,"description":{"content":"Integer\nLimits the number of clients returned (maximum 100)
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Skips the first set of records
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"Filters clients created from this date (format: YYYY-MM-DD)
\n","type":"text/plain"},"key":"from_date","value":"2024-12-24"},{"disabled":true,"description":{"content":"Filters clients created up to this date (format: YYYY-MM-DD)
\n","type":"text/plain"},"key":"to_date","value":"2024-12-26"}],"variable":[]}},"response":[],"_postman_id":"fe1dbf1b-34ef-4cf2-a546-a3206b949d32"},{"name":"Read Client History Notes","event":[{"listen":"prerequest","script":{"id":"7a563573-354e-4987-8640-bf78be86ae60","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"5d6fb481-f6b9-40a4-95a3-833456bd5097","exec":[""],"type":"text/javascript","packages":{}}}],"id":"9860bea1-498b-4e13-a8e1-08198794a22b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/read_client_history_notes?client_id=20441256","description":"The read_client_history_notes endpoint retrieves all history notes associated with a given client in ClientTether.
\nInteger\nRequired
\n","type":"text/plain"},"key":"client_id","value":"20441256"}],"variable":[]}},"response":[],"_postman_id":"9860bea1-498b-4e13-a8e1-08198794a22b"}],"id":"6a3cae22-89a2-4764-9598-40614be58c80","_postman_id":"6a3cae22-89a2-4764-9598-40614be58c80","description":""},{"name":"Accounts","item":[{"name":"Read Account List","event":[{"listen":"prerequest","script":{"id":"3b944feb-471d-417c-8a31-1e87abb70385","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"a0ebf93d-b5a7-4d4b-9c13-50c490dc36f7","exec":[""],"type":"text/javascript","packages":{}}}],"id":"15222636-a577-4fb7-9b0b-4654fede709f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/read_account_list","description":"The read_account_list API returns all accounts associated with the provided Web_Key authorization. It must be a Multi-Level Account or an Enterprise Account.
\nThe read_lead_source_list API returns a list of lead sources associated with the current account. It does not require any parameters.
\nThe read_user_list API returns all users from the current account.
No query parameters are required for this API.
The read_user_by_id API reads a single user record based on the provided user ID.
\nNotes
Provide the user ID in the URL (no required query parameters).
The read_tags_list API retrieves all tags belonging to the current account.
\nThe read_opportunity_list endpoint returns a list of all opportunities matching the full query, including proposal data in each record returned if proposals are attached. Each parameter adds an \"AND\" to the query. The date formats should be YYYY-MM-DD HH:MM:SS (explicit time is required). When both from and to dates are provided, the query will use \"between and including\". The stateFromDate is used in combination with state to query the date that the contact reached a specific state.
\nRequired
\n","type":"text/plain"},"key":"client_id","value":"22439909"},{"disabled":true,"description":{"content":"Optional\nInteger
\n","type":"text/plain"},"key":"lead_source_id","value":""},{"disabled":true,"description":{"content":"Optional\nInteger\nContact type (1,2,3,4,5 - default is all)
\n","type":"text/plain"},"key":"contact_type","value":"1"},{"description":{"content":"Optional\nString\nState (e.g., appt, quote, closed, completed)
\n","type":"text/plain"},"key":"state","value":"appt"},{"description":{"content":"Optional\nString\nDate the contact reached a specific state (format: YYYY-MM-DD HH:MM\n)
\n","type":"text/plain"},"key":"stateFromDate","value":"2025-05-01"},{"disabled":true,"description":{"content":"Optional\nString\nEnd date for the state query (format: YYYY-MM-DD HH:MM\n)
\n","type":"text/plain"},"key":"stateToDate","value":"2022-11-10"},{"disabled":true,"description":{"content":"Optional\nInteger\nLimits the number of records returned (maximum 100)
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Optional\nInteger\nPagination offset
\n","type":"text/plain"},"key":"offset","value":""}],"variable":[]}},"response":[],"_postman_id":"47b6e783-4f4d-4643-a715-c54a453b6ed9"},{"name":"Read all Opportunities","id":"01e5aa8d-c1cc-431f-9d97-cbd85c751abe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/read_all_Opportunities?client_id=22439909","urlObject":{"protocol":"https","path":["v2","api","read_all_Opportunities"],"host":["api","clienttether","com"],"query":[{"key":"client_id","value":"22439909"}],"variable":[]}},"response":[],"_postman_id":"01e5aa8d-c1cc-431f-9d97-cbd85c751abe"}],"id":"47dfb96c-15c4-4f7a-a649-61181f79a0ff","_postman_id":"47dfb96c-15c4-4f7a-a649-61181f79a0ff","description":""},{"name":"Sales Cycle","item":[{"name":"Read Sales Cycle List","event":[{"listen":"prerequest","script":{"id":"dcd2faba-3cfc-4408-a265-fc001fb46363","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"517a7b02-8a56-4301-aeda-261d6995076c","exec":[""],"type":"text/javascript","packages":{}}}],"id":"69dc8fa4-a087-4a38-bd42-4e2e91e4b84e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/read_sales_cycle_list","description":"The read_sales_cycle_list API returns a list of sales cycles associated with the current account. It does not require any parameters.
\nUpdate the client by their ID; the client_id to be updated must be provided as a required query parameter, and in the API body, include the field to be updated. For example: Firstname and the new value, for instance \"nameUpdated\".
\nUpdate Response:
\nClientTether Response:
\nUpdate the client by their ID; the client_id to be updated must be provided as a required query parameter, and in the API body, include the field to be updated. For example: Firstname and the new value, for instance \"nameUpdated\".
\nUpdate Response:
\nClientTether Response:
\nRequired\nInteger
\n","type":"text/plain"},"key":"client_id","value":"27953521"},{"disabled":true,"key":"City","value":"Temple"},{"disabled":true,"key":"state","value":"TX"},{"disabled":true,"key":"phone","value":"2259373825"},{"disabled":true,"key":"action_plan_id","value":"0"}],"variable":[]}},"response":[],"_postman_id":"35629fb1-2111-44eb-a325-fa71d5213f84"},{"name":"Update Client Event","event":[{"listen":"prerequest","script":{"id":"3bca1636-6644-4f64-8f4b-7345ce0d09c1","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"d212db9f-5bc6-4d4d-b83e-62a8c6f175c7","exec":[""],"type":"text/javascript","packages":{}}}],"id":"7a5e37a7-879c-44f1-8609-51a35d357177","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"body":{"mode":"formdata","formdata":[{"key":"event_id","value":"","type":"text","uuid":"6ce25216-130e-483a-a2a8-445adf3b515a"},{"key":"event_note","value":"","type":"text","uuid":"c2c83b20-c5fe-4283-a0f3-25b7bb4849c4"},{"key":"event_type","value":"","type":"text","uuid":"5776203e-bc82-4069-be27-ae1384a262e1"},{"key":"event_date","value":"","type":"text","uuid":"42a86cb6-d284-4d42-a0ae-2c40e4611613"},{"key":"event_end_date","value":"","type":"text","uuid":"9e2fe6be-8ebe-42a3-a1ca-a3a66db4dc6e"},{"key":"event_time","value":"","type":"text","uuid":"1506bf42-81f1-4732-acca-796e433d2968"},{"key":"event_end_time","value":"","type":"text","uuid":"75494027-d9bd-4728-85ce-40228c480076"}]},"url":"https://api.clienttether.com/v2/api/update_client_event","description":"Update the client by their Event ID; the event_id to be updated must be provided as a required query parameter, and in the API body, include the field to be updated. For example: event_note and the new value, for instance \"NewNoteUpdated\".
\nResponse:
\nField to Update
\n","type":"text"},{"key":"lastName","value":"","description":"Field to Update
\n","type":"text","disabled":true},{"key":"email","value":"","description":"Field to Update
\n","type":"text","disabled":true},{"key":"tag","value":"","description":"Field to Update
\n","type":"text","disabled":true}]},"url":"https://api.clienttether.com/v2/api/update_client_by_external_id?external_id=1198549","description":"Update the client by their External ID; the external_id to be updated must be provided as a required query parameter, and in the API body, include the field to be updated. For example: Firstname and the new value, for instance \"nameUpdated\".
\nResponse:
\nClients Update Subfolder
\n","_postman_id":"88cbc32b-236d-46b0-a259-7565d25b3a04"},{"name":"Accounts","item":[{"name":"Update Account by ID","event":[{"listen":"prerequest","script":{"id":"b7e53f2b-8a18-4466-9deb-dc1784bda2cc","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"653e455d-9188-4b55-ac75-c6d0f6f5412f","exec":[""],"type":"text/javascript","packages":{}}}],"id":"691d3e52-81bb-43c5-953d-a3df9f0f51ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"body":{"mode":"urlencoded","urlencoded":[{"key":"account_first_name","value":"TimmyUpdatedbyAngelAPI","description":"Field to Update
\n","type":"text"},{"key":"account_last_name","value":"","description":"Field to Update
\n","type":"text","disabled":true},{"key":"account_phone","value":"","description":"Field to Update
\n","type":"text","disabled":true},{"key":"account_email","value":"","description":"Field to Update
\n","type":"text","disabled":true}]},"url":"https://api.clienttether.com/v2/api/update_account_by_id?account_id=86","description":"Update the Account by their Account ID; the account_id to be updated must be provided as a required query parameter, and in the API body, include the field to be updated. For example: account_first_name and the new value, for instance \"TimmyUpdatedbyAngelAPI\".
\nClientTether View:
\nResponse:
\nRequired\nInteger
\n","type":"text/plain"},"key":"account_id","value":"86"}],"variable":[]}},"response":[],"_postman_id":"691d3e52-81bb-43c5-953d-a3df9f0f51ca"}],"id":"ceea613a-32ec-4bfe-aaaf-38ff8e8052a2","_postman_id":"ceea613a-32ec-4bfe-aaaf-38ff8e8052a2","description":""},{"name":"Others","item":[{"name":"Update User by ID","event":[{"listen":"prerequest","script":{"id":"a9a22808-6f86-4d7b-a972-b512bd8f06cb","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"4d4e5163-69d2-4687-96bf-5cc3b9f96ea6","exec":[""],"type":"text/javascript","packages":{}}}],"id":"cc6a1045-5f6f-4cc3-80e6-c91bbf61b188","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"body":{"mode":"urlencoded","urlencoded":[{"key":"user_first_name","value":"AdminUpdatedByAPI","description":"Field to Update
\n","type":"text"},{"key":"user_last_name","value":"","description":"Field to Update
\n","type":"text","disabled":true},{"key":"user_phone","value":"","description":"Field to Update
\n","type":"text","disabled":true},{"key":"user_email","value":"","description":"Field to Update
\n","type":"text","disabled":true},{"key":"user_username","value":"","description":"Field to Update
\n","type":"text","disabled":true}]},"url":"https://api.clienttether.com/v2/api/update_user_by_id?user_id=3992","description":"Update the User by their User ID; the user_id to be updated must be provided as a required query parameter, and in the API body, include the field to be updated. For example: user_first_name
and the new value, for instance \"AdminUpdatedByAPI\".
some of the fields to update (for example):
user_first_name,user_last_name,user_phone,user_email,user_username
Response:
\nRequired\nInteger
\n","type":"text/plain"},"key":"user_id","value":"3992"}],"variable":[]}},"response":[],"_postman_id":"cc6a1045-5f6f-4cc3-80e6-c91bbf61b188"},{"name":"Update Sales Cycle by ID","event":[{"listen":"prerequest","script":{"id":"e60ada6a-43d6-49db-a6ae-da7d69eda496","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"d3960128-eed3-448b-8d2a-c9b5fe2f223c","exec":[""],"type":"text/javascript","packages":{}}}],"id":"70f8bc34-9142-48e8-9f90-0adaa55b47f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"body":{"mode":"urlencoded","urlencoded":[{"key":"sales_cycle_name","value":"Advanced Training (Updated by API)","description":"Field to Update
\n","type":"text"},{"key":"sales_cycle_active_status","value":"","description":"Field to Update
\n","type":"text","disabled":true},{"key":"sales_cycle_order","value":"","description":"Field to Update
\n","type":"text","disabled":true}]},"url":"https://api.clienttether.com/v2/api/update_sales_cycle_by_id?sales_cycle_id=21662","description":"Update the Sales Cycle by their Sales Cycle ID; the sales_cycle_id to be updated must be provided as a required query parameter, and in the API body, include the field to be updated. For example: sales_cycle_name and the new value, for instance \"Advanced Training (Updated by API)\".
\nsome of the fields to update (for example):
sales_cycle_name,sales_cycle_active_status,sales_cycle_order
Response:
\nRequired\nInteger
\n","type":"text/plain"},"key":"sales_cycle_id","value":"21662"}],"variable":[]}},"response":[],"_postman_id":"70f8bc34-9142-48e8-9f90-0adaa55b47f8"},{"name":"Update Lead Source by ID","event":[{"listen":"prerequest","script":{"id":"d38c7d53-ec4d-4893-bd63-ed713aec1217","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"883037a0-c336-4697-b3d2-1414f9acbe6c","exec":[""],"type":"text/javascript","packages":{}}}],"id":"01edc480-ca6c-4369-97ad-0af69b4d4b0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"body":{"mode":"urlencoded","urlencoded":[{"key":"lead_source_name","value":"AA Test Lead(UPDATED by API)","description":"Field to Update
\n","type":"text"}]},"url":"https://api.clienttether.com/v2/api/update_lead_source_by_id?lead_source_id=173541","description":"Update the Lead Source by their lead_source_id; the lead_source_id to be updated must be provided as a required query parameter, and in the API body, include the field to be updated. For example: lead_source_name and the new value, for instance \"AA Test Lead(UPDATED by API)\".
\nsome of the fields to update (for example):
lead_source_name
Response:
\nRequired\nInteger
\n","type":"text/plain"},"key":"lead_source_id","value":"173541"}],"variable":[]}},"response":[],"_postman_id":"01edc480-ca6c-4369-97ad-0af69b4d4b0f"}],"id":"013f1c40-13c9-4769-8693-fdba3df6366a","_postman_id":"013f1c40-13c9-4769-8693-fdba3df6366a","description":""}],"id":"0aca6134-b0b6-4875-98b3-c624420c17b9","_postman_id":"0aca6134-b0b6-4875-98b3-c624420c17b9","description":""},{"name":"Delete","item":[{"name":"Delete Client by ID","event":[{"listen":"prerequest","script":{"id":"04864597-13cb-4884-a277-0890ff7cfd2f","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"61e31094-5942-4edc-863c-09f8ca8b6f30","exec":[""],"type":"text/javascript","packages":{}}}],"id":"938f9685-406a-4f04-9f6e-1f494368eda2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/delete_client_by_id?client_id=11590447","description":"This endpoint deletes a client from the database based on the provided client ID.
\n","urlObject":{"protocol":"https","path":["v2","api","delete_client_by_id"],"host":["api","clienttether","com"],"query":[{"key":"client_id","value":"11590447"}],"variable":[]}},"response":[],"_postman_id":"938f9685-406a-4f04-9f6e-1f494368eda2"},{"name":"Delete Client by External ID","event":[{"listen":"prerequest","script":{"id":"c97dcca0-2c06-4d51-a09b-b7b623fa839f","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"e5a13a55-beee-4822-a580-346f2b3742eb","exec":[""],"type":"text/javascript","packages":{}}}],"id":"fa3b608e-b2a5-4ee3-8b00-eb37d7d0769a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/delete_client_by_external_id?external_id=20503326","description":"This API endpoint allows you to delete a client using their external ID, which is a foreign key for integration with Client Tether. This is particularly useful for managing clients across multiple systems and ensuring synchronization between them.
\nResponse
\nRequired\nINT
\n","type":"text/plain"},"key":"external_id","value":"20503326"}],"variable":[]}},"response":[],"_postman_id":"fa3b608e-b2a5-4ee3-8b00-eb37d7d0769a"},{"name":"Delete Lead Source by ID","event":[{"listen":"prerequest","script":{"id":"9636794c-cf93-4975-9fed-7365e026c14c","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"0a8bdf8e-6afa-4edf-84df-16a175386250","exec":[""],"type":"text/javascript","packages":{}}}],"id":"71521887-0928-4053-81c6-007dfee36ab9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/delete_lead_source_by_id?lead_source_id=20503326","description":"This API endpoint allows you to delete a lead source using its ID. The lead source ID is the system identifier for a specific lead source within the Client Tether platform.
\n","urlObject":{"protocol":"https","path":["v2","api","delete_lead_source_by_id"],"host":["api","clienttether","com"],"query":[{"key":"lead_source_id","value":"20503326"}],"variable":[]}},"response":[],"_postman_id":"71521887-0928-4053-81c6-007dfee36ab9"},{"name":"Delete Sales Cycle by ID","event":[{"listen":"prerequest","script":{"id":"c2e95490-0d0c-49ef-8760-2d0680157eff","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"16dce30e-997d-4531-8352-7a0891e92596","exec":[""],"type":"text/javascript","packages":{}}}],"id":"4933020b-e9f9-460a-b69d-10bb57d9a40a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/delete_sales_cycle_by_id?sales_cycle_id=20503326","description":"This API endpoint allows you to delete a sales cycle using its ID. The sales cycle ID is the system identifier for a specific sales cycle within the Client Tether platform.
\n","urlObject":{"protocol":"https","path":["v2","api","delete_sales_cycle_by_id"],"host":["api","clienttether","com"],"query":[{"key":"sales_cycle_id","value":"20503326"}],"variable":[]}},"response":[],"_postman_id":"4933020b-e9f9-460a-b69d-10bb57d9a40a"},{"name":"Delete User by ID","event":[{"listen":"prerequest","script":{"id":"d5c04fe3-bfdb-4b7a-ad25-6d2690693cd1","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"72a8612e-d36f-4c0b-affb-dcbfc4096968","exec":[""],"type":"text/javascript","packages":{}}}],"id":"dbf9dead-834a-4c7d-a10d-dd276543ed19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/delete_user_by_id?user_id=3992","description":"This API endpoint allows you to delete a user using their ID. The user ID is the system identifier for a specific user within the ClientTether System.
\nResponse
\nRequired\nINT
\n","type":"text/plain"},"key":"user_id","value":"3992"}],"variable":[]}},"response":[],"_postman_id":"dbf9dead-834a-4c7d-a10d-dd276543ed19"},{"name":"Delete Account by ID","event":[{"listen":"prerequest","script":{"id":"b21b97b3-647f-4425-95ab-5c9b7ee6a63b","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"c42e8736-e851-4a2a-8177-24e2789a1afd","exec":[""],"type":"text/javascript","packages":{}}}],"id":"47a1474b-52b9-4cea-8787-0494f5f600cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/delete_account_by_id?account_id=20503326","description":"This API endpoint allows you to delete an account using its ID. The account ID is the system identifier for a specific account within the Client Tether platform.
\nResponse
\nRequired\nINT
\n","type":"text/plain"},"key":"account_id","value":"20503326"}],"variable":[]}},"response":[],"_postman_id":"47a1474b-52b9-4cea-8787-0494f5f600cd"},{"name":"Delete Client Event","event":[{"listen":"prerequest","script":{"id":"5bed9d40-1f95-47bc-ac45-2d2fc1a0c0ef","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"209a8683-f8e9-45d4-9193-133ced24adcc","exec":[""],"type":"text/javascript","packages":{}}}],"id":"63f66365-aa54-49f7-b115-180ffdacec93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Access-Token","value":""},{"key":"X-Web-Key","value":""}],"url":"https://api.clienttether.com/v2/api/delete_client_event?event_id=96399538","description":"This API endpoint allows you to delete a client event using its ID. The event ID is the system identifier for a specific event within the ClientTether system.
\nResponse
\nRequired\nINT
\n","type":"text/plain"},"key":"event_id","value":"96399538"}],"variable":[]}},"response":[],"_postman_id":"63f66365-aa54-49f7-b115-180ffdacec93"}],"id":"32e31ba3-9a92-4372-9420-75ee3770fad3","description":"Collection for deleting multiple records in the database, such as deleting clients, Lead Source, Accounts, Events, etc.EndFragment
\n","_postman_id":"32e31ba3-9a92-4372-9420-75ee3770fad3"}]}