Public
Documentation Settings
No Environment
Double Column
cURL - cURL
ClientTether REST API
Introduction
Create
Read
Update
Delete

ClientTether REST API

Create

Clients

POSTCreate Client - from Thumbtack

https://api.clienttether.com/v1/external-api/thumbtack/lead

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.

HEADERS
X-Access-Token

{{X-Access-Token}}

X-Web-Key

{{X-Web-Key}}

Bodyraw (json)
json
{
  "leadID": "1010101010101",
  "createTimestamp": "1498760296",
  "request": {
    "requestID": "4444444444",
    "category": "testing",
    "categoryID": "444444444444444",
    "title": "testing",
    "description": "testing",
    "schedule": "Date: Tue, May 05 2020\nTime: 6:00 PM\nLength: 3.5 hours",
    "location": {
      "address1": "101 Alma Street",
      "address2": "",
      "city": "Palo Alto",
      "state": "CA",
      "zipCode": "94301"
    },
    "travelPreferences": "testing",
    "details": [
      {
        "question": "testing",
        "answer": "Home"
      },
      {
        "question": "testing",
        "answer": "4 rooms"
      }
    ],
    "attachments": []
  },
  "customer": {
    "customerID": "101010101010101",
    "name": "Mickey MOUSE",
    "phone": "444444444444"
  },
  "business": {
    "businessID": "123456",
    "name": "CT Enterprise Test Account"
  },
  "leadType": "INSTANT_BOOK",
  "leadPrice": null,
  "chargeState": null
}
Example Request
Create Client - from Thumbtack
curl
curl --location 'https://api.clienttether.com/v1/external-api/thumbtack/lead' \
--header 'X-Access-Token: {{X-Access-Token}}' \
--header 'X-Web-Key: {{X-Web-Key}}' \
--data '{
  "leadID": "1010101010101",
  "createTimestamp": "1498760296",
  "request": {
    "requestID": "4444444444",
    "category": "testing",
    "categoryID": "444444444444444",
    "title": "testing",
    "description": "testing",
    "schedule": "Date: Tue, May 05 2020\nTime: 6:00 PM\nLength: 3.5 hours",
    "location": {
      "address1": "101 Alma Street",
      "address2": "",
      "city": "Palo Alto",
      "state": "CA",
      "zipCode": "94301"
    },
    "travelPreferences": "testing",
    "details": [
      {
        "question": "testing",
        "answer": "Home"
      },
      {
        "question": "testing",
        "answer": "4 rooms"
      }
    ],
    "attachments": []
  },
  "customer": {
    "customerID": "101010101010101",
    "name": "Mickey MOUSE",
    "phone": "444444444444"
  },
  "business": {
    "businessID": "123456",
    "name": "CT Enterprise Test Account"
  },
  "leadType": "INSTANT_BOOK",
  "leadPrice": null,
  "chargeState": null
}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POSTCreate Manual Email

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.

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.

Example of the successful response from the Create Manual Email API

Example of Email creation in ClientTether

HEADERS
X-Access-Token

{{X-Access-Token}}

X-Web-Key

{{X-Web-Key}}

PARAMS
client_id

22439909

Required

email_subject

This is a test from create manual email API by Angel

Required

email_body

This is the test body from an API call. It will send an email.

Required

Example Request
Create Manual Email
curl
curl --location --request POST 'https://api.clienttether.com/v2/api/create_manual_email?client_id=22439909&email_subject=This%20is%20a%20test%20from%20create%20manual%20email%20API%20by%20Angel&email_body=This%20is%20the%20test%20body%20from%20an%20API%20call.%20It%20will%20send%20an%20email.' \
--header 'X-Access-Token: {{X-Access-Token}}' \
--header 'X-Web-Key: {{X-Web-Key}}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POSTCreate Client

https://api.clienttether.com/v2/api/create_client?firstName=AngelApi&lastName=Api Testing&phone=5555555555&smsok=1&email=angel+1@clienttether.com&lead_source_id=219347&state=California

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.

Example of the successful response from the create client API

Example of client creation in ClientTether

HEADERS
X-Access-Token

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJtaWtld2VpbmJlcmdlciIsInJvbGUiOiI1Iiwib3JpZ2luIjoiMSJ9.7qxDlk2d6msxM4SBALl4QcxWIwt1GLRfJeXyTvIYoVo

X-Web-Key

CT_4d1fbec32f34810bcca2f0ac97fdd136

PARAMS
firstName

AngelApi

Required

lastName

Api Testing

Required

phone

5555555555

Phone Number (MAX LENGTH 10)

smsok

1

1 = on 0 = off

email

angel+1@clienttether.com

Valid Email Adress

lead_source_id

219347

Optional

whiteboard

Api Test Angel

This text will appear on the Whiteboard

new_lead_notification

2

Optional

tag

test, API

Optional

zip

23564

state

California

Example Request
Create Client
curl
curl --location --request POST 'https://api.clienttether.com/v2/api/create_client?firstName=AngelApi&lastName=Api%20Testing&phone=5555555555&smsok=1&email=angel%2B1%40clienttether.com&lead_source_id=219347&state=California' \
--header 'X-Access-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJtaWtld2VpbmJlcmdlciIsInJvbGUiOiI1Iiwib3JpZ2luIjoiMSJ9.7qxDlk2d6msxM4SBALl4QcxWIwt1GLRfJeXyTvIYoVo' \
--header 'X-Web-Key: CT_4d1fbec32f34810bcca2f0ac97fdd136'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers