Response Example

{
  "status" : 200,
  "schedule_actions" : [
    {
      "id" : 667,
      "name" : "wait",
      "schedule_id" : 1,
      "owner_relation" : "actions",
      "type" : "Schedule::Action",
      "sortable_order" : 0,
      "action_type" : "wait",
      "action_category" : "wait",
      "sms_body" : null,
      "email_title" : null,
      "email_body" : null,
      "email_type" : null,
      "email_from" : null,
      "email_domain" : null,
      "outgoing_webhook" : {
        "id" : null,
        "created_at" : null,
        "updated_at" : null,
        "user_updated_at" : null,
        "name" : "Schedule Webhook",
        "trigger_type" : null,
        "trigger_duration" : null,
        "company_id" : null,
        "offer_id" : null,
        "schedule_action_id" : null,
        "type" : "Webhook::Outgoing",
        "sortable_order" : null,
        "token_value_ids" : null,
        "outgoing_url_ids" : [],
        "token_value_map_ids" : []
      },
      "action_wait_type" : "seconds",
      "wait_until_day_of_week" : "tomorrow",
      "wait_until_hour" : "0",
      "wait_until_minute" : "0",
      "wait_until_time_zone" : null,
      "wait_seconds" : 15,
      "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" : 1,
      "token_value_ids" : [],
      "calls_on_hold_limit" : null,
      "when_buyer_would_convert" : false,
      "when_buyer_available" : false,
      "available_cc_percentage" : null,
      "during_daylight_hours" : true,
      "lead_alteration_ids" : [],
      "created_at" : "2018-11-11T13:40:16.990-05:00",
      "updated_at" : "2019-08-29T15:57:49.867-04:00"
    },
    {
      "id" : 65,
      "name" : "sms",
      "schedule_id" : 1,
      "owner_relation" : "actions",
      "type" : "Schedule::Action",
      "sortable_order" : 1,
      "action_type" : "sms",
      "action_category" : "sms",
      "sms_body" : "Thanks for your submission! A representative will be calling in 60 seconds.",
      "email_title" : "",
      "email_body" : "",
      "email_type" : null,
      "email_from" : null,
      "email_domain" : null,
      "outgoing_webhook" : {
        "id" : 451,
        "created_at" : "2017-09-05T00:09:15.455-04:00",
        "updated_at" : "2017-09-05T00:09:15.455-04:00",
        "user_updated_at" : null,
        "name" : "Unnamed Webhook 451",
        "trigger_type" : "every_call",
        "trigger_duration" : null,
        "company_id" : 321,
        "offer_id" : null,
        "schedule_action_id" : 65,
        "type" : "Webhook::Outgoing",
        "sortable_order" : -1,
        "token_value_ids" : null,
        "outgoing_url_ids" : [],
        "token_value_map_ids" : []
      },
      "action_wait_type" : "seconds",
      "wait_until_day_of_week" : "0",
      "wait_until_hour" : "0",
      "wait_until_minute" : "0",
      "wait_until_time_zone" : "Pacific Time (US & Canada)",
      "wait_seconds" : null,
      "wait_minutes" : null,
      "wait_hours" : null,
      "wait_days" : null,
      "choice_action_type" : "none",
      "sub_action" : null,
      "add_to_schedule_id" : null,
      "add_to_schedule_name" : null,
      "mailchimp_list_id" : null,
      "campaign_id" : null,
      "has_queued_leads" : false,
      "queued_leads_count" : 0,
      "token_value_ids" : [],
      "calls_on_hold_limit" : null,
      "when_buyer_would_convert" : false,
      "when_buyer_available" : false,
      "available_cc_percentage" : null,
      "during_daylight_hours" : true,
      "lead_alteration_ids" : [],
      "created_at" : "2017-09-05T00:09:15.451-04:00",
      "updated_at" : "2019-08-29T15:58:31.746-04:00"
    },
    {
      "id" : 64,
      "name" : "wait",
      "schedule_id" : 1,
      "owner_relation" : "actions",
      "type" : "Schedule::Action",
      "sortable_order" : 2,
      "action_type" : "wait",
      "action_category" : "wait",
      "sms_body" : "",
      "email_title" : "",
      "email_body" : "",
      "email_type" : null,
      "email_from" : null,
      "email_domain" : null,
      "outgoing_webhook" : {
        "id" : 450,
        "created_at" : "2017-09-05T00:09:15.448-04:00",
        "updated_at" : "2017-09-05T00:09:15.448-04:00",
        "user_updated_at" : null,
        "name" : "Unnamed Webhook 450",
        "trigger_type" : "every_call",
        "trigger_duration" : null,
        "company_id" : 321,
        "offer_id" : null,
        "schedule_action_id" : 64,
        "type" : "Webhook::Outgoing",
        "sortable_order" : -1,
        "token_value_ids" : null,
        "outgoing_url_ids" : [],
        "token_value_map_ids" : []
      },
      "action_wait_type" : "seconds",
      "wait_until_day_of_week" : "0",
      "wait_until_hour" : "0",
      "wait_until_minute" : "0",
      "wait_until_time_zone" : "Pacific Time (US & Canada)",
      "wait_seconds" : 120,
      "wait_minutes" : null,
      "wait_hours" : null,
      "wait_days" : null,
      "choice_action_type" : "none",
      "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" : 1,
      "token_value_ids" : [],
      "calls_on_hold_limit" : null,
      "when_buyer_would_convert" : false,
      "when_buyer_available" : false,
      "available_cc_percentage" : null,
      "during_daylight_hours" : true,
      "lead_alteration_ids" : [],
      "created_at" : "2017-09-05T00:09:15.444-04:00",
      "updated_at" : "2019-08-29T15:58:32.136-04:00"
    },
    {
      "id" : 63,
      "name" : "dial",
      "schedule_id" : 1,
      "owner_relation" : "actions",
      "type" : "Schedule::Action",
      "sortable_order" : 3,
      "action_type" : "dial",
      "action_category" : "dial",
      "sms_body" : "",
      "email_title" : "",
      "email_body" : "",
      "email_type" : null,
      "email_from" : null,
      "email_domain" : null,
      "outgoing_webhook" : {
        "id" : 449,
        "created_at" : "2017-09-05T00:09:15.440-04:00",
        "updated_at" : "2017-09-05T00:09:15.440-04:00",
        "user_updated_at" : null,
        "name" : "Unnamed Webhook 449",
        "trigger_type" : "every_call",
        "trigger_duration" : null,
        "company_id" : 321,
        "offer_id" : null,
        "schedule_action_id" : 63,
        "type" : "Webhook::Outgoing",
        "sortable_order" : -1,
        "token_value_ids" : null,
        "outgoing_url_ids" : [],
        "token_value_map_ids" : []
      },
      "action_wait_type" : "seconds",
      "wait_until_day_of_week" : "0",
      "wait_until_hour" : "0",
      "wait_until_minute" : "0",
      "wait_until_time_zone" : "Pacific Time (US & Canada)",
      "wait_seconds" : null,
      "wait_minutes" : null,
      "wait_hours" : null,
      "wait_days" : null,
      "choice_action_type" : "none",
      "sub_action" : null,
      "add_to_schedule_id" : null,
      "add_to_schedule_name" : null,
      "mailchimp_list_id" : null,
      "campaign_id" : null,
      "has_queued_leads" : false,
      "queued_leads_count" : 0,
      "token_value_ids" : [],
      "calls_on_hold_limit" : null,
      "when_buyer_would_convert" : false,
      "when_buyer_available" : false,
      "available_cc_percentage" : null,
      "during_daylight_hours" : true,
      "lead_alteration_ids" : [],
      "created_at" : "2017-09-05T00:09:15.437-04:00",
      "updated_at" : "2019-08-29T16:00:45.433-04:00"
    }
  ],
  "checksum" : "c901c3897fcd8beb78cc17dbcb789347",
  "metadata" : {
    "root" : "schedule_actions",
    "page" : 1,
    "total_pages" : 0,
    "per_page" : 0,
    "total_count" : 0,
    "next_cursor" : 63
  }
}

Params

Param name
Description
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, call_control_actions, key_press_flows, lead_retarget_actions, schedule_action_group_actions.

ids
Optional

Return records matching these ids.

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