API Endpoint Reference

On this page

• How to read this list
• Contacts
• History, events and messages
• Plans, cycles, sources, tags
• Users, accounts and money
• Related pages

1How to read this list

Every request below is called as https://api.clienttether.com/v2/api/<request> with the two access headers described in API Overview. read_ requests are GET; create_ and update_ are POST; delete_ are DELETE. The keys each one accepts are in API Parameters Reference.

Not everything supports the full set of operations. Where a feature has no update_ or no delete_, that operation simply isn’t offered.

2Contacts

Request	What it does
create_client	Create a contact. firstName and lastName required.
read_client_exist	Check whether a contact already exists, typically by phone.
read_client_by_id / read_client_by_external_id	Fetch one contact by ClientTether id or by your own id.
read_client_list / read_contacts	List contacts.
update_client_by_id / update_client_by_external_id	Change a contact.
delete_client_by_id / delete_client_by_external_id	Remove a contact.
read_custom_field_by_contact	Read a contact’s custom-field values.
read_opportunity_list	List opportunities.

3History, events and messages

Request	What it does
create_history_notes / create_client_history_note	Write a note into a contact’s history.
read_client_history_notes	Read a contact’s history.
create_client_event	Create a Call, Contact Reminder or Appointment.
read_all_client_events / read_all_events / read_appts_by_user_id	Read events, for a contact, for the account, or for a user.
update_client_event / delete_client_event	Change or remove an event.
read_available_timeslots	Find bookable slots — the basis of any custom scheduling front end.
create_manual_email / create_manual_text	Send an email or a text to a contact.
create_immed_call	Place a call immediately.
read_pending_actions	What’s queued for a contact.

4Plans, cycles, sources, tags

Request	What it does
create_action_plan, read_action_plan_list, read_action_plan_by_id, update_action_plan_by_id	Manage action plans. A Connection Plan can link to a lead source; a Conversion Plan to a sales cycle.
create_sales_cycle, read_sales_cycle_list, update_sales_cycle_by_id, delete_sales_cycle_by_id	Manage sales-cycle steps.
read_sales_cycle_any_activity	Activity across the cycle.
create_lead_source, read_lead_source_list, update_lead_source_by_id, delete_lead_source_by_id	Manage lead sources.
create_tag, read_tags_list	Manage tags.
read_hosted_pages	List the account’s hosted pages.

5Users, accounts and money

Request	What it does
create_user, read_user_list, read_user_by_id, update_user_by_id, delete_user_by_id	Manage logins.
read_account_list, update_account_by_id, delete_account_by_id	Manage accounts in the tree — including retrieving sub-account web keys.
read_proposals, read_proposal_payments, read_all_payments	Read proposals and the money against them.

6Related pages

• API Overview, API Parameters Reference.
• Integrations Overview.