GET /api/v1/lead_alterations
List lead modifications.

Params

Param name
Description
schedule_action_id
Optional

translation missing: en.api.lead_alterations.schedule_action_id

ids
Optional

Return records matching these ids.

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


GET /api/v1/lead_alterations/new
Build a lead modification with default attributes.


POST /api/v1/lead_alterations
Create a lead modification.

Params

Param name
Description
schedule_action_id
Required

translation missing: en.api.lead_alterations.schedule_action_id

key
Optional

translation missing: en.api.lead_alterations.key

  • Must be String

operator
Optional

translation missing: en.api.lead_alterations.operator

  • Must be one of: set, add_decimal, subtract_decimal, add_string.

value
Optional

translation missing: en.api.lead_alterations.value

  • Must be 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"
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/lead_alterations/:id
Get details about a lead modification.


PUT /api/v1/lead_alterations/:id
Update a lead modification.

Params

Param name
Description
schedule_action_id
Optional Blank Value Allowed

translation missing: en.api.lead_alterations.schedule_action_id

key
Optional

translation missing: en.api.lead_alterations.key

  • Must be String

operator
Optional

translation missing: en.api.lead_alterations.operator

  • Must be one of: set, add_decimal, subtract_decimal, add_string.

value
Optional

translation missing: en.api.lead_alterations.value

  • Must be 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"
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/lead_alterations/:id
Destroy a lead modification.