Zoho Action

An automated action that syncs lead or call data to Zoho CRM, such as creating or updating a record.

GET /zoho_crm_commands

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/zoho_crm_commands

List Zoho Action records.

Returns the Zoho Actions on the account, each one defining what happens in Zoho CRM when its parent schedule action fires, such as creating or updating a Contact, Note, or Call, or converting a Lead. Supports the standard pagination and filtering parameters plus filtering by a list of ids.

Params

Param name Description
ids
Optional

Return records matching these ids.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]

page
Optional

Return the next page of results.

  • Must be a number.

per_page
Optional

How many results to return per page. The default is 25.

  • Must be a number.

created_at_to
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be a String

created_at_from
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be a String

fulltext
Optional

Search for any record that matches this text

  • Must be a String

time_zone
Optional

Date ranges will be parsed using this time zone.

columns
Optional
Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at

Must be any combination of:

  • id
  • legacy_id
  • type
  • uuid
  • created_at
  • updated_at
  • deleted_at
  • user_updated_at
  • routes_show_path
  • routes_edit_path
  • external_record_id
  • company_id
  • user_id
  • schedule_action_id
  • sortable_order
  • action_type
  • module_type
  • module_primary_key
  • token_value_map_group_ids
  • webhook_params_count
  • response_parsers_count
  • zoho_parent_type
  • Must be a String

root
Optional

Pass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /zoho_crm_commands/new

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/zoho_crm_commands/new

Build Zoho Action with defaults.

Returns a Zoho Action built with default attributes for previewing available fields before creating one. It is not saved, and no request is sent to Zoho.

Params

Param name Description
schedule_action_id
Optional Blank value allowed

Schedule Action

action_type
Optional Blank value allowed

Action Type

  • Must be a String

module_type
Optional Blank value allowed

Module Type

  • Must be a String

module_primary_key
Optional Blank value allowed

Module Primary Key

  • Must be a String

zoho_parent_type
Optional Blank value allowed

The Zoho CRM module (for example Leads or Contacts) a Notes action attaches its note to.

  • Must be a String

token_value_map_group_ids
Optional Blank value allowed

Map lead and call data to custom values by assigning these Token Value Map Groups to this action.

POST /zoho_crm_commands

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/zoho_crm_commands

Create Zoho Action.

Creates a Zoho Action tied to a schedule action, an action_type (create_module_entry, convert_lead, create_update_module_entry, or update_module_entry), and a Zoho module_type. On creation the integration calls out to Zoho live to fetch that modules field list and auto-generate its field mappings, so the parent schedule action must already have a working Zoho connection.

Params

Param name Description
schedule_action_id
Optional Blank value allowed

Schedule Action

action_type
Optional Blank value allowed

Action Type

  • Must be a String

module_type
Optional Blank value allowed

Module Type

  • Must be a String

module_primary_key
Optional Blank value allowed

Module Primary Key

  • Must be a String

zoho_parent_type
Optional Blank value allowed

The Zoho CRM module (for example Leads or Contacts) a Notes action attaches its note to.

  • Must be a String

token_value_map_group_ids
Optional Blank value allowed

Map lead and call data to custom values by assigning these Token Value Map Groups to this action.

GET /zoho_crm_commands/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/zoho_crm_commands/:id

Get Zoho Action by id.

Returns a single Zoho Action by id, scoped to the current company.

PUT /zoho_crm_commands/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/zoho_crm_commands/:id

Update Zoho Action by id.

Updates a Zoho Actions action type, module type, module primary key, or linked schedule action by id. Unlike create, updating does not call out to Zoho again, so changing module_type on an existing record will not regenerate its field mappings.

Params

Param name Description
schedule_action_id
Optional Blank value allowed

Schedule Action

action_type
Optional Blank value allowed

Action Type

  • Must be a String

module_type
Optional Blank value allowed

Module Type

  • Must be a String

module_primary_key
Optional Blank value allowed

Module Primary Key

  • Must be a String

zoho_parent_type
Optional Blank value allowed

The Zoho CRM module (for example Leads or Contacts) a Notes action attaches its note to.

  • Must be a String

token_value_map_group_ids
Optional Blank value allowed

Map lead and call data to custom values by assigning these Token Value Map Groups to this action.

DELETE /zoho_crm_commands/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/zoho_crm_commands/:id

Destroy Zoho Action by id.

Soft deletes a Zoho Action by id, excluding it from future lookups and from firing on its schedule action without permanently removing the record. The webhook parameter mappings and response parsers configured on it are not deleted along with it.