Parameters are key:value pairs — in the query string for a GET, in the body for a POST. Which ones a request requires is listed with the request in API Endpoint Reference; what follows is what the keys mean and what they’ll accept.
2Contact parameters
Key
Meaning and limits
client_id
ClientTether’s id for the contact. Required by some calls.
firstName, lastName
Required for create_client. String.
phone, second_phone
Ten digits, no formatting. phone is treated as the mobile.
smsok
1 if it’s okay to text, 0 if not. Defaults to 1 when omitted.
email
Well-formed, and unique per contact.
address, city
String.
state
US state or Canadian province, 2-letter abbreviation only.
zip
US and Canadian formats: 5, 5-4, 5-4-2 digits, or A1A 1A1 with a space after the third character.
compName, job_title
String.
tag
Comma-separated list. Tags that don’t exist are created.
external_id
Your system’s id for the contact, for integration. Integer.
third_party_name + third_party_id
An alternative to external_id when several systems integrate.
deal_size, deal_closed
Whole number; and the closed flag.
3Action plan parameters
Key
Meaning
action_plan_type
Connection, Conversion or Retention.
action_plan_link_id
What the plan is linked to: for a Connection Plan, a lead source (so a new lead with that source starts this plan — a source should be linked to only one plan); for a Conversion Plan, a sales cycle (so starting the plan also moves the contact to that step).
action_plan_link_name
The link’s name. Read only.
action_plan_next_plan_id / _name
The plan that follows this one.
4History note parameters
Key
Meaning
type
sms_in, sms_out, email_in, email_out or note. Anything else is stored as a note.
utc_datetime
yyyy-mm-ddT00:00:00Z — UTC.
subject, body_content
Text.
user_name
Must match a user’s first and last name as set in Users. Up to 120 characters.
