Call Frequency

A cap on how many times contacts in specified states can be called within a set time interval.

GET /state_call_limits

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

List State Call Frequency records.

Lists State Call Frequency rules, which cap how often calls can be placed to phone numbers in specific US states over a configured interval. Requires the company_preferences permission.

Params

Param name Description
ids
Optional

Return records matching these ids.

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

Return the next page of results.

  • Must be a number.
per_page
Optional

How many results to return per page. The default is 25.

  • Must be a number.
created_at_to
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be a String
created_at_from
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be a String
fulltext
Optional

Search for any record that matches this text

  • Must be a String
time_zone
Optional

Date ranges will be parsed using this time zone.
columns
Optional 		Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at

Must be any combination of:

  • id
  • legacy_id
  • type
  • uuid
  • created_at
  • updated_at
  • deleted_at
  • user_updated_at
  • routes_show_path
  • routes_edit_path
  • external_record_id
  • company_id
  • states
  • name
  • call_limit_interval
  • call_limit_limit
  • is_system_template
  • template_description
  • template_tier
  • template_enabled
  • template_copy_on_company_create
  • template_id

  • Must be a String
root
Optional

Pass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}

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

GET /state_call_limits/new

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

Build State Call Frequency with defaults.

Builds a State Call Frequency rule with default attributes without saving it.

Params

Param name Description
states
Optional Blank value allowed

States

  • Must be an array of strings. EG: ["abc123", "xzy023"]
name
Optional Blank value allowed

Name

  • Must be a String
call_limit_interval
Optional Blank value allowed

Call Limit Interval

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

Call Limit Limit

  • Must be a decimal number.

POST /state_call_limits

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

Create State Call Frequency.

Creates a State Call Frequency rule specifying the states it applies to along with the call limit and interval.

Params

Param name Description
states
Optional Blank value allowed

States

  • Must be an array of strings. EG: ["abc123", "xzy023"]
name
Optional Blank value allowed

Name

  • Must be a String
call_limit_interval
Optional Blank value allowed

Call Limit Interval

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

Call Limit Limit

  • Must be a decimal number.

GET /state_call_limits/:id

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

Get State Call Frequency by id.

Retrieves a State Call Frequency rule by id.

PUT /state_call_limits/:id

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

Update State Call Frequency by id.

Updates a State Call Frequency rule's states or limit. System-provided rules (those with a template_id) cannot be modified and the request is rejected.

Params

Param name Description
states
Optional Blank value allowed

States

  • Must be an array of strings. EG: ["abc123", "xzy023"]
name
Optional Blank value allowed

Name

  • Must be a String
call_limit_interval
Optional Blank value allowed

Call Limit Interval

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

Call Limit Limit

  • Must be a decimal number.

DELETE /state_call_limits/:id

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

Destroy State Call Frequency by id.

Deletes a State Call Frequency rule by id. System-provided rules (those with a template_id) cannot be deleted and the request is rejected.