Skip to main content
Server path: /clientary-crm | Type: Application | PCID required: Yes

Tools

ToolDescription
clientary_crm_create_clientCreate a new client
clientary_crm_create_contactCreate a contact for a client
clientary_crm_create_leadCreate a new lead
clientary_crm_create_taskCreate a new task
clientary_crm_delete_clientDelete a client
clientary_crm_delete_contactDelete a contact
clientary_crm_delete_leadDelete a lead
clientary_crm_delete_taskDelete a task
clientary_crm_get_clientGet a single client
clientary_crm_get_contactGet a single contact
clientary_crm_get_leadGet a single lead
clientary_crm_get_staff_memberGet a staff member
clientary_crm_get_taskGet a single task
clientary_crm_list_client_contactsList contacts for a client
clientary_crm_list_clientsList all clients
clientary_crm_list_contactsList all contacts
clientary_crm_list_leadsList all leads
clientary_crm_list_staffList all staff
clientary_crm_list_tasksList all tasks
clientary_crm_update_clientUpdate a client
clientary_crm_update_contactUpdate a contact
clientary_crm_update_leadUpdate a lead
clientary_crm_update_taskUpdate a task

clientary_crm_create_client

Create a new client Parameters:
ParameterTypeRequiredDefaultDescription
clientobjectYesThe client value

clientary_crm_create_contact

Create a contact for a client Parameters:
ParameterTypeRequiredDefaultDescription
client_idintegerYesClient ID
client_userobjectYesClient User

clientary_crm_create_lead

Create a new lead Parameters:
ParameterTypeRequiredDefaultDescription
leadobjectYesThe lead value

clientary_crm_create_task

Create a new task Parameters:
ParameterTypeRequiredDefaultDescription
taskobjectYesThe task value

clientary_crm_delete_client

Delete a client Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesClient ID

clientary_crm_delete_contact

Delete a contact Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesContact ID

clientary_crm_delete_lead

Delete a lead Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesLead ID

clientary_crm_delete_task

Delete a task Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesTask ID

clientary_crm_get_client

Get a single client Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesClient ID

clientary_crm_get_contact

Get a single contact Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesContact ID

clientary_crm_get_lead

Get a single lead Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesLead ID

clientary_crm_get_staff_member

Get a staff member Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesStaff member ID

clientary_crm_get_task

Get a single task Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesTask ID

clientary_crm_list_client_contacts

List contacts for a client Parameters:
ParameterTypeRequiredDefaultDescription
client_idintegerYesClient ID
pageintegerNoPage number

clientary_crm_list_clients

List all clients Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
updated_sincestringNoFilter clients updated since this date (YYYY-MM-DD)
sortstringNoSort order. Use ‘date’ to sort by most recently created first.

clientary_crm_list_contacts

List all contacts Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination

clientary_crm_list_leads

List all leads Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
sortstringNoSort order: ‘name’ for alphabetical, ‘oldest’ for oldest first. Default is newest first.

clientary_crm_list_staff

List all staff

clientary_crm_list_tasks

List all tasks Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number

clientary_crm_update_client

Update a client Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesClient ID
clientobjectNoThe client value

clientary_crm_update_contact

Update a contact Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesContact ID
client_userobjectNoClient User

clientary_crm_update_lead

Update a lead Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesLead ID
leadobjectNoThe lead value

clientary_crm_update_task

Update a task Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesTask ID
taskobjectNoThe task value