GET /api/v1/schedule_actions
List schedule actions.

Response Example

{
  "status" : 200,
  "errors" : {},
  "action_dial" : {
    "id" : 3047,
    "name" : "dial",
    "schedule_id" : 354,
    "owner_relation" : "actions",
    "type" : "Schedule::Action",
    "sortable_order" : 1,
    "action_type" : "dial",
    "action_category" : "dial",
    "sms_body" : null,
    "email_title" : null,
    "email_body" : null,
    "email_type" : null,
    "email_from" : null,
    "email_domain" : null,
    "outgoing_webhook" : {
      "id" : 1581,
      "created_at" : "2019-08-09T15:59:12.080-04:00",
      "updated_at" : "2019-08-09T15:59:12.080-04:00",
      "user_updated_at" : null,
      "name" : "Schedule Webhook",
      "trigger_type" : null,
      "trigger_duration" : null,
      "company_id" : 36169,
      "offer_id" : null,
      "schedule_action_id" : null,
      "type" : "Webhook::Outgoing",
      "sortable_order" : -1,
      "token_value_ids" : null,
      "outgoing_url_ids" : [],
      "token_value_map_ids" : []
    },
    "action_wait_type" : null,
    "wait_until_day_of_week" : null,
    "wait_until_hour" : null,
    "wait_until_minute" : null,
    "wait_until_time_zone" : null,
    "wait_seconds" : null,
    "wait_minutes" : null,
    "wait_hours" : null,
    "wait_days" : null,
    "choice_action_type" : null,
    "sub_action" : null,
    "add_to_schedule_id" : null,
    "add_to_schedule_name" : null,
    "mailchimp_list_id" : null,
    "campaign_id" : null,
    "has_queued_leads" : true,
    "queued_leads_count" : 2,
    "token_value_ids" : [],
    "calls_on_hold_limit" : null,
    "when_buyer_would_convert" : false,
    "when_buyer_available" : true,
    "available_cc_percentage" : null,
    "during_daylight_hours" : true,
    "lead_alteration_ids" : [],
    "created_at" : "2019-08-09T15:59:12.022-04:00",
    "updated_at" : "2019-08-09T20:58:05.655-04:00"
  },
  "associations" : {
    "integrations" : []
  },
  "checksum" : "7be0849dd10995e22a7a1a5595cbd188",
  "metadata" : {
    "root" : "action_dial"
  }
}

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

schedule_id
Optional

translation missing: en.api.schedule_actions.schedule_id

owner_relation
Optional

translation missing: en.api.schedule_actions.owner_relations

  • Must be one of: actions, end_of_schedule_actions, webhook_actions, call_disposition_actions.

ids
Optional

Return records matching these ids.

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


GET /api/v1/schedule_actions/new
Build a schedule action with default attributes.

Response Example

{
  "status" : 200,
  "errors" : {},
  "action_dial" : {
    "id" : 3047,
    "name" : "dial",
    "schedule_id" : 354,
    "owner_relation" : "actions",
    "type" : "Schedule::Action",
    "sortable_order" : 1,
    "action_type" : "dial",
    "action_category" : "dial",
    "sms_body" : null,
    "email_title" : null,
    "email_body" : null,
    "email_type" : null,
    "email_from" : null,
    "email_domain" : null,
    "outgoing_webhook" : {
      "id" : 1581,
      "created_at" : "2019-08-09T15:59:12.080-04:00",
      "updated_at" : "2019-08-09T15:59:12.080-04:00",
      "user_updated_at" : null,
      "name" : "Schedule Webhook",
      "trigger_type" : null,
      "trigger_duration" : null,
      "company_id" : 36169,
      "offer_id" : null,
      "schedule_action_id" : null,
      "type" : "Webhook::Outgoing",
      "sortable_order" : -1,
      "token_value_ids" : null,
      "outgoing_url_ids" : [],
      "token_value_map_ids" : []
    },
    "action_wait_type" : null,
    "wait_until_day_of_week" : null,
    "wait_until_hour" : null,
    "wait_until_minute" : null,
    "wait_until_time_zone" : null,
    "wait_seconds" : null,
    "wait_minutes" : null,
    "wait_hours" : null,
    "wait_days" : null,
    "choice_action_type" : null,
    "sub_action" : null,
    "add_to_schedule_id" : null,
    "add_to_schedule_name" : null,
    "mailchimp_list_id" : null,
    "campaign_id" : null,
    "has_queued_leads" : true,
    "queued_leads_count" : 2,
    "token_value_ids" : [],
    "calls_on_hold_limit" : null,
    "when_buyer_would_convert" : false,
    "when_buyer_available" : true,
    "available_cc_percentage" : null,
    "during_daylight_hours" : true,
    "lead_alteration_ids" : [],
    "created_at" : "2019-08-09T15:59:12.022-04:00",
    "updated_at" : "2019-08-09T20:58:05.655-04:00"
  },
  "associations" : {
    "integrations" : []
  },
  "checksum" : "7be0849dd10995e22a7a1a5595cbd188",
  "metadata" : {
    "root" : "action_dial"
  }
}

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String


POST /api/v1/schedule_actions
Create a schedule action.

Response Example

{
  "status" : 200,
  "errors" : {},
  "action_dial" : {
    "id" : 3047,
    "name" : "dial",
    "schedule_id" : 354,
    "owner_relation" : "actions",
    "type" : "Schedule::Action",
    "sortable_order" : 1,
    "action_type" : "dial",
    "action_category" : "dial",
    "sms_body" : null,
    "email_title" : null,
    "email_body" : null,
    "email_type" : null,
    "email_from" : null,
    "email_domain" : null,
    "outgoing_webhook" : {
      "id" : 1581,
      "created_at" : "2019-08-09T15:59:12.080-04:00",
      "updated_at" : "2019-08-09T15:59:12.080-04:00",
      "user_updated_at" : null,
      "name" : "Schedule Webhook",
      "trigger_type" : null,
      "trigger_duration" : null,
      "company_id" : 36169,
      "offer_id" : null,
      "schedule_action_id" : null,
      "type" : "Webhook::Outgoing",
      "sortable_order" : -1,
      "token_value_ids" : null,
      "outgoing_url_ids" : [],
      "token_value_map_ids" : []
    },
    "action_wait_type" : null,
    "wait_until_day_of_week" : null,
    "wait_until_hour" : null,
    "wait_until_minute" : null,
    "wait_until_time_zone" : null,
    "wait_seconds" : null,
    "wait_minutes" : null,
    "wait_hours" : null,
    "wait_days" : null,
    "choice_action_type" : null,
    "sub_action" : null,
    "add_to_schedule_id" : null,
    "add_to_schedule_name" : null,
    "mailchimp_list_id" : null,
    "campaign_id" : null,
    "has_queued_leads" : true,
    "queued_leads_count" : 2,
    "token_value_ids" : [],
    "calls_on_hold_limit" : null,
    "when_buyer_would_convert" : false,
    "when_buyer_available" : true,
    "available_cc_percentage" : null,
    "during_daylight_hours" : true,
    "lead_alteration_ids" : [],
    "created_at" : "2019-08-09T15:59:12.022-04:00",
    "updated_at" : "2019-08-09T20:58:05.655-04:00"
  },
  "associations" : {
    "integrations" : []
  },
  "checksum" : "7be0849dd10995e22a7a1a5595cbd188",
  "metadata" : {
    "root" : "action_dial"
  }
}

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

schedule_id
Optional Blank Value Allowed

translation missing: en.api.schedule_actions.schedule_id

owner_relation
Required

translation missing: en.api.schedule_actions.owner_relation

  • Must be one of: actions, end_of_schedule_actions, webhook_actions, call_disposition_actions.

action_type
Required

translation missing: en.api.schedule_actions.action_type

  • Must be one of: dial, sms, wait, webhook, add_to_schedule, lead_alteration, zoho_crm, lead_block, lead_opt_out, schedule_callback, choice, restart_schedule, mailchimp, sendgrid, mailgun, infusionsoft, ftp_upload.

token_values
Optional Blank Value Allowed

translation missing: en.api.schedule_actions.token_values

  • Must be a valid list of filters. Example filters:
    ["interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"]
token_value_map_group_ids
Optional Blank Value Allowed

translation missing: en.api.schedule_actions.token_value_map_group_ids

sortable_order
Optional Blank Value Allowed

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

  • Must be a decimal number.


GET /api/v1/schedule_actions/:id
Get details about a schedule action.

Response Example

{
  "status" : 200,
  "errors" : {},
  "action_dial" : {
    "id" : 3047,
    "name" : "dial",
    "schedule_id" : 354,
    "owner_relation" : "actions",
    "type" : "Schedule::Action",
    "sortable_order" : 1,
    "action_type" : "dial",
    "action_category" : "dial",
    "sms_body" : null,
    "email_title" : null,
    "email_body" : null,
    "email_type" : null,
    "email_from" : null,
    "email_domain" : null,
    "outgoing_webhook" : {
      "id" : 1581,
      "created_at" : "2019-08-09T15:59:12.080-04:00",
      "updated_at" : "2019-08-09T15:59:12.080-04:00",
      "user_updated_at" : null,
      "name" : "Schedule Webhook",
      "trigger_type" : null,
      "trigger_duration" : null,
      "company_id" : 36169,
      "offer_id" : null,
      "schedule_action_id" : null,
      "type" : "Webhook::Outgoing",
      "sortable_order" : -1,
      "token_value_ids" : null,
      "outgoing_url_ids" : [],
      "token_value_map_ids" : []
    },
    "action_wait_type" : null,
    "wait_until_day_of_week" : null,
    "wait_until_hour" : null,
    "wait_until_minute" : null,
    "wait_until_time_zone" : null,
    "wait_seconds" : null,
    "wait_minutes" : null,
    "wait_hours" : null,
    "wait_days" : null,
    "choice_action_type" : null,
    "sub_action" : null,
    "add_to_schedule_id" : null,
    "add_to_schedule_name" : null,
    "mailchimp_list_id" : null,
    "campaign_id" : null,
    "has_queued_leads" : true,
    "queued_leads_count" : 2,
    "token_value_ids" : [],
    "calls_on_hold_limit" : null,
    "when_buyer_would_convert" : false,
    "when_buyer_available" : true,
    "available_cc_percentage" : null,
    "during_daylight_hours" : true,
    "lead_alteration_ids" : [],
    "created_at" : "2019-08-09T15:59:12.022-04:00",
    "updated_at" : "2019-08-09T20:58:05.655-04:00"
  },
  "associations" : {
    "integrations" : []
  },
  "checksum" : "7be0849dd10995e22a7a1a5595cbd188",
  "metadata" : {
    "root" : "action_dial"
  }
}

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String


PUT /api/v1/schedule_actions/:id
Update a schedule action.

Response Example

{
  "status" : 200,
  "errors" : {},
  "action_dial" : {
    "id" : 3047,
    "name" : "dial",
    "schedule_id" : 354,
    "owner_relation" : "actions",
    "type" : "Schedule::Action",
    "sortable_order" : 1,
    "action_type" : "dial",
    "action_category" : "dial",
    "sms_body" : null,
    "email_title" : null,
    "email_body" : null,
    "email_type" : null,
    "email_from" : null,
    "email_domain" : null,
    "outgoing_webhook" : {
      "id" : 1581,
      "created_at" : "2019-08-09T15:59:12.080-04:00",
      "updated_at" : "2019-08-09T15:59:12.080-04:00",
      "user_updated_at" : null,
      "name" : "Schedule Webhook",
      "trigger_type" : null,
      "trigger_duration" : null,
      "company_id" : 36169,
      "offer_id" : null,
      "schedule_action_id" : null,
      "type" : "Webhook::Outgoing",
      "sortable_order" : -1,
      "token_value_ids" : null,
      "outgoing_url_ids" : [],
      "token_value_map_ids" : []
    },
    "action_wait_type" : null,
    "wait_until_day_of_week" : null,
    "wait_until_hour" : null,
    "wait_until_minute" : null,
    "wait_until_time_zone" : null,
    "wait_seconds" : null,
    "wait_minutes" : null,
    "wait_hours" : null,
    "wait_days" : null,
    "choice_action_type" : null,
    "sub_action" : null,
    "add_to_schedule_id" : null,
    "add_to_schedule_name" : null,
    "mailchimp_list_id" : null,
    "campaign_id" : null,
    "has_queued_leads" : true,
    "queued_leads_count" : 2,
    "token_value_ids" : [],
    "calls_on_hold_limit" : null,
    "when_buyer_would_convert" : false,
    "when_buyer_available" : true,
    "available_cc_percentage" : null,
    "during_daylight_hours" : true,
    "lead_alteration_ids" : [],
    "created_at" : "2019-08-09T15:59:12.022-04:00",
    "updated_at" : "2019-08-09T20:58:05.655-04:00"
  },
  "associations" : {
    "integrations" : []
  },
  "checksum" : "7be0849dd10995e22a7a1a5595cbd188",
  "metadata" : {
    "root" : "action_dial"
  }
}

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

schedule_id
Optional Blank Value Allowed

translation missing: en.api.schedule_actions.schedule_id

token_values
Optional Blank Value Allowed

translation missing: en.api.schedule_actions.token_values

  • Must be a valid list of filters. Example filters:
    ["interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"]
sortable_order
Optional Blank Value Allowed

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

  • Must be a decimal number.


DELETE /api/v1/schedule_actions/:id
Destroy a schedule action.

Response Example

{
  "status" : 200,
  "errors" : {},
  "action_dial" : {
    "id" : 3047,
    "name" : "dial",
    "schedule_id" : 354,
    "owner_relation" : "actions",
    "type" : "Schedule::Action",
    "sortable_order" : 1,
    "action_type" : "dial",
    "action_category" : "dial",
    "sms_body" : null,
    "email_title" : null,
    "email_body" : null,
    "email_type" : null,
    "email_from" : null,
    "email_domain" : null,
    "outgoing_webhook" : {
      "id" : 1581,
      "created_at" : "2019-08-09T15:59:12.080-04:00",
      "updated_at" : "2019-08-09T15:59:12.080-04:00",
      "user_updated_at" : null,
      "name" : "Schedule Webhook",
      "trigger_type" : null,
      "trigger_duration" : null,
      "company_id" : 36169,
      "offer_id" : null,
      "schedule_action_id" : null,
      "type" : "Webhook::Outgoing",
      "sortable_order" : -1,
      "token_value_ids" : null,
      "outgoing_url_ids" : [],
      "token_value_map_ids" : []
    },
    "action_wait_type" : null,
    "wait_until_day_of_week" : null,
    "wait_until_hour" : null,
    "wait_until_minute" : null,
    "wait_until_time_zone" : null,
    "wait_seconds" : null,
    "wait_minutes" : null,
    "wait_hours" : null,
    "wait_days" : null,
    "choice_action_type" : null,
    "sub_action" : null,
    "add_to_schedule_id" : null,
    "add_to_schedule_name" : null,
    "mailchimp_list_id" : null,
    "campaign_id" : null,
    "has_queued_leads" : true,
    "queued_leads_count" : 2,
    "token_value_ids" : [],
    "calls_on_hold_limit" : null,
    "when_buyer_would_convert" : false,
    "when_buyer_available" : true,
    "available_cc_percentage" : null,
    "during_daylight_hours" : true,
    "lead_alteration_ids" : [],
    "created_at" : "2019-08-09T15:59:12.022-04:00",
    "updated_at" : "2019-08-09T20:58:05.655-04:00"
  },
  "associations" : {
    "integrations" : []
  },
  "checksum" : "7be0849dd10995e22a7a1a5595cbd188",
  "metadata" : {
    "root" : "action_dial"
  }
}

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String