For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
This can be used to modify a draft or send it once the draft is complete.
To send an SMS immediately, you can update its status to outbox. To send it at a later time, change the status to scheduled and provide the desired date & time in the date_scheduled field.
Authentication
AuthorizationBasic
Use your API key as the username and leave the password empty.
OR
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
idstringRequired
Request
This endpoint expects an object.
activity_atdatetime or nullOptional
attachmentslist of objects or nullOptional
caller_id_modeenumOptional
Allowed values:
contact_idstring or nullOptional
lead_idstring or nullOptional
local_phonestring or nullOptional
Phone number in E.164 format
remote_phonestring or nullOptional
Phone number in E.164 format
statusenumOptional
template_idstring or nullOptional
textstring or nullOptional
user_idstring or nullOptional
Response
Successful response
_typestring
activity_atdatetime or null
caller_id_modeenum or null
How a caller's outbound number is chosen. Fixed uses a single configured number; Auto lets Close select the best number per call/SMS (Managed by Close Caller ID).
Allowed values:
caller_id_reasonenum or null
Why a number was chosen in Auto mode: reused from a prior communication (context), picked for geographic proximity (local_presence), or the default/oldest fallback.
Allowed values:
contact_idstring or null
coststring or null
created_bystring or null
date_createddatetime
date_scheduleddatetime or null
date_sentdatetime or null
date_updateddatetime
directionenum
Direction of a phone activity, such as a call or an SMS message.
Allowed values:
error_messagestring or null
idstring
lead_idstring or null
local_country_isostring or null
local_phonestring or null
local_phone_formattedstring or null
organization_idstring
remote_country_isostring or null
remote_phonestring or null
remote_phone_formattedstring or null
sourceenum
Source of a phone activity. Describes whether the phone activity (such as a call or an SMS) was handled by Close's telephony provider or handled externally by a 3rd party and is merely logged in Close.
