API documentation

GET /api/v1/schedule_triggers
Search for Schedule Triggers

Params

Param name	Description Validations
schedule_id Optional	Schedule internal id Validations: Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
ids Optional	Return records matching these ids. Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`

GET /api/v1/schedule_triggers/new
Returns a new Schedule Trigger

Params

Param name	Description Validations
schedule_id Required	Schedule internal id Validations: Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules

POST /api/v1/schedule_triggers
Create a Schedule Trigger

Params

Param name	Description Validations
schedule_id Required	Schedule internal id Validations: Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
name Required	The trigger name Validations: Must be a String
trigger_type Required	The schedule ends when the lead has taken this action. Validations: Must be one of: `none`, `tokens_match`, `expired`, `buyer_connected`, `buyer_converted`, `dial`.
expire_minutes Optional	The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first. Validations: Must be a decimal number.
expire_timestamp_name Optional Blank Value Allowed	Translation missing: en.api.schedule_triggers.expire_timestamp_name Validations: Must be one of: `created_at`, `first_queued_at`, `first_action_at`.
record_token_filter_list Optional Blank Value Allowed	Assign filters to the object by passing an array of key:value pairs Validations: 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. Validations: Must be a valid list of tokens. Example tokens: `buyer_interest:loan,another_token:value`
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. Validations: Must be a decimal number.

GET /api/v1/schedule_triggers/:id
Returns a Schedule Trigger by ID

PUT /api/v1/schedule_triggers/:id
Updates a Schedule Trigger by ID

Params

Param name	Description Validations
schedule_id Optional Blank Value Allowed	Schedule internal id Validations: Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
name Optional	The trigger name Validations: Must be a String
trigger_type Optional	The schedule ends when the lead has taken this action. Validations: Must be one of: `none`, `tokens_match`, `expired`, `buyer_connected`, `buyer_converted`, `dial`.
expire_minutes Optional	The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first. Validations: Must be a decimal number.
record_token_filter_list Optional Blank Value Allowed	Assign filters to the object by passing an array of key:value pairs Validations: 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. Validations: Must be a valid list of tokens. Example tokens: `buyer_interest:loan,another_token:value`
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. Validations: Must be a decimal number.

DELETE /api/v1/schedule_triggers/:id
Delete a Schedule Trigger by ID