Send It By Text API Reference

One base URL, one authentication header, 119 documented operations. Everything your account can do in Send It By Text, your code can do here: send and receive texts, manage clients and users, book appointments, collect eSignatures, and more.

`Base URL`	`https://useclientconnect.com/api/clientconnect_v2.aspx`
`Method`	All calls are HTTP POST
`Body`	`application/x-www-form-urlencoded` (multipart form data for file operations)
`Auth`	`apikey` header on every request
`Operation`	The `request` parameter in the body selects the operation, e.g. `request=sendclienttext`
`Responses`	JSON

Three operations use their own URLs: sendclientmms posts to /api/mms_v2.ashx, signrequest posts to /api/signrequest_v2.ashx, and sendgroupmsg posts to /api/sendgroupmsg.ashx. Every other call goes to the base URL above.

Authentication

Every request must include your API key in the apikey request header. Authorized administrators can find the key in Send It By Text under Admin Menu → Company Settings. Keys are scoped to your company.

Header

apikey: YOUR_API_KEY

Keep your key on the server. The API key carries admin-level access to your company's data. Put it in the header, never in a query string. Never embed it in a mobile app, browser JavaScript, logs, support tickets, or a public repository. Make API calls from your backend only, and rotate the key from Company Settings if you believe it has been exposed. All examples in these docs use the placeholder YOUR_API_KEY.

Making requests

Send parameters as a form encoded POST body. The request parameter names the operation, and the remaining parameters are listed per operation below. Dates use mm/dd/yyyy and, where a time is expected, mm/dd/yyyy hh:mm:ss.

Phone number rule. Normalize every phone number to 10 digits with no country code. Strip +1, spaces, parentheses, hyphens, and dots before sending. The exception is getsigninglink, which expects the country code included.

File operations (MMS, document upload, signature requests, group messages with attachments) accept a file POSTed as multipart form data, or Base64 encoded content in a rawdata parameter with a filename. When you use browser FormData, do not set the Content-Type header yourself; the browser adds the multipart boundary for you.

Identifier guide

Send It By Text has several numeric IDs that look interchangeable but are not. Getting these wrong is the single most common integration bug, so read this once before writing any code.

Field	Meaning	Where to use it
`ID`	Internal record ID returned by searchclient	This is what most parameters named `cid` want
`cid`	Parameter name for the internal record ID	SMS, notes, documents, groups, client details
`UniqueClientID`	Visible Contact ID shown in the app	Display, file naming, and endpoints that explicitly ask for `contactid` (such as getcustomfieldsdata)
`ClientID`	Separate custom/visible client ID	Reference and display only, unless an endpoint says otherwise
`userid`	The user performing the action	SMS sender, notes author, task assignment, group sends
`groupid`	Numeric group ID	Group membership and group messaging. Always the number, never the group name

Rule of thumb: search with searchclient, use the returned ID as cid for almost everything, and reach for UniqueClientID only when an endpoint explicitly asks for contactid.

searchclient response (sanitized)

[
  {
    "ID": 1234567,
    "UniqueClientID": 9876543,
    "ClientID": "ABC-10001",
    "FirstName": "Jane",
    "LastName": "Smith",
    "MobileTel": "8135551212",
    "EmailAddress": "jane@example.com"
  }
]

Responses & errors

All operations return JSON. Create operations such as addclient and adduser return a message string plus a UniqueId you should store and use in later calls.

Do not trust HTTP 200. Some failures return HTTP 200 with an error message in the body. Always parse the response and inspect message, success, and Error fields before treating a call as successful.

Error responses you will see in practice:

Common error shapes

{ "message": "No client found according to given criteria." }
{ "message": "Null request." }
{ "success": false, "Error": "No Record Found." }
{ "message": "Please provide client groups." }
{ "message": "IP rate limit exceeded." }

A defensive check that catches the common failure strings:

JavaScript

function assertSendItByTextSuccess(result) {
  const text = JSON.stringify(result);
  if (/rate limit exceeded|invalid request|null request|error occurred|no record found/i.test(text)) {
    throw new Error(text);
  }
  return result;
}

We are expanding these docs with full response schemas per operation. If you need a response shape that is not documented yet, make the call against test data and inspect the JSON, or ask us.

Rate limits

The API enforces the following limits. When you hit one, the response body contains a throttle message such as { "message": "API key rate limit exceeded." }.

Limit	Threshold	Behavior
Per IP	500 requests per 60 seconds	Throttle message, cooldown
Per API key	300 requests per 60 seconds	Throttle message, cooldown
Burst detection	200 requests per 10 seconds per key	Treated as a throttle
Cooldown	5 minutes	Back off fully before retrying
Repeated violations	3 within 1 hour	May lead to a key block

Practical guidance: pace batch jobs, avoid uncontrolled parallel fanout, and use exponential backoff with jitter. When you see a throttle message, stop immediately and wait out the cooldown; retry storms are what get keys blocked. Log the request type, HTTP status, and response body so support can help you quickly.

Quick start: find a contact

Grab your API key from Company Settings, replace the placeholder, and run:

cURL

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=searchclient" \
  --data-urlencode "search=Jane Smith"

That's the whole pattern. Every operation works the same way: POST to the base URL, pass your key in the header, pick the operation with request, and read the JSON that comes back. From the response, use ID as your cid in follow-up calls like sendclienttext.

Messaging (SMS & MMS)

Send and retrieve text messages, MMS, scheduled texts, and group messages.

Get recent SMS list

POSTrequest=getrecentsmslist

Returns the list of new (recent) SMS messages for a user.

Parameters

`request` String required	Set to `getrecentsmslist`
`userid` Integer required	User ID
`showmytext` Integer required	0 = all conversations, 1 = my conversations

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getrecentsmslist" \
  --data-urlencode "userid=101" \
  --data-urlencode "showmytext=1"

My conversations

POSTrequest=myconversations

Returns the list of conversations belonging to the requesting user.

Parameters

`request` String required	Set to `myconversations`
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=myconversations" \
  --data-urlencode "userid=101"

All conversations

POSTrequest=allconversations

Returns the list of all conversations across the company.

Parameters

`request` String required	Set to `allconversations`
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=allconversations" \
  --data-urlencode "userid=101"

Get client texts

POSTrequest=getclienttexts

Returns the text messages for a specific client.

Parameters

`request` String required	Set to `getclienttexts`
`cid` Integer required	ID of the client whose texts are required
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getclienttexts" \
  --data-urlencode "cid=123456" \
  --data-urlencode "userid=101"

Get client text history

POSTrequest=getclienttexthistory

Returns the full text message history for a specific client.

Parameters

`request` String required	Set to `getclienttexthistory`
`cid` Integer required	ID of the client whose text history is required
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getclienttexthistory" \
  --data-urlencode "cid=123456" \
  --data-urlencode "userid=101"

Send client text

POSTrequest=sendclienttext

Sends a text message to an existing client.

Parameters

`request` String required	Set to `sendclienttext`
`cid` Integer required	ID of the client the text is sent to
`from` Integer required	From mobile number (without country code)
`to` Integer required	To mobile number (without country code)
`text` String required	Message text to send
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=sendclienttext" \
  --data-urlencode "cid=123456" \
  --data-urlencode "from=8135551234" \
  --data-urlencode "to=8135555678" \
  --data-urlencode "text=Hello from the Send It By Text API" \
  --data-urlencode "userid=101"

Send client MMS

POSTrequest=sendclientmms

Sends an MMS (picture or file message) to a client. Note the different endpoint URL below; send as multipart form data with the file attached, or Base64 encoded via filename and body content.

Different endpoint URL. POST this request to https://useclientconnect.com/api/mms_v2.ashx instead of the standard base URL.

Parameters

`request` String required	Set to `sendclientmms`
`cid` Integer required	ID of the client the MMS is sent to
`from` Integer required	From mobile number (without country code)
`to` Integer required	To mobile number (without country code)
`text` String required	Message text to send
`userid` Integer required	User ID
`filename` String optional	File name including extension. Required only when sending the file Base64 encoded in the request body
`File` File conditional	The file to send. POST the file with the request, or supply it Base64 encoded via the body with `filename`

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/mms_v2.ashx" \
  -H "apikey: YOUR_API_KEY" \
  -F "request=sendclientmms" \
  -F "cid=123456" \
  -F "from=8135551234" \
  -F "to=8135555678" \
  -F "text=Hello from the Send It By Text API" \
  -F "userid=101"

Send scheduled text

POSTrequest=sendclientscheduledtext

Schedules a text message for future delivery, with optional repeat rules.

Parameters

`request` String required	Set to `sendclientscheduledtext`
`from` Integer required	From mobile number (without country code)
`to` Integer required	To mobile number (without country code)
`text` String required	Message text to send
`month` Integer required	Month the text should be sent
`day` Integer required	Day of the month the text should be sent
`year` Integer required	Year the text should be sent
`hour` Integer required	Hour the text should be sent
`minute` Integer required	Minute the text should be sent
`ampm` String required	`am` or `pm`
`repeat` Integer required	1 = no repeat, 2 = daily, 3 = weekly, 4 = monthly, 5 = every 3 months, 6 = every 6 months, 7 = yearly, 8 = weekdays only, 9 = weekends only

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=sendclientscheduledtext" \
  --data-urlencode "from=8135551234" \
  --data-urlencode "to=8135555678" \
  --data-urlencode "text=Hello from the Send It By Text API" \
  --data-urlencode "month=8" \
  --data-urlencode "day=15" \
  --data-urlencode "year=2026" \
  --data-urlencode "hour=4" \
  --data-urlencode "minute=30" \
  --data-urlencode "ampm=pm" \
  --data-urlencode "repeat=1"

Send precomposed message

POSTrequest=sendprecomposedmessage

Sends a saved (precomposed) message template to a client. Get template IDs from getcannedresponse.

Parameters

`request` String required	Set to `sendprecomposedmessage`
`cid` Integer required	ID of the client the message is sent to
`from` Integer required	From mobile number (without country code)
`caid` Integer required	ID of the precomposed response
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=sendprecomposedmessage" \
  --data-urlencode "cid=123456" \
  --data-urlencode "from=8135551234" \
  --data-urlencode "caid=1" \
  --data-urlencode "userid=101"

Send SMS (no client ID required)

POSTrequest=sendclientsms

Sends an SMS to a phone number that may not belong to an existing client. If the destination number is unknown, createclient controls whether a new client record is created.

Parameters

`request` String required	Set to `sendclientsms`
`from` Integer required	From mobile number (without country code)
`to` Integer required	To mobile number (without country code)
`text` String required	Message text to send
`userid` Integer required	User ID
`createclient` Integer required	1 = create a new client if the number is unknown, 0 = send without creating a client
`firstname` String optional	First name (used when creating a client)
`lastname` String optional	Last name (used when creating a client)

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=sendclientsms" \
  --data-urlencode "from=8135551234" \
  --data-urlencode "to=8135555678" \
  --data-urlencode "text=Hello from the Send It By Text API" \
  --data-urlencode "userid=101" \
  --data-urlencode "createclient=1"

Get client text history by date

POSTrequest=getclienttexthistorybydate

Returns a client's text history within a date range.

Parameters

`request` String required	Set to `getclienttexthistorybydate`
`cid` Integer required	ID of the client whose text history is required
`startdate` Date (String) required	Start date
`enddate` Date (String) required	End date

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getclienttexthistorybydate" \
  --data-urlencode "cid=123456" \
  --data-urlencode "startdate=08/15/2026 09:00:00" \
  --data-urlencode "enddate=08/15/2026 10:00:00"

Get client scheduled texts

POSTrequest=getclientscheduledtexts

Returns the scheduled (pending) texts for a client.

Parameters

`request` String required	Set to `getclientscheduledtexts`
`cid` Integer required	Client ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getclientscheduledtexts" \
  --data-urlencode "cid=123456"

Send group message

POSTrequest=sendgroupmsg

Sends a message to every contact in a group, via SMS, email, or both. Note the dedicated endpoint URL below; send this call as multipart form data, not as a URL encoded body.

Different endpoint URL. POST this request to https://useclientconnect.com/api/sendgroupmsg.ashx instead of the standard base URL.

Heads up: Do not POST sendgroupmsg to the standard base URL. It has its own endpoint at /api/sendgroupmsg.ashx and expects form data fields. Use the numeric group ID from getcontactgroups, not the group name.

Parameters

`request` String required	Set to `sendgroupmsg`
`userid` Integer required	User ID
`sendvia` Integer required	1 = SMS, 2 = email, 3 = both
`groupid` Integer required	Group ID
`textnote` String conditional	Message body. Required when `sendvia` is 1 or 3
`textnoteemail` String conditional	Email body. Required when `sendvia` is 2 or 3
`usecompanyemail` Integer required	0 = false, 1 = true
`emailsendinguserid` Integer conditional	Required when `sendvia` is 2 or 3 and `usecompanyemail` is 0
`useVpnNumberForText` Integer required	0 = false, 1 = true
`emailsubject` String optional	Email subject
`nosendtoreplied` Integer optional	1 = skip contacts who have already replied, 0 = send to everyone
`timezone` String optional	`eastern`, `central`, `mountain`, or `pacific`
`File` File optional	Attachment (sends as MMS)

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/sendgroupmsg.ashx" \
  -H "apikey: YOUR_API_KEY" \
  -F "request=sendgroupmsg" \
  -F "userid=101" \
  -F "sendvia=text" \
  -F "groupid=1" \
  -F "usecompanyemail=1" \
  -F "useVpnNumberForText=1"

Clients

Create, update, search, and list client (contact) records.

Add client

POSTrequest=addclient

Creates a client record and returns the new client's unique ID (CID) for use in later calls.

Heads up: Adding a contact does not reliably assign groups. Create the contact first, capture the returned ID, then call addcontactgroups to assign groups.

Parameters

`request` String required	Set to `addclient`
`fname` String required	First name
`lname` String required	Last name
`userid` Integer required	User ID
`email` String optional	Email address
`mobile` Integer optional	Mobile number (without country code)
`otherphone` Integer optional	Other phone number (without country code)
`phonetype` String optional	`home`, `work`, `mobile 2`, `fax`, or `other`
`address` String optional	Street address
`city` String optional	City
`state` String optional	State
`zip` String optional	ZIP code
`company` String optional	Company name
`status` Integer optional	0 = inactive, 1 = active
`stopfurtheremails` Integer optional	1 = stop all emails to this contact
`stopfurthertexts` Integer optional	1 = stop all text messages to this contact
`clientid` String optional	Custom client ID
`scratchpad` String optional	Description / scratchpad text
`customnotification` Integer optional	0 = disabled, 1 = enabled
`customnotificationtext` String optional	Custom notification text
`ContactLocation` String optional	Location of contact
`JobTitle` String optional	Job title
`localnumber` Integer optional	Local number (without country code)
`customtext1-10` String optional	Custom text fields 1 through 10
`customdate1-5` Date optional	Custom date fields 1 through 5
`customlong1-5` Numeric optional	Custom numeric fields 1 through 5

Returns: Returns message (success or error text) and UniqueId (the new client's CID).

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=addclient" \
  --data-urlencode "fname=Jane" \
  --data-urlencode "lname=Doe" \
  --data-urlencode "userid=101"

Example response

{
  "message": "Success",
  "UniqueId": 123456
}

Update client

POSTrequest=updateclient

Updates an existing client record. Only send the fields you want to change, plus the required ID.

Heads up: Updating a contact does not reliably assign groups. Use addcontactgroups and deletecontactgroups for group membership.

Parameters

`request` String required	Set to `updateclient`
`id` Integer required	CID of the client to update
`email` String optional	Email address
`fname` String optional	First name
`lname` String optional	Last name
`mobile` Integer optional	Mobile number (without country code)
`otherphone` Integer optional	Other phone number (without country code)
`phonetype` String optional	`home`, `work`, `mobile 2`, `fax`, or `other`
`address` String optional	Street address
`city` String optional	City
`state` String optional	State
`zip` String optional	ZIP code
`company` String optional	Company name
`status` Integer optional	0 = inactive, 1 = active
`stopfurtheremails` Integer optional	1 = stop all emails to this contact
`stopfurthertexts` Integer optional	1 = stop all text messages to this contact
`clientid` String optional	Custom client ID
`scratchpad` String optional	Description / scratchpad text
`customnotification` Integer optional	0 = disabled, 1 = enabled
`customnotificationtext` String optional	Custom notification text
`ContactLocation` String optional	Location of contact
`JobTitle` String optional	Job title
`contactcomapny` String optional	Contact company
`contactstatus` Integer optional	Contact status ID
`contactstatusname` String optional	Contact status name
`localnumber` Integer optional	Local number (without country code)
`customtext1-10` String optional	Custom text fields 1 through 10
`customdate1-5` Date optional	Custom date fields 1 through 5
`customlong1-5` Numeric optional	Custom numeric fields 1 through 5

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=updateclient" \
  --data-urlencode "id=123456"

Get client details

POSTrequest=getclientdetails

Returns a client's full record by CID.

Parameters

`request` String required	Set to `getclientdetails`
`cid` String required	ID of the client whose details are required

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getclientdetails" \
  --data-urlencode "cid=123456"

Search clients

POSTrequest=searchclient

Searches clients by name, mobile number, email, contact ID, or custom client ID. This is usually the first call in any workflow: search, then use the returned ID as cid in later calls.

Heads up: The ID field in the response is the internal record ID. That is the value most endpoints want as cid. UniqueClientID is the visible Contact ID, used for display and for endpoints that explicitly ask for contactid. See the identifier guide.

Parameters

`request` String required	Set to `searchclient`
`search` String required	Search term: first name, last name, mobile, email, contact ID, or custom client ID

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=searchclient" \
  --data-urlencode "search=Jane"

Example response

[
  {
    "ID": 1234567,
    "UniqueClientID": 9876543,
    "ClientID": "ABC-10001",
    "FirstName": "Jane",
    "LastName": "Smith",
    "MobileTel": "8135551212",
    "EmailAddress": "jane@example.com"
  }
]

List all clients

POSTrequest=listallclients

Returns all clients. Supports pagination.

Parameters

`request` String required	Set to `listallclients`
`pagesize` Integer optional	Number of clients per page
`pagenumber` Integer optional	Page number

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=listallclients"

List active clients

POSTrequest=listactiveclients

Returns all active clients. Supports pagination.

Parameters

`request` String required	Set to `listactiveclients`
`pagesize` Integer optional	Number of clients per page
`pagenumber` Integer optional	Page number

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=listactiveclients"

List inactive clients

POSTrequest=listinactiveclients

Returns all inactive clients.

Parameters

request

String

required

Set to listinactiveclients

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=listinactiveclients"

List clients by contact status

POSTrequest=listclientbycontactstatus

Returns clients filtered by contact status ID, with optional date range and pagination. Get status IDs from getcontactstatuses.

Parameters

`request` String required	Set to `listclientbycontactstatus`
`ContactStatusID` Integer required	Contact status ID
`pagesize` Integer optional	Number of clients per page
`pagenumber` Integer optional	Page number
`statuschangedfrom` Date (String) optional	From date, mm/dd/yyyy
`statuschangedto` Date (String) optional	To date, mm/dd/yyyy

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=listclientbycontactstatus" \
  --data-urlencode "ContactStatusID=1"

List clients by group

POSTrequest=listclientbygroup

Returns clients in a specific group, with optional date range and pagination.

Parameters

`request` String required	Set to `listclientbygroup`
`groupid` Integer required	Group ID
`pagesize` Integer optional	Number of clients per page
`pagenumber` Integer optional	Page number
`groupdatefrom` Date (String) optional	From date, mm/dd/yyyy
`groupdateto` Date (String) optional	To date, mm/dd/yyyy

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=listclientbygroup" \
  --data-urlencode "groupid=1"

Get client creditors

POSTrequest=getclientcreditors

Returns details of all creditors available for a contact.

Parameters

`request` String required	Set to `getclientcreditors`
`contactid` Integer required	Contact ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getclientcreditors" \
  --data-urlencode "contactid=123456"

Get client affiliate

POSTrequest=getclientaffiliate

Returns the affiliate assigned to a client.

Parameters

`request` String required	Set to `getclientaffiliate`
`cid` Integer required	CID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getclientaffiliate" \
  --data-urlencode "cid=123456"

Users

Manage the user accounts on your Send It By Text account.

Add user

POSTrequest=adduser

Creates a user and returns the new user's unique ID.

Parameters

`request` String required	Set to `adduser`
`currentuserid` Integer required	User ID of the admin performing this action
`email` String required	Email address
`fname` String required	First name
`lname` String required	Last name
`password` String required	Password
`mobile` Integer required	Mobile number (without country code)
`phone` Integer required	Phone number (without country code)
`mms` Integer required	1 = MMS feature enabled for this user, 0 = disabled
`allevent` Integer required	1 = show all company events in calendar, 0 = only this user's events
`alltask` Integer required	1 = show all company tasks in the task window, 0 = only this user's tasks
`ecardenabled` Integer required	1 = eCard enabled, 0 = disabled
`ecardURL` String optional	URL (from any portal) for eCard
`allusercalendar` Integer required	1 = selected department users' events appear in calendar
`allusertask` Integer required	1 = selected department users' tasks appear in task window
`department` Integer required	Department ID
`status` Integer required	1 = active, 0 = blocked
`calendardepts` String required	Comma separated calendar department IDs
`taskdepts` String required	Comma separated task department IDs
`extension` Integer optional	Phone extension
`timezone` String required	Time zone
`typeid` Integer optional	2 = admin user, 3 = normal user

Returns: Returns message (success or error text) and UniqueId (the new user's ID).

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=adduser" \
  --data-urlencode "currentuserid=101" \
  --data-urlencode "email=jane.doe@example.com" \
  --data-urlencode "fname=Jane" \
  --data-urlencode "lname=Doe" \
  --data-urlencode "password=ExamplePassw0rd!" \
  --data-urlencode "mobile=8135555678" \
  --data-urlencode "phone=8135555678" \
  --data-urlencode "mms=1" \
  --data-urlencode "allevent=1" \
  --data-urlencode "alltask=1" \
  --data-urlencode "ecardenabled=1" \
  --data-urlencode "allusercalendar=1" \
  --data-urlencode "allusertask=1" \
  --data-urlencode "department=Example Name" \
  --data-urlencode "status=1" \
  --data-urlencode "calendardepts=example" \
  --data-urlencode "taskdepts=example" \
  --data-urlencode "timezone=eastern"

Example response

{
  "message": "Success",
  "UniqueId": 4321
}

Update user

POSTrequest=updateuser

Updates an existing user.

Parameters

`request` String required	Set to `updateuser`
`userid` Integer required	ID of the user to update
`currentuserid` Integer required	User ID of the admin performing this action
`email` String required	Email address
`fname` String required	First name
`lname` String required	Last name
`password` String required	Password
`mobile` Integer required	Mobile number (without country code)
`phone` Integer required	Phone number (without country code)
`mms` Integer required	1 = MMS feature enabled for this user, 0 = disabled
`allevent` Integer required	1 = show all company events in calendar, 0 = only this user's events
`alltask` Integer required	1 = show all company tasks in the task window, 0 = only this user's tasks
`ecardenabled` Integer required	1 = eCard enabled, 0 = disabled
`ecardURL` String optional	URL (from any portal) for eCard
`allusercalendar` Integer required	1 = selected department users' events appear in calendar
`allusertask` Integer required	1 = selected department users' tasks appear in task window
`department` Integer required	Department ID
`status` Integer required	1 = active, 0 = blocked
`calendardepts` String required	Comma separated calendar department IDs
`taskdepts` String required	Comma separated task department IDs
`extension` Integer optional	Phone extension
`timezone` String required	Time zone

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=updateuser" \
  --data-urlencode "userid=101" \
  --data-urlencode "currentuserid=101" \
  --data-urlencode "email=jane.doe@example.com" \
  --data-urlencode "fname=Jane" \
  --data-urlencode "lname=Doe" \
  --data-urlencode "password=ExamplePassw0rd!" \
  --data-urlencode "mobile=8135555678" \
  --data-urlencode "phone=8135555678" \
  --data-urlencode "mms=1" \
  --data-urlencode "allevent=1" \
  --data-urlencode "alltask=1" \
  --data-urlencode "ecardenabled=1" \
  --data-urlencode "allusercalendar=1" \
  --data-urlencode "allusertask=1" \
  --data-urlencode "department=Example Name" \
  --data-urlencode "status=1" \
  --data-urlencode "calendardepts=example" \
  --data-urlencode "taskdepts=example" \
  --data-urlencode "timezone=eastern"

Get user details

POSTrequest=getuserdetails

Returns a user's details by ID.

Parameters

`request` String required	Set to `getuserdetails`
`userid` Integer required	ID of the user whose details are required

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getuserdetails" \
  --data-urlencode "userid=101"

Search users

POSTrequest=searchuser

Searches users by full or partial first name, last name, mobile, or email.

Parameters

`request` String required	Set to `searchuser`
`search` String required	Search term

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=searchuser" \
  --data-urlencode "search=Jane"

List all users

POSTrequest=listallusers

Returns all users.

Parameters

request

String

required

Set to listallusers

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=listallusers"

List active users

POSTrequest=listactiveusers

Returns all active users.

Parameters

request

String

required

Set to listactiveusers

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=listactiveusers"

List inactive users

POSTrequest=listinactiveusers

Returns all inactive users.

Parameters

request

String

required

Set to listinactiveusers

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=listinactiveusers"

Get company users

POSTrequest=getcompanyusers

Returns all users of the company associated with the API key.

Parameters

request

String

required

Set to getcompanyusers

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getcompanyusers"

Get company users by status

POSTrequest=getcompanyusersbystatus

Returns company users filtered by status.

Parameters

`request` String required	Set to `getcompanyusersbystatus`
`status` Integer required	0 = inactive users, 1 = active users, 2 = all users

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getcompanyusersbystatus" \
  --data-urlencode "status=1"

Get user info by phone

POSTrequest=getuserinfobyphone

Returns user information (including user ID and appointment duration) for a phone number.

Parameters

`request` String required	Set to `getuserinfobyphone`
`phone` String required	Phone number (without country code)

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getuserinfobyphone" \
  --data-urlencode "phone=8135555678"

Appointments & Scheduling

Create and manage appointments, check availability, and pull time slots.

Create appointment

POSTrequest=createappointment

Creates an appointment for a client.

Parameters

`request` String required	Set to `createappointment`
`assignedto` Integer required	User ID the appointment is assigned to
`cid` Integer required	Client ID
`precomposedsubject` Integer required	Precomposed subject ID
`subject` String required	Appointment subject
`description` String required	Description of the appointment
`from` Date (String) required	Start, mm/dd/yyyy hh:mm:ss
`to` Date (String) required	End, mm/dd/yyyy hh:mm:ss
`timezone` String required	Time zone (see gettimezones)
`calendareventcomplete` Integer required	0 or 1, completion status
`popupreminder` Integer required	0 or 1, send a popup reminder
`popupremindertime` Integer required	Minutes before the appointment for the reminder
`appointmentreminderid` Integer required	Appointment reminder ID
`sendremindervia` String required	`sms` or `email`
`emailcalendarinvite` Integer required	0 or 1, email a calendar invite
`sendtextconfirmation` Integer required	0 or 1, send a text confirmation
`sendtextconfirmationdays` Integer required	Days before the appointment to send the confirmation
`additionalparticipantstext` String optional	Comma separated mobile numbers of additional participants
`additionalparticipantsemail` String optional	Comma separated email addresses of additional participants
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=createappointment" \
  --data-urlencode "assignedto=101" \
  --data-urlencode "cid=123456" \
  --data-urlencode "precomposedsubject=1" \
  --data-urlencode "subject=Example subject" \
  --data-urlencode "description=Example note text" \
  --data-urlencode "from=08/15/2026 09:00:00" \
  --data-urlencode "to=08/15/2026 10:00:00" \
  --data-urlencode "timezone=eastern" \
  --data-urlencode "calendareventcomplete=1" \
  --data-urlencode "popupreminder=1" \
  --data-urlencode "popupremindertime=1" \
  --data-urlencode "appointmentreminderid=1" \
  --data-urlencode "sendremindervia=example" \
  --data-urlencode "emailcalendarinvite=1" \
  --data-urlencode "sendtextconfirmation=1" \
  --data-urlencode "sendtextconfirmationdays=1" \
  --data-urlencode "userid=101"

Update appointment

POSTrequest=updateappointment

Updates an existing appointment.

Parameters

`request` String required	Set to `updateappointment`
`appointmentid` Integer required	ID of the appointment to update
`assignedto` Integer required	User ID the appointment is assigned to
`cid` Integer required	Client ID
`precomposedsubject` Integer required	Precomposed subject ID
`subject` String required	Appointment subject
`description` String required	Description of the appointment
`from` Date (String) required	Start, mm/dd/yyyy hh:mm:ss
`to` Date (String) required	End, mm/dd/yyyy hh:mm:ss
`timezone` String required	Time zone
`calendareventcomplete` Integer required	0 or 1, completion status
`popupreminder` Integer required	0 or 1, send a popup reminder
`popupremindertime` Integer required	Minutes before the appointment for the reminder
`appointmentreminderid` Integer required	Appointment reminder ID
`sendremindervia` String required	`sms` or `email`
`emailcalendarinvite` Integer required	0 or 1, email a calendar invite
`sendtextconfirmation` Integer required	0 or 1, send a text confirmation
`sendtextconfirmationdays` Integer required	Days before the appointment to send the confirmation
`additionalparticipantstext` String optional	Comma separated mobile numbers of additional participants
`additionalparticipantsemail` String optional	Comma separated email addresses of additional participants

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=updateappointment" \
  --data-urlencode "appointmentid=1" \
  --data-urlencode "assignedto=101" \
  --data-urlencode "cid=123456" \
  --data-urlencode "precomposedsubject=1" \
  --data-urlencode "subject=Example subject" \
  --data-urlencode "description=Example note text" \
  --data-urlencode "from=08/15/2026 09:00:00" \
  --data-urlencode "to=08/15/2026 10:00:00" \
  --data-urlencode "timezone=eastern" \
  --data-urlencode "calendareventcomplete=1" \
  --data-urlencode "popupreminder=1" \
  --data-urlencode "popupremindertime=1" \
  --data-urlencode "appointmentreminderid=1" \
  --data-urlencode "sendremindervia=example" \
  --data-urlencode "emailcalendarinvite=1" \
  --data-urlencode "sendtextconfirmation=1" \
  --data-urlencode "sendtextconfirmationdays=1"

Get appointments by client

POSTrequest=getappointmentsbyclientid

Returns the appointments for a client.

Parameters

`request` String required	Set to `getappointmentsbyclientid`
`cid` Integer required	ID of the client whose appointments are to be listed

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getappointmentsbyclientid" \
  --data-urlencode "cid=123456"

Get appointment reminders by date

POSTrequest=getappointmentreminderlistbydate

Returns appointments within a date range for reminder purposes.

Parameters

`request` String required	Set to `getappointmentreminderlistbydate`
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getappointmentreminderlistbydate" \
  --data-urlencode "userid=101"

Confirm appointment

POSTrequest=confirmappointment

Books and confirms an appointment slot. Duration comes from getuserinfobyphone, locations from getlocations, resources from getresources.

Parameters

`request` String required	Set to `confirmappointment`
`userid` Integer required	User ID
`clientid` Integer required	Client ID
`duration` Integer required	Appointment duration
`date` String required	Date of the appointment
`time` String required	Time of the appointment
`subject` String required	Subject
`locationid` Integer required	Location ID
`resourceid` Integer required	Resource ID
`notes` String required	Description or notes
`timezone` String required	Time zone (see gettimezones)
`sendreminder` Integer required	0 or 1
`sendremindertime` Integer required	Minutes before the appointment
`sendconfirmation` Integer required	0 or 1
`sendconfirmationdays` Integer required	Days before the appointment

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=confirmappointment" \
  --data-urlencode "userid=101" \
  --data-urlencode "clientid=123456" \
  --data-urlencode "duration=1" \
  --data-urlencode "date=example" \
  --data-urlencode "time=example" \
  --data-urlencode "subject=Example subject" \
  --data-urlencode "locationid=1" \
  --data-urlencode "resourceid=1" \
  --data-urlencode "notes=Example note text" \
  --data-urlencode "timezone=eastern" \
  --data-urlencode "sendreminder=1" \
  --data-urlencode "sendremindertime=1" \
  --data-urlencode "sendconfirmation=1" \
  --data-urlencode "sendconfirmationdays=1"

Get time slots

POSTrequest=gettimeslots

Returns a user's available time slots on a given date for a given duration.

Parameters

`request` String required	Set to `gettimeslots`
`userid` Integer required	User ID
`duration` Integer required	Slot duration
`date` String required	Date
`timezone` String required	Time zone

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=gettimeslots" \
  --data-urlencode "userid=101" \
  --data-urlencode "duration=1" \
  --data-urlencode "date=example" \
  --data-urlencode "timezone=eastern"

Get next 30 working days

POSTrequest=getnext30workingdays

Returns the next 30 working days for a user.

Parameters

`request` String required	Set to `getnext30workingdays`
`userid` Integer required	ID of the user whose working days are required

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getnext30workingdays" \
  --data-urlencode "userid=101"

Get additional people

POSTrequest=getadditionalpeople

Returns the additional participants who can view an appointment.

Parameters

`request` String required	Set to `getadditionalpeople`
`appointmentid` Integer required	Appointment ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getadditionalpeople" \
  --data-urlencode "appointmentid=1"

Get locations

POSTrequest=getlocations

Returns the list of locations.

Parameters

request

String

required

Set to getlocations

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getlocations"

Get resources

POSTrequest=getresources

Returns the list of resources for a user.

Parameters

`request` String required	Set to `getresources`
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getresources" \
  --data-urlencode "userid=101"

Get time zones

POSTrequest=gettimezones

Returns the list of supported time zones.

Parameters

request

String

required

Set to gettimezones

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=gettimezones"

Tasks

Create and track tasks assigned to users and clients.

Add task

POSTrequest=addtask

Creates a task for a client and assigns it to a user. Priority IDs come from gettaskpriorities; preselected task IDs from getpreselectedtasksforuse.

Parameters

`request` String required	Set to `addtask`
`cid` Integer required	Client the task is for
`assignedto` Integer required	User the task is assigned to
`priority` Integer required	Priority ID
`preselectedtask` Integer required	Preselected task ID
`followupdate` Date (String) required	Follow up date
`tasknotes` String required	Task notes
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=addtask" \
  --data-urlencode "cid=123456" \
  --data-urlencode "assignedto=101" \
  --data-urlencode "priority=1" \
  --data-urlencode "preselectedtask=1" \
  --data-urlencode "followupdate=08/15/2026" \
  --data-urlencode "tasknotes=Example note text" \
  --data-urlencode "userid=101"

Update task

POSTrequest=updatetask

Updates an existing task.

Parameters

`request` String required	Set to `updatetask`
`taskid` Integer required	ID of the task to update
`cid` Integer required	Client the task is for
`assignedto` Integer required	User the task is assigned to
`priority` Integer required	Priority ID
`preselectedtask` Integer required	Preselected task ID
`followupdate` Date (String) required	Follow up date
`tasknotes` String required	Task notes
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=updatetask" \
  --data-urlencode "taskid=1" \
  --data-urlencode "cid=123456" \
  --data-urlencode "assignedto=101" \
  --data-urlencode "priority=1" \
  --data-urlencode "preselectedtask=1" \
  --data-urlencode "followupdate=08/15/2026" \
  --data-urlencode "tasknotes=Example note text" \
  --data-urlencode "userid=101"

Get client tasks

POSTrequest=getclienttasks

Returns the tasks for a client.

Parameters

`request` String required	Set to `getclienttasks`
`cid` Integer required	ID of the client whose tasks are to be listed

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getclienttasks" \
  --data-urlencode "cid=123456"

Get task details

POSTrequest=gettaskdetails

Returns the details of a task by task ID.

Parameters

`request` String required	Set to `gettaskdetails`
`taskid` Integer required	Task ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=gettaskdetails" \
  --data-urlencode "taskid=1"

Get tasks assigned to me

POSTrequest=gettasksassignedtome

Returns tasks assigned to the requesting user.

Parameters

`request` String required	Set to `gettasksassignedtome`
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=gettasksassignedtome" \
  --data-urlencode "userid=101"

Get tasks assigned by me

POSTrequest=gettasksassignedbyme

Returns tasks assigned by the requesting user.

Parameters

`request` String required	Set to `gettasksassignedbyme`
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=gettasksassignedbyme" \
  --data-urlencode "userid=101"

Get tasks for all users

POSTrequest=gettasksassignedtoallusers

Returns tasks assigned to all users of the company.

Parameters

`request` String required	Set to `gettasksassignedtoallusers`
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=gettasksassignedtoallusers" \
  --data-urlencode "userid=101"

Get task priorities

POSTrequest=gettaskpriorities

Returns the available task priorities and their IDs.

Parameters

request

String

required

Set to gettaskpriorities

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=gettaskpriorities"

Get preselected tasks

POSTrequest=getpreselectedtasksforuse

Returns the company's preselected tasks and their IDs.

Parameters

request

String

required

Set to getpreselectedtasksforuse

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getpreselectedtasksforuse"

Notes & Documents

Client notes, audit trail, and document upload and retrieval.

Add note

POSTrequest=addnote

Adds a note to a client.

Heads up: cid here is the internal record ID (the ID field from searchclient), not the visible Contact ID.

Parameters

`request` String required	Set to `addnote`
`cid` Integer required	ID of the client the note is added to
`note` String required	Note text
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=addnote" \
  --data-urlencode "cid=123456" \
  --data-urlencode "note=Example note text" \
  --data-urlencode "userid=101"

Update note

POSTrequest=updatenote

Updates a note. Set append to 1 to append to the existing note instead of replacing it.

Parameters

`request` String required	Set to `updatenote`
`noteid` Integer required	ID of the note to update
`note` String required	Note text
`userid` Integer required	User ID
`append` Integer optional	0 = replace, 1 = append

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=updatenote" \
  --data-urlencode "noteid=1" \
  --data-urlencode "note=Example note text" \
  --data-urlencode "userid=101"

Delete note

POSTrequest=deletenote

Deletes a note.

Parameters

`request` String required	Set to `deletenote`
`noteid` Integer required	ID of the note to delete

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=deletenote" \
  --data-urlencode "noteid=1"

Get all notes by client

POSTrequest=getallnotesbyclientid

Returns all notes (the audit trail) for a client.

Parameters

`request` String required	Set to `getallnotesbyclientid`
`cid` Integer required	ID of the client whose notes are to be listed

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getallnotesbyclientid" \
  --data-urlencode "cid=123456"

Get document details by client

POSTrequest=getdocsdetailsbycid

Returns the Documents tab rows (including eSignature records) for a contact by CID.

Heads up: Document URLs can contain spaces. URL encode them before downloading.

Parameters

`request` String required	Set to `getdocsdetailsbycid`
`cid` Integer required	CID (internal record ID)

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getdocsdetailsbycid" \
  --data-urlencode "cid=123456"

Example response

[
  {
    "RecordID": 1261005,
    "Status": "signed",
    "DocumentName": "Example Agreement.pdf",
    "SignedFileUrl": "https://useclientconnect.com/Docs/SignedDocs/123456/Example%20Agreement.pdf",
    "DateTime": "2026-06-16T20:35:29.827"
  }
]

Upload document

POSTrequest=uploaddocument

Uploads a file to a contact's document section. Send as multipart form data with the file attached.

Heads up: When using browser FormData, do not set the Content-Type header manually. The browser sets the multipart boundary for you; overriding it breaks the upload.

Parameters

`request` String required	Set to `uploaddocument`
`userid` Integer required	User ID
`cid` Integer required	CID
`File` File required	File to upload, POSTed with the request

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -F "request=uploaddocument" \
  -F "userid=101" \
  -F "cid=123456" \
  -F "File=@./example.pdf"

Get case document data

POSTrequest=getcasedocumentdata

Returns case document data by CID and document ID.

Parameters

`request` String required	Set to `getcasedocumentdata`
`CID` Integer required	Client ID
`DocumentID` Integer required	Document ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getcasedocumentdata" \
  --data-urlencode "CID=123456" \
  --data-urlencode "DocumentID=1"

Send document data portal link

POSTrequest=SendDDPlink

Sends a Document Data Portal (DDP) link to a client by email, text, or both. Include the [DDPLink] tag in the email body and/or SMS body; it is replaced with the actual link.

Parameters

`request` String required	Set to `SendDDPlink`
`CID` Integer required	Client ID
`DocumentID` String required	Document ID
`SendVia` String required	`email`, `text`, or `both`
`emailsubject` String conditional	Required when SendVia is `email` or `both`
`emailbody` String conditional	Required when SendVia is `email` or `both`. Must include the `[DDPLink]` tag
`smsbody` String conditional	Required when SendVia is `text` or `both`. Must include the `[DDPLink]` tag

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=SendDDPlink" \
  --data-urlencode "CID=123456" \
  --data-urlencode "DocumentID=example" \
  --data-urlencode "SendVia=text"

eSignature

Send documents for signature, track status, and manage templates. Supports up to four signers.

White tags. When you prepare a PDF or Word document for signrequest, place white colored tags in the document where fields should appear: ^S1 signature, ^I1 initial, ^D1 date, ^M1 mandatory text, ^T1 optional text, ^R1_G1 radio button, each for signer 1. Use ^S2 through ^S4 (and matching tags) for signers 2 through 4. For radio buttons, _G[number] defines the group; up to 9 groups per signer (^R1_G1 through ^R1_G9), with any number of radios per group.

Send document for signature

POSTrequest=signrequest

Sends a document (PDF or Word) to a client for signature. POST the file with the request, or send it Base64 encoded in rawdata with a filename. Note the different endpoint URL below.

Different endpoint URL. POST this request to https://useclientconnect.com/api/signrequest_v2.ashx instead of the standard base URL.

Parameters

`request` String required	Set to `signrequest`
`userid` String required	User ID
`cid` String required	Client ID
`sendvia` String required	`email`, `text`, or `both`
`ishandsign` String optional	`yes` or `no`. Anything other than yes is treated as no
`secondsigner` String optional	`yes` or `no`
`secondsignerfirstname` String optional	Second signer first name
`secondsignerlastname` String optional	Second signer last name
`secondsigneremail` String optional	Second signer email address
`secondsignermobile` String optional	Second signer mobile number
`secondsignersendvia` String optional	`email`, `text`, or `both`
`signerpreference` Integer optional	1 = send to first signer first, 2 = send to second signer first
`bypass3dayswait` String optional	`yes` skips the 3 day review wait period so the document can be signed immediately
`pdftoimage` Integer optional	0 = PDF to HTML conversion, 1 = PDF to image conversion
`filename` String conditional	File name with extension (.pdf or .docx). Required only when sending the file Base64 encoded in the body
`rawdata` String (Base64) conditional	File contents, Base64 encoded. Not required if the file is POSTed with the request
`File` File conditional	File POSTed with the request. Not required if `rawdata` is used

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/signrequest_v2.ashx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=signrequest" \
  --data-urlencode "userid=101" \
  --data-urlencode "cid=123456" \
  --data-urlencode "sendvia=text"

Send pre-tagged document for signature

POSTrequest=sendpretaggeddocumentforsignature

Sends a saved signature template (or several) to a client for signature. Template IDs come from getsignaturetemplatesandgrouplist. Supports up to four signers.

Parameters

`request` String required	Set to `sendpretaggeddocumentforsignature`
`userid` String required	User ID
`cid` String required	Client ID
`templateid` String required	Template record ID. Single entry or comma separated multiple entries
`sendvia` String required	`email` or `text`
`donotsend` Integer optional	1 = do not send email/SMS notifications, 0 = send them
`bypass3dayswait` String optional	`yes` skips the 3 day review wait period
`custommessageid` Integer optional	Custom message ID (see getcompanycustomsignaturemessages)
`signerpreference` Integer optional	1 = first signer first, 2 = second signer first
`secondsigner` String optional	`yes` or `no`
`secondsignerfirstname` String optional	Second signer first name
`secondsignerlastname` String optional	Second signer last name
`secondsigneremail` String optional	Second signer email address
`secondsignermobile` String optional	Second signer mobile number
`secondsignersendvia` String optional	`email` or `text`
`thirdsigner` String optional	`yes` or `no`
`thirdsignerfirstname` String optional	Third signer first name
`thirdsignerlastname` String optional	Third signer last name
`thirdsigneremail` String optional	Third signer email address
`thirdsignermobile` String optional	Third signer mobile number
`thirdsignersendvia` String optional	`email` or `text`
`fourthsigner` String optional	`yes` or `no`
`fourthsignerfirstname` String optional	Fourth signer first name
`fourthsignerlastname` String optional	Fourth signer last name
`fourthsigneremail` String optional	Fourth signer email address
`fourthsignermobile` String optional	Fourth signer mobile number
`fourthsignersendvia` String optional	`email` or `text`

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=sendpretaggeddocumentforsignature" \
  --data-urlencode "userid=101" \
  --data-urlencode "cid=123456" \
  --data-urlencode "templateid=example" \
  --data-urlencode "sendvia=text"

Get signature status

POSTrequest=getsignstatus

Returns the status of a document sent for signature.

Parameters

`request` String required	Set to `getsignstatus`
`recordid` Integer required	Record ID returned when the document was sent

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getsignstatus" \
  --data-urlencode "recordid=1"

Void document

POSTrequest=voiddocument

Voids a signed document.

Parameters

`request` String required	Set to `voiddocument`
`recordid` Integer required	Record ID or package ID
`userid` Integer optional	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=voiddocument" \
  --data-urlencode "recordid=1"

Release document

POSTrequest=releasedocument

Releases (unlocks) a document.

Parameters

`request` String required	Set to `releasedocument`
`recordid` Integer required	Record ID returned when the document was sent

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=releasedocument" \
  --data-urlencode "recordid=1"

Get eSign template list

POSTrequest=getesigntemplatelist

Returns the company's eSign templates.

Parameters

request

String

required

Set to getesigntemplatelist

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getesigntemplatelist"

Get signature templates and groups

POSTrequest=getsignaturetemplatesandgrouplist

Returns the individual and group signature templates.

Parameters

request

String

required

Set to getsignaturetemplatesandgrouplist

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getsignaturetemplatesandgrouplist"

Get custom signature messages

POSTrequest=getcompanycustomsignaturemessages

Returns the company's custom signature messages.

Parameters

request

String

required

Set to getcompanycustomsignaturemessages

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getcompanycustomsignaturemessages"

Delete eSign template

POSTrequest=deleteesigntemplate

Deletes an eSign template.

Parameters

`request` String required	Set to `deleteesigntemplate`
`stid` Integer required	ID of the eSign template to delete

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=deleteesigntemplate" \
  --data-urlencode "stid=1"

Get signing link

POSTrequest=getsigninglink

Returns the link for the most recent unsigned sign request for a mobile number. Useful for re-sending a signing link when a client says they lost the original text or email.

Heads up: Looks up by mobile number and returns only the last unsigned request. If multiple documents are outstanding, only the most recent one comes back.

Parameters

`request` String required	Set to `getsigninglink`
`mobiletel` Integer required	Mobile number, unformatted, with country code

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getsigninglink" \
  --data-urlencode "mobiletel=8135555678"

Message Templates

Manage precomposed (canned) responses, subjects, opt-in messages, eMessages, and per-user templates.

Get precomposed responses

POSTrequest=getcannedresponse

Returns the company's precomposed responses.

Parameters

request

String

required

Set to getcannedresponse

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getcannedresponse"

Add precomposed response

POSTrequest=addcannedresponse

Creates a precomposed response.

Parameters

`request` String required	Set to `addcannedresponse`
`cannedresponse` String required	Precomposed response text
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=addcannedresponse" \
  --data-urlencode "cannedresponse=example" \
  --data-urlencode "userid=101"

Update precomposed response

POSTrequest=updatecannedresponse

Updates a precomposed response.

Parameters

`request` String required	Set to `updatecannedresponse`
`caid` Integer required	ID of the precomposed response
`cannedresponse` String required	New precomposed response text

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=updatecannedresponse" \
  --data-urlencode "caid=1" \
  --data-urlencode "cannedresponse=example"

Delete precomposed response

POSTrequest=deletecannedresponse

Deletes a precomposed response.

Parameters

`request` String required	Set to `deletecannedresponse`
`caid` Integer required	ID of the precomposed response

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=deletecannedresponse" \
  --data-urlencode "caid=1"

Add precomposed subject

POSTrequest=addcannedsubject

Creates a precomposed subject.

Parameters

`request` String required	Set to `addcannedsubject`
`cannedsubject` String required	Precomposed subject
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=addcannedsubject" \
  --data-urlencode "cannedsubject=example" \
  --data-urlencode "userid=101"

Update precomposed subject

POSTrequest=updatecannedsubject

Updates a precomposed subject.

Parameters

`request` String required	Set to `updatecannedsubject`
`csid` Integer required	ID of the precomposed subject
`cannedsubject` String required	New precomposed subject

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=updatecannedsubject" \
  --data-urlencode "csid=1" \
  --data-urlencode "cannedsubject=example"

Delete precomposed subject

POSTrequest=deletecannedsubject

Deletes a precomposed subject.

Parameters

`request` String required	Set to `deletecannedsubject`
`csid` Integer required	ID of the precomposed subject

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=deletecannedsubject" \
  --data-urlencode "csid=1"

Get precomposed opt-ins

POSTrequest=getcannedoptin

Returns the company's precomposed opt-ins.

Parameters

request

String

required

Set to getcannedoptin

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getcannedoptin"

Add precomposed opt-in

POSTrequest=addcannedoptin

Creates a precomposed opt-in.

Parameters

`request` String required	Set to `addcannedoptin`
`cannedoptin` String required	Precomposed opt-in text
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=addcannedoptin" \
  --data-urlencode "cannedoptin=example" \
  --data-urlencode "userid=101"

Update precomposed opt-in

POSTrequest=updatecannedoptin

Updates a precomposed opt-in.

Parameters

`request` String required	Set to `updatecannedoptin`
`coid` Integer required	ID of the precomposed opt-in
`cannedoptin` String required	New precomposed opt-in text

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=updatecannedoptin" \
  --data-urlencode "coid=1" \
  --data-urlencode "cannedoptin=example"

Delete precomposed opt-in

POSTrequest=deletecannedoptin

Deletes a precomposed opt-in.

Parameters

`request` String required	Set to `deletecannedoptin`
`coid` Integer required	ID of the precomposed opt-in

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=deletecannedoptin" \
  --data-urlencode "coid=1"

Add precomposed eMessage

POSTrequest=addcannedemessage

Creates a precomposed eMessage.

Parameters

`request` String required	Set to `addcannedemessage`
`cannedemessage` String required	Precomposed eMessage text
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=addcannedemessage" \
  --data-urlencode "cannedemessage=example" \
  --data-urlencode "userid=101"

Update precomposed eMessage

POSTrequest=updatecannedemessage

Updates a precomposed eMessage.

Parameters

`request` String required	Set to `updatecannedemessage`
`ceid` Integer required	ID of the precomposed eMessage
`cannedemessage` String required	New precomposed emessage text

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=updatecannedemessage" \
  --data-urlencode "ceid=1" \
  --data-urlencode "cannedemessage=example"

Delete precomposed eMessage

POSTrequest=deletecannedemessage

Deletes a precomposed eMessage.

Parameters

`request` String required	Set to `deletecannedemessage`
`ceid` Integer required	ID of the precomposed eMessage

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=deletecannedemessage" \
  --data-urlencode "ceid=1"

Get precomposed subjects

POSTrequest=getcannedsubjects

Returns the company's precomposed subjects.

Parameters

request

String

required

Set to getcannedsubjects

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getcannedsubjects"

Get precomposed eMessages

POSTrequest=getcannedemessages

Returns the company's precomposed eMessages.

Parameters

request

String

required

Set to getcannedemessages

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getcannedemessages"

Get user precomposed responses

POSTrequest=getusercannedresponses

Returns a user's personal precomposed responses.

Parameters

`request` String required	Set to `getusercannedresponses`
`userid` Integer required	ID of the user whose precomposed responses are listed

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getusercannedresponses" \
  --data-urlencode "userid=101"

Add user precomposed response

POSTrequest=addusercannedresponse

Creates a personal precomposed response for a user.

Parameters

`request` String required	Set to `addusercannedresponse`
`userid` Integer required	ID of the user the response belongs to
`cannedresponse` String required	Precomposed response text

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=addusercannedresponse" \
  --data-urlencode "userid=101" \
  --data-urlencode "cannedresponse=example"

Update user precomposed response

POSTrequest=updateusercannedresponse

Updates a user's personal precomposed response.

Parameters

`request` String required	Set to `updateusercannedresponse`
`cannedid` Integer required	ID of the precomposed response to update
`cannedresponse` String required	Precomposed response text
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=updateusercannedresponse" \
  --data-urlencode "cannedid=1" \
  --data-urlencode "cannedresponse=example" \
  --data-urlencode "userid=101"

Delete user precomposed response

POSTrequest=deleteusercannedresponse

Deletes a user's personal precomposed response.

Parameters

`request` String required	Set to `deleteusercannedresponse`
`cannedid` Integer required	ID of the precomposed response to delete

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=deleteusercannedresponse" \
  --data-urlencode "cannedid=1"

App & eCard Messages

Manage and send in-app notification messages and eCards.

Get app messages

POSTrequest=getappmessages

Returns the company's app notification message templates.

Parameters

request

String

required

Set to getappmessages

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getappmessages"

Add app message

POSTrequest=addappmessage

Creates an app message template.

Parameters

`request` String required	Set to `addappmessage`
`appmessage` String required	App message text
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=addappmessage" \
  --data-urlencode "appmessage=example" \
  --data-urlencode "userid=101"

Update app message

POSTrequest=updateappmessage

Updates an app message template.

Parameters

`request` String required	Set to `updateappmessage`
`amid` Integer required	ID of the app message to update
`appmessage` String required	New app message text

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=updateappmessage" \
  --data-urlencode "amid=1" \
  --data-urlencode "appmessage=example"

Delete app message

POSTrequest=deleteappmessage

Deletes an app message template.

Parameters

`request` String required	Set to `deleteappmessage`
`amid` Integer required	ID of the app message to delete

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=deleteappmessage" \
  --data-urlencode "amid=1"

Send app message

POSTrequest=sendappmessage

Sends an app notification message to a client.

Parameters

`request` String required	Set to `sendappmessage`
`cid` Integer required	Client ID
`amid` Integer required	ID of the app message to send
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=sendappmessage" \
  --data-urlencode "cid=123456" \
  --data-urlencode "amid=1" \
  --data-urlencode "userid=101"

Get eCard messages

POSTrequest=getecardmessages

Returns the company's eCard message templates.

Parameters

request

String

required

Set to getecardmessages

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getecardmessages"

Add eCard message

POSTrequest=addecardmessage

Creates an eCard message template.

Parameters

`request` String required	Set to `addecardmessage`
`ecardmessage` String required	eCard message text
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=addecardmessage" \
  --data-urlencode "ecardmessage=example" \
  --data-urlencode "userid=101"

Update eCard message

POSTrequest=updateecardmessage

Updates an eCard message template.

Parameters

`request` String required	Set to `updateecardmessage`
`emid` Integer required	ID of the eCard message to update
`ecardmessage` String required	eCard message text

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=updateecardmessage" \
  --data-urlencode "emid=1" \
  --data-urlencode "ecardmessage=example"

Delete eCard message

POSTrequest=deleteecardmessage

Deletes an eCard message template.

Parameters

`request` String required	Set to `deleteecardmessage`
`emid` Integer required	ID of the eCard message to delete

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=deleteecardmessage" \
  --data-urlencode "emid=1"

Send eCard

POSTrequest=sendecard

Sends an eCard to a client.

Parameters

`request` String required	Set to `sendecard`
`cid` Integer required	Client ID
`userid` Integer required	User ID
`ecid` Integer optional	ID of the eCard message to send

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=sendecard" \
  --data-urlencode "cid=123456" \
  --data-urlencode "userid=101"

Groups, Statuses & Custom Fields

Contact groups, contact statuses, and custom field definitions and data.

Add new group

POSTrequest=addnewgroup

Creates a new contact group for the company.

Parameters

`request` String required	Set to `addnewgroup`
`groupname` String required	Group name

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=addnewgroup" \
  --data-urlencode "groupname=Example Name"

Add contact to groups

POSTrequest=addcontactgroups

Assigns a contact to one or more groups. This is the reliable way to set group membership; addclient and updateclient do not reliably assign groups.

Heads up: Use numeric group IDs (from getcontactgroups), never group names.

Parameters

`request` String required	Set to `addcontactgroups`
`cid` Integer required	Client ID
`clientgroups` String required	Comma separated group IDs

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=addcontactgroups" \
  --data-urlencode "cid=123456" \
  --data-urlencode "clientgroups=example"

Example response

{ "message": "Group assigned successfully." }

Get contact groups

POSTrequest=getcontactgroups

Returns the contact groups.

Parameters

`request` String required	Set to `getcontactgroups`
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getcontactgroups" \
  --data-urlencode "userid=101"

Remove contact from groups

POSTrequest=deletecontactgroups

Removes a contact from one or more groups.

Parameters

`request` String required	Set to `deletecontactgroups`
`cid` Integer required	Client ID
`clientgroups` String required	Comma separated group IDs

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=deletecontactgroups" \
  --data-urlencode "cid=123456" \
  --data-urlencode "clientgroups=example"

Get contact statuses

POSTrequest=getcontactstatuses

Returns the available contact statuses and their IDs.

Parameters

request

String

required

Set to getcontactstatuses

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getcontactstatuses"

Get custom fields

POSTrequest=getcustomfields

Returns all available custom field definitions. Custom fields are configured per company, so always check the definitions before relying on a field label.

Parameters

request

String

required

Set to getcustomfields

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getcustomfields"

Example response

[
  {
    "FieldName": "CustomText4",
    "FieldLabel": "Account Reference",
    "FieldType": "Text"
  }
]

Get custom field data

POSTrequest=getcustomfieldsdata

Returns the custom field values for a contact.

Heads up: contactid here is the visible Contact ID (UniqueClientID from searchclient), not the internal cid. This is the main exception to the usual ID rule; see the identifier guide.

Parameters

`request` String required	Set to `getcustomfieldsdata`
`contactid` Integer required	Contact ID (visible ID, not internal cid)

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getcustomfieldsdata" \
  --data-urlencode "contactid=123456"

Company & Departments

Company settings, business hours, departments, local numbers, and performance reporting.

Get company details

POSTrequest=getcompanydetails

Returns the details of the company associated with the API key.

Parameters

request

String

required

Set to getcompanydetails

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getcompanydetails"

Update company

POSTrequest=updatecompany

Updates company information, including business hours for each day of the week.

Parameters

`request` String required	Set to `updatecompany`
`alwaysopen` Integer required	1 = company is always open, 0 = use daily hours
`sundayopen` Integer required	1 = open, 0 = closed
`sundaystart` String required	Sunday opening time, e.g. `9:00AM`
`sundayend` String required	Sunday closing time, e.g. `5:00PM`
`mondayopen` Integer required	1 = open, 0 = closed
`mondaystart` String required	Monday opening time
`mondayend` String required	Monday closing time
`tuesdayopen` Integer required	1 = open, 0 = closed
`tuesdaystart` String required	Tuesday opening time
`tuesdayend` String required	Tuesday closing time
`wednesdayopen` Integer required	1 = open, 0 = closed
`wednesdaystart` String required	Wednesday opening time
`wednesdayend` String required	Wednesday closing time
`thursdayopen` Integer required	1 = open, 0 = closed
`thursdaystart` String required	Thursday opening time
`thursdayend` String required	Thursday closing time
`fridayopen` Integer required	1 = open, 0 = closed
`fridaystart` String required	Friday opening time
`fridayend` String required	Friday closing time
`saturdayopen` Integer required	1 = open, 0 = closed
`saturdaystart` String required	Saturday opening time
`saturdayend` String required	Saturday closing time
`leavemessagetime` Integer required	Auto-remove messages from the Unanswered Text window after this period (one day, one week)

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=updatecompany" \
  --data-urlencode "alwaysopen=1" \
  --data-urlencode "sundayopen=1" \
  --data-urlencode "sundaystart=example" \
  --data-urlencode "sundayend=example" \
  --data-urlencode "mondayopen=1" \
  --data-urlencode "mondaystart=example" \
  --data-urlencode "mondayend=example" \
  --data-urlencode "tuesdayopen=1" \
  --data-urlencode "tuesdaystart=example" \
  --data-urlencode "tuesdayend=example" \
  --data-urlencode "wednesdayopen=1" \
  --data-urlencode "wednesdaystart=example" \
  --data-urlencode "wednesdayend=example" \
  --data-urlencode "thursdayopen=1" \
  --data-urlencode "thursdaystart=example" \
  --data-urlencode "thursdayend=example" \
  --data-urlencode "fridayopen=1" \
  --data-urlencode "fridaystart=example" \
  --data-urlencode "fridayend=example" \
  --data-urlencode "saturdayopen=1" \
  --data-urlencode "saturdaystart=example" \
  --data-urlencode "saturdayend=example" \
  --data-urlencode "leavemessagetime=1"

Get company performance report

POSTrequest=getcompanyperformancereport

Returns the company's performance report.

Parameters

`request` String required	Set to `getcompanyperformancereport`
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getcompanyperformancereport" \
  --data-urlencode "userid=101"

Get departments

POSTrequest=getdepartments

Returns the company's departments.

Parameters

request

String

required

Set to getdepartments

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getdepartments"

Add department

POSTrequest=adddepartment

Creates a department.

Parameters

`request` String required	Set to `adddepartment`
`department` String required	Department name
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=adddepartment" \
  --data-urlencode "department=Example Name" \
  --data-urlencode "userid=101"

Update department

POSTrequest=updatedepartment

Renames a department.

Parameters

`request` String required	Set to `updatedepartment`
`did` Integer required	ID of the department to update
`department` String required	New department name

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=updatedepartment" \
  --data-urlencode "did=1" \
  --data-urlencode "department=Example Name"

Delete department

POSTrequest=deletedepartment

Deletes a department.

Parameters

`request` String required	Set to `deletedepartment`
`did` Integer required	ID of the department to delete

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=deletedepartment" \
  --data-urlencode "did=1"

Get company local numbers

POSTrequest=getcompanylocalnumbers

Returns the company's local phone numbers.

Parameters

request

String

required

Set to getcompanylocalnumbers

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getcompanylocalnumbers"

Reporting

Delivery reports and message counts.

Get text delivery report

POSTrequest=gettextdeliveryreport

Returns SMS delivery status over a date range, with optional filters.

Parameters

`request` String required	Set to `gettextdeliveryreport`
`direction` Integer required	0 = both, 1 = inbound, 2 = outbound
`shortcode` Integer required	1 = short code texts only, 0 = all
`startdate` Date (String) required	Start date, mm/dd/yyyy hh:mm:ss
`enddate` Date (String) required	End date, mm/dd/yyyy hh:mm:ss
`userid` Integer optional	User ID
`phone` Integer optional	Phone number (without country code)
`status` Integer optional	0 = delivered, 1 = undelivered, 2 = failed
`groups` String optional	Comma separated group IDs
`campaigntype` Integer optional	Campaign type ID, 1 through 4

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=gettextdeliveryreport" \
  --data-urlencode "direction=1" \
  --data-urlencode "shortcode=1" \
  --data-urlencode "startdate=08/15/2026 09:00:00" \
  --data-urlencode "enddate=08/15/2026 10:00:00"

Get unanswered SMS count

POSTrequest=getunansweredsmscount

Returns the count of unanswered (unread) SMS messages.

Parameters

`request` String required	Set to `getunansweredsmscount`
`userid` Integer required	User ID

Returns: JSON. A detailed response schema for this call is being added; see Responses & errors for the general pattern.

Example request

curl -X POST \
  "https://useclientconnect.com/api/clientconnect_v2.aspx" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request=getunansweredsmscount" \
  --data-urlencode "userid=101"

Webhooks

Send It By Text can push events to your systems, so you do not have to poll.

Webhooks follow a different pattern from the standard API: they are HTTP POSTs from Send It By Text to a URL you host. To have a webhook configured for your account, contact developer support.

Signing status webhook

Fires when the status of a document sent for signature changes. Use it instead of polling getsignstatus.

Example payload

{
  "RecordID": "123456",
  "StatusDate": "2026-02-23T21:26:41Z",
  "Status": "Signed",
  "PackageID": "PKG-123",
  "SignerType": "1st",
  "FileName": "Agreement.pdf",
  "CID": "1234567",
  "ContactID": "9876543"
}

Handling guidance

Validate the webhook's auth token before processing, and treat every payload field as untrusted input.
Ignore blank or incomplete signing events.
CID is the internal API cid; ContactID is the visible display ID (see the identifier guide).
Make your receiver idempotent by event or document ID; the same event can arrive more than once.
Store raw payloads only in secure logs with PII controls.

Notes intake webhook

A webhook-style endpoint at https://useclientconnect.com/addnotes_webhook.aspx accepts a JSON body (with the key inside the body rather than a header) for pushing notes from external systems. Because it does not follow the standard API pattern, contact developer support for the current contract before building against it.

Code samples

The same call in the language you are already using, plus recipes for the most common workflows.

A reusable JavaScript helper

Wraps the request pattern once, then every call is a one-liner. Note the defensive error check; see Responses & errors.

JavaScript

async function postSendItByText(params) {
  const response = await fetch("https://useclientconnect.com/api/clientconnect_v2.aspx", {
    method: "POST",
    headers: {
      apikey: process.env.SENDITBYTEXT_API_KEY,
      "Content-Type": "application/x-www-form-urlencoded",
      Accept: "application/json, text/plain, */*"
    },
    body: new URLSearchParams(params).toString()
  });

  const raw = await response.text();

  try {
    const parsed = JSON.parse(raw);
    if (parsed?.message && /error|invalid|failed|exceeded/i.test(parsed.message)) {
      throw new Error(parsed.message);
    }
    return parsed;
  } catch (err) {
    throw new Error(`Send It By Text API error: ${raw}`);
  }
}

Recipe: find a contact and send an SMS

JavaScript

// 1. Find the contact
const matches = await postSendItByText({
  request: "searchclient",
  search: "8135551212"
});

const contact = matches[0];

// 2. Send the text, using the internal ID as cid
await postSendItByText({
  request: "sendclienttext",
  cid: String(contact.ID),
  from: "8135551234",
  to: "8135551212",
  text: "Thanks for contacting us. We received your request.",
  userid: "101"
});

Recipe: create a contact and assign a group

JavaScript

// 1. Create the contact and capture the returned ID
const created = await postSendItByText({
  request: "addclient",
  fname: "Jane",
  lname: "Smith",
  mobile: "8135551212",
  email: "jane@example.com",
  userid: "101"
});

const cid = created.UniqueId;

// 2. Assign the group separately (addclient does not do this reliably)
await postSendItByText({
  request: "addcontactgroups",
  cid: String(cid),
  clientgroups: "42"
});

Python

import os
import requests

url = "https://useclientconnect.com/api/clientconnect_v2.aspx"
headers = {"apikey": os.environ["SENDITBYTEXT_API_KEY"]}
data = {"request": "searchclient", "search": "Jane Smith"}

res = requests.post(url, headers=headers, data=data, timeout=30)
res.raise_for_status()
print(res.json())

PHP

<?php
$ch = curl_init("https://useclientconnect.com/api/clientconnect_v2.aspx");

curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_HTTPHEADER => ["apikey: " . getenv("SENDITBYTEXT_API_KEY")],
  CURLOPT_POSTFIELDS => http_build_query([
    "request" => "searchclient",
    "search" => "Jane Smith"
  ]),
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_TIMEOUT => 30
]);

$response = curl_exec($ch);
if ($response === false) {
  throw new Exception(curl_error($ch));
}

curl_close($ch);
echo $response;

C#

using System.Net.Http;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post,
    "https://useclientconnect.com/api/clientconnect_v2.aspx");
request.Headers.Add("apikey",
    Environment.GetEnvironmentVariable("SENDITBYTEXT_API_KEY"));
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> {
  { "request", "searchclient" },
  { "search", "Jane Smith" }
});

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
response.EnsureSuccessStatusCode();
Console.WriteLine(body);

Support

Stuck on an integration, need a webhook configured, or found something these docs get wrong?

Contact developer support and a ticket goes straight to our API team. You can also email api@senditbytext.com directly or call (800) 800-4045. Support hours are Monday through Friday, 10:00 AM to 6:00 PM Eastern.

When reporting an issue, include the operation name, the parameters you sent (never your API key), the HTTP status, and the response body. That is usually everything we need to diagnose it on the first pass.