Params

Param name
Description
schedule_id
Required

Schedule internal id

name
Required

The trigger name

  • Must be String

trigger_type
Required

The schedule ends when the lead has taken this action.

  • 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.

  • Must be a decimal number.

expire_timestamp_name
Optional Blank Value Allowed

translation missing: en.api.schedule_triggers.expire_timestamp_name

  • Must be one of: created_at, first_queued_at, first_action_at.

token_values
Optional Blank Value Allowed

The first trigger matching the lead will be used.

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

These extra tokens will be applied to leads that exit the schedule through this trigger.

  • 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.

  • Must be a decimal number.