Schedules: Actions

Manage the actions of a schedule.

GET /schedule_actions

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

List schedule actions.

Lists the actions configured on schedules, such as dial, SMS, wait, or webhook steps. Filter by schedule_id or owner_relation to scope to a particular action list, such as a schedule's main actions or its End Of Schedule Actions.

Params

Param name Description
schedule_id
Optional

The schedule this action belongs to.
owner_relation
Optional

Filter for actions belonging to this action list, such as the schedule’s main actions or its End Of Schedule Actions.

  • Must be one of: actions, end_of_schedule_actions, webhook_actions, call_disposition_actions, call_control_actions, key_press_flows, lead_retarget_actions, schedule_actions.
ids
Optional

Return records matching these ids.

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

GET /schedule_actions/new

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

Build a schedule action with default attributes.

Builds a schedule action with default attributes without saving it, for previewing what a new action of a given type would look like.

POST /schedule_actions

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

Create a schedule action.

Adds a new action to a schedule's action list. Requires action_type and owner_relation.

Params

Param name Description
schedule_id
Optional Blank value allowed

The schedule this action belongs to.
owner_relation
Required

Which action list this action belongs to, such as the schedule’s main actions or its End Of Schedule Actions.

  • Must be one of: actions, end_of_schedule_actions, webhook_actions, call_disposition_actions, call_control_actions, key_press_flows, lead_retarget_actions, schedule_actions.
action_type
Required

The type of action to perform, such as dial, sms, wait, or webhook.

  • 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, aws_s3.
record_token_filter_list
Optional Blank value allowed

Assign filters to the object by passing an array of key:value pairs

  • Must be a valid list of filters. Example filters:
    "interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"
record_token_additional_list
Optional Blank value allowed

Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.

  • Must be a valid list of filters. Example filters:
    "interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"
token_value_ids
Optional Blank value allowed

Only run this action for leads or calls matching these tokens.
attribution_token_value_ids
Optional Blank value allowed

Apply these additional tokens to the lead or call when this action runs.
token_value_map_group_ids
Optional Blank value allowed

Apply these Custom Field Mapping groups to this action.
name
Optional Blank value allowed

The name of this action, shown in the schedule builder.
description
Optional Blank value allowed

A human readable description of this action.

  • Must be a String
schedule_action_group_id
Optional Blank value allowed

Assign this action to an Action Group so it can also run from an agent status change or a matched transcription.
lead_wait_rule_group_id
Optional Blank value allowed

The Lead Wait Rule Group whose rules determine how long to wait, used when action_wait_type is lead_wait_rule_group.
provider_configuration_id
Optional Blank value allowed

The provider configuration used to place this action’s calls, SMS, or other outbound communication.
sub_action
Optional Blank value allowed

A sub action recognized by the action’s integration, such as send_email or add_to_campaign.

  • Must be a String
add_one_to_lead_priority
Optional Blank value allowed

When enabled, increases the lead’s dial priority each time this action runs.

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

Switch how the lead is dialed by an Instant Agent. Accepts dial_with_instant_agent or dial_with_ivr.

  • Must be a String
change_contact_caller_permission_required
Optional Blank value allowed

Change whether an agent’s permission is required before connecting this lead’s caller. Accepts apply_required or remove_required.

  • Must be a String
action_wait_type
Optional Blank value allowed

How long to wait before continuing. Accepts seconds, minutes, hours, days, time_of_day, or lead_wait_rule_group.

  • Must be a String
wait_seconds
Optional Blank value allowed

The number of seconds to wait, used when action_wait_type is seconds.

  • Must be a decimal number.
wait_minutes
Optional Blank value allowed

The number of minutes to wait, used when action_wait_type is minutes.

  • Must be a decimal number.
wait_hours
Optional Blank value allowed

The number of hours to wait, used when action_wait_type is hours.

  • Must be a decimal number.
wait_days
Optional Blank value allowed

The number of days to wait, used when action_wait_type is days.

  • Must be a decimal number.
wait_until_day_of_week
Optional Blank value allowed

The day to wait until, used when action_wait_type is time_of_day. Accepts today, tomorrow, next_week, next_month, or a day number (0 for Sunday through 6 for Saturday).

  • Must be a String
wait_until_hour
Optional Blank value allowed

The hour of the day to wait until (0-23), used when action_wait_type is time_of_day.

  • Must be a decimal number.
wait_until_minute
Optional Blank value allowed

The minute of the hour to wait until (0-59), used when action_wait_type is time_of_day.

  • Must be a decimal number.
during_daylight_hours
Optional Blank value allowed

When enabled, this action only proceeds during the schedule’s daylight hours; otherwise it waits until daylight hours resume.

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

When enabled, this action waits until a buyer is available before proceeding.

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

When enabled, this action waits until the lead would convert with an available buyer.

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

What this action does when it runs. Accepts none or exit_schedule.

  • Must be a String
sms_body
Optional Blank value allowed

The text message to send. Token replacement is supported.

  • Must be a String
custom_email
Optional Blank value allowed

Send to this email address instead of the lead’s email. Token replacement is supported.

  • Must be a String
email_from
Optional Blank value allowed

The from email address.

  • Must be a String
email_from_name
Optional Blank value allowed

The from name displayed on the email.

  • Must be a String
email_to_name
Optional Blank value allowed

The name displayed for the recipient.

  • Must be a String
email_title
Optional Blank value allowed

The email subject line. Token replacement is supported.

  • Must be a String
email_body
Optional Blank value allowed

The email body content. Token replacement is supported.

  • Must be a String
email_domain
Optional Blank value allowed

The sending domain used for this email.

  • Must be a String
email_type
Optional Blank value allowed

The format of the outgoing email, such as html or text.

  • Must be a String
mailchimp_list_id
Optional Blank value allowed

The Mailchimp list id leads are added to.

  • Must be a String
campaign_id
Optional Blank value allowed

The campaign id in the connected integration that this action applies to.

  • Must be a String
use_custom_caller_id
Optional Blank value allowed

When enabled, uses custom_caller_id instead of the lead’s number as the caller id for this action.

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

The caller id to use when use_custom_caller_id is enabled. Token replacement is supported.

  • Must be a String
use_custom_caller_number
Optional Blank value allowed

When enabled, uses custom_caller_number_id instead of the schedule’s number to dial the lead.

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

The number to dial from when use_custom_caller_number is enabled.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
lead_cycle_dial_number
Optional Blank value allowed

When enabled, clears the lead’s assigned dial number so a new one is chosen the next time it’s dialed.

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

When enabled, clears the lead’s assigned SMS number so a new one is chosen the next time it sends SMS.

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

Only run this action for calls with this disposition.
parent_outgoing_webhook_id
Optional Blank value allowed

The outgoing webhook this action was generated from, when it fires alongside a webhook.
add_to_schedule_id
Optional Blank value allowed

The schedule to add or move the lead to.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
reassign_to_schedule
Optional Blank value allowed

When enabled, moves the lead to the target schedule instead of adding it as a new lead there.

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

When enabled, skips contact field validation when adding the lead to the target schedule.

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

When enabled, unblocks the caller’s number if it was previously blocked.

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

When enabled, only updates a matching existing lead on the target schedule instead of creating a new one.

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

When enabled, expires any existing matching leads on the target schedule before adding this one.

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

When enabled, deletes any existing matching leads on the target schedule before adding this one.

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

When enabled, restarts the schedule for the lead this action adds or updates.

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

When enabled, assigns a dialing number to the lead this action adds or updates.

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

When enabled, assigns an SMS number to the lead this action adds or updates.

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

When enabled, applies this lead’s updated data to every other lead with a matching phone number.

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

The number of hours before a lead added by this action expires.

  • Must be a decimal number.
lead_max_contact_attempts
Optional Blank value allowed

The maximum number of contact attempts allowed for a lead added by this action.

  • Must be a decimal number.
lead_block_type
Optional Blank value allowed

Whether to block the caller on this schedule’s suppression list only, or across the entire company. Accepts schedule, or leave blank for the whole company.

  • Must be a String
auth_public_key
Optional Blank value allowed

The AWS access key id used to authenticate to the S3 bucket for this upload.

  • Must be a String
auth_secret_key
Optional Blank value allowed

The AWS secret access key used to authenticate to the S3 bucket for this upload.

  • Must be a String
aws_region
Optional Blank value allowed

The AWS region of the S3 bucket, e.g. us-east-1.

  • Must be a String
ftp_hostname
Optional Blank value allowed

The FTP or S3 hostname, or S3 bucket name, to upload to.

  • Must be a String
ftp_username
Optional Blank value allowed

The username used to authenticate to the FTP server.

  • Must be a String
ftp_password
Optional Blank value allowed

The password used to authenticate to the FTP server.

  • Must be a String
ftp_directory_path
Optional Blank value allowed

The directory path the file is uploaded to.

  • Must be a String
ftp_file_name
Optional Blank value allowed

The file name used for the uploaded file.

  • Must be a String
ftp_generate_directory
Optional Blank value allowed

When enabled, generates the destination directory if it doesn’t already exist.

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

When enabled, downloads and uploads the file at ftp_remote_file_url instead of ftp_contents_to_upload.

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

The URL of a file to download and upload, used when ftp_upload_remote_file is enabled. Token replacement is supported.

  • Must be a String
ftp_contents_to_upload
Optional Blank value allowed

The text content to upload as a file, used when ftp_upload_remote_file is disabled. Token replacement is supported.

  • Must be a String
use_sftp
Optional Blank value allowed

When enabled, uploads over SFTP instead of FTP.

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

Run this Call Action when the action fires.
key_press_flow_id
Optional Blank value allowed

The Key Press Flow this action uses.
lead_retarget_id
Optional Blank value allowed

The Lead Retarget rule this action applies.
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 /schedule_actions/:id

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

Get details about a schedule action.

Gets a schedule action's details by id, including the integrations available to it.

PUT /schedule_actions/:id

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

Update a schedule action.

Updates an existing schedule action, such as its schedule assignment, token filters, custom field mapping groups, or sort order.

Params

Param name Description
schedule_id
Optional Blank value allowed

The schedule this action belongs to.
owner_relation
Optional Blank value allowed

Which action list this action belongs to, such as the schedule’s main actions or its End Of Schedule Actions.

  • Must be one of: actions, end_of_schedule_actions, webhook_actions, call_disposition_actions, call_control_actions, key_press_flows, lead_retarget_actions, schedule_actions.
action_type
Optional Blank value allowed

The type of action to perform, such as dial, sms, wait, or webhook.

  • Must be a String
record_token_filter_list
Optional Blank value allowed

Assign filters to the object by passing an array of key:value pairs

  • Must be a valid list of filters. Example filters:
    "interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"
record_token_additional_list
Optional Blank value allowed

Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.

  • Must be a valid list of filters. Example filters:
    "interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"
token_value_ids
Optional Blank value allowed

Only run this action for leads or calls matching these tokens.
attribution_token_value_ids
Optional Blank value allowed

Apply these additional tokens to the lead or call when this action runs.
token_value_map_group_ids
Optional Blank value allowed

Apply these Custom Field Mapping groups to this action.
name
Optional Blank value allowed

The name of this action, shown in the schedule builder.
description
Optional Blank value allowed

A human readable description of this action.

  • Must be a String
schedule_action_group_id
Optional Blank value allowed

Assign this action to an Action Group so it can also run from an agent status change or a matched transcription.
lead_wait_rule_group_id
Optional Blank value allowed

The Lead Wait Rule Group whose rules determine how long to wait, used when action_wait_type is lead_wait_rule_group.
provider_configuration_id
Optional Blank value allowed

The provider configuration used to place this action’s calls, SMS, or other outbound communication.
sub_action
Optional Blank value allowed

A sub action recognized by the action’s integration, such as send_email or add_to_campaign.

  • Must be a String
add_one_to_lead_priority
Optional Blank value allowed

When enabled, increases the lead’s dial priority each time this action runs.

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

Switch how the lead is dialed by an Instant Agent. Accepts dial_with_instant_agent or dial_with_ivr.

  • Must be a String
change_contact_caller_permission_required
Optional Blank value allowed

Change whether an agent’s permission is required before connecting this lead’s caller. Accepts apply_required or remove_required.

  • Must be a String
action_wait_type
Optional Blank value allowed

How long to wait before continuing. Accepts seconds, minutes, hours, days, time_of_day, or lead_wait_rule_group.

  • Must be a String
wait_seconds
Optional Blank value allowed

The number of seconds to wait, used when action_wait_type is seconds.

  • Must be a decimal number.
wait_minutes
Optional Blank value allowed

The number of minutes to wait, used when action_wait_type is minutes.

  • Must be a decimal number.
wait_hours
Optional Blank value allowed

The number of hours to wait, used when action_wait_type is hours.

  • Must be a decimal number.
wait_days
Optional Blank value allowed

The number of days to wait, used when action_wait_type is days.

  • Must be a decimal number.
wait_until_day_of_week
Optional Blank value allowed

The day to wait until, used when action_wait_type is time_of_day. Accepts today, tomorrow, next_week, next_month, or a day number (0 for Sunday through 6 for Saturday).

  • Must be a String
wait_until_hour
Optional Blank value allowed

The hour of the day to wait until (0-23), used when action_wait_type is time_of_day.

  • Must be a decimal number.
wait_until_minute
Optional Blank value allowed

The minute of the hour to wait until (0-59), used when action_wait_type is time_of_day.

  • Must be a decimal number.
during_daylight_hours
Optional Blank value allowed

When enabled, this action only proceeds during the schedule’s daylight hours; otherwise it waits until daylight hours resume.

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

When enabled, this action waits until a buyer is available before proceeding.

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

When enabled, this action waits until the lead would convert with an available buyer.

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

What this action does when it runs. Accepts none or exit_schedule.

  • Must be a String
sms_body
Optional Blank value allowed

The text message to send. Token replacement is supported.

  • Must be a String
custom_email
Optional Blank value allowed

Send to this email address instead of the lead’s email. Token replacement is supported.

  • Must be a String
email_from
Optional Blank value allowed

The from email address.

  • Must be a String
email_from_name
Optional Blank value allowed

The from name displayed on the email.

  • Must be a String
email_to_name
Optional Blank value allowed

The name displayed for the recipient.

  • Must be a String
email_title
Optional Blank value allowed

The email subject line. Token replacement is supported.

  • Must be a String
email_body
Optional Blank value allowed

The email body content. Token replacement is supported.

  • Must be a String
email_domain
Optional Blank value allowed

The sending domain used for this email.

  • Must be a String
email_type
Optional Blank value allowed

The format of the outgoing email, such as html or text.

  • Must be a String
mailchimp_list_id
Optional Blank value allowed

The Mailchimp list id leads are added to.

  • Must be a String
campaign_id
Optional Blank value allowed

The campaign id in the connected integration that this action applies to.

  • Must be a String
use_custom_caller_id
Optional Blank value allowed

When enabled, uses custom_caller_id instead of the lead’s number as the caller id for this action.

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

The caller id to use when use_custom_caller_id is enabled. Token replacement is supported.

  • Must be a String
use_custom_caller_number
Optional Blank value allowed

When enabled, uses custom_caller_number_id instead of the schedule’s number to dial the lead.

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

The number to dial from when use_custom_caller_number is enabled.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
lead_cycle_dial_number
Optional Blank value allowed

When enabled, clears the lead’s assigned dial number so a new one is chosen the next time it’s dialed.

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

When enabled, clears the lead’s assigned SMS number so a new one is chosen the next time it sends SMS.

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

Only run this action for calls with this disposition.
parent_outgoing_webhook_id
Optional Blank value allowed

The outgoing webhook this action was generated from, when it fires alongside a webhook.
add_to_schedule_id
Optional Blank value allowed

The schedule to add or move the lead to.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
reassign_to_schedule
Optional Blank value allowed

When enabled, moves the lead to the target schedule instead of adding it as a new lead there.

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

When enabled, skips contact field validation when adding the lead to the target schedule.

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

When enabled, unblocks the caller’s number if it was previously blocked.

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

When enabled, only updates a matching existing lead on the target schedule instead of creating a new one.

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

When enabled, expires any existing matching leads on the target schedule before adding this one.

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

When enabled, deletes any existing matching leads on the target schedule before adding this one.

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

When enabled, restarts the schedule for the lead this action adds or updates.

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

When enabled, assigns a dialing number to the lead this action adds or updates.

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

When enabled, assigns an SMS number to the lead this action adds or updates.

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

When enabled, applies this lead’s updated data to every other lead with a matching phone number.

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

The number of hours before a lead added by this action expires.

  • Must be a decimal number.
lead_max_contact_attempts
Optional Blank value allowed

The maximum number of contact attempts allowed for a lead added by this action.

  • Must be a decimal number.
lead_block_type
Optional Blank value allowed

Whether to block the caller on this schedule’s suppression list only, or across the entire company. Accepts schedule, or leave blank for the whole company.

  • Must be a String
auth_public_key
Optional Blank value allowed

The AWS access key id used to authenticate to the S3 bucket for this upload.

  • Must be a String
auth_secret_key
Optional Blank value allowed

The AWS secret access key used to authenticate to the S3 bucket for this upload.

  • Must be a String
aws_region
Optional Blank value allowed

The AWS region of the S3 bucket, e.g. us-east-1.

  • Must be a String
ftp_hostname
Optional Blank value allowed

The FTP or S3 hostname, or S3 bucket name, to upload to.

  • Must be a String
ftp_username
Optional Blank value allowed

The username used to authenticate to the FTP server.

  • Must be a String
ftp_password
Optional Blank value allowed

The password used to authenticate to the FTP server.

  • Must be a String
ftp_directory_path
Optional Blank value allowed

The directory path the file is uploaded to.

  • Must be a String
ftp_file_name
Optional Blank value allowed

The file name used for the uploaded file.

  • Must be a String
ftp_generate_directory
Optional Blank value allowed

When enabled, generates the destination directory if it doesn’t already exist.

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

When enabled, downloads and uploads the file at ftp_remote_file_url instead of ftp_contents_to_upload.

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

The URL of a file to download and upload, used when ftp_upload_remote_file is enabled. Token replacement is supported.

  • Must be a String
ftp_contents_to_upload
Optional Blank value allowed

The text content to upload as a file, used when ftp_upload_remote_file is disabled. Token replacement is supported.

  • Must be a String
use_sftp
Optional Blank value allowed

When enabled, uploads over SFTP instead of FTP.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
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 /schedule_actions/:id

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

Destroy a schedule action.

Removes a schedule action by id.