API documentation

GET /state_rule_groups

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/state_rule_groups

List State Call Rules records.

Lists State Call Rules groups, which apply state-level business hours, call limits, or holiday schedules either account-wide or to specific offers depending on rule_scope. 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. Must be a valid time zone. See the list of valid time zones.
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 rule_scope offer_ids name description state_business_hour_ids state_call_limit_ids state_holiday_ids 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

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/state_rule_groups/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "state_rule_groups": [
    {
      "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "type": "StateRuleGroup",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/state_rule_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "routes_edit_path": "/state_rule_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
      "external_record_id": null,
      "company_id": 10001,
      "rule_scope": "company",
      "offer_ids": null,
      "name": "Example State Rule Group",
      "description": "desc",
      "state_business_hour_ids": [
        "a09e6bca-255b-4217-af73-cb9601c80217"
      ],
      "state_call_limit_ids": [
        "49cca320-d2dd-4768-a730-8fc3e0a664e7"
      ],
      "state_holiday_ids": [
        "8a10bcf5-8767-4aa3-a10b-5458e72d5bf9"
      ]
    },
    {
      "id": "1d4df925-d435-4b33-a461-efb6c324405e",
      "type": "StateRuleGroup",
      "uuid": "1d4df925-d435-4b33-a461-efb6c324405e",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/state_rule_groups/1d4df925-d435-4b33-a461-efb6c324405e",
      "routes_edit_path": "/state_rule_groups/1d4df925-d435-4b33-a461-efb6c324405e/edit",
      "external_record_id": null,
      "company_id": 10001,
      "rule_scope": "company",
      "offer_ids": null,
      "name": "Example State Rule Group",
      "description": "desc",
      "state_business_hour_ids": [
        "a09e6bca-255b-4217-af73-cb9601c80217"
      ],
      "state_call_limit_ids": [
        "49cca320-d2dd-4768-a730-8fc3e0a664e7"
      ],
      "state_holiday_ids": [
        "8a10bcf5-8767-4aa3-a10b-5458e72d5bf9"
      ]
    }
  ],
  "metadata": {
    "root": "state_rule_groups",
    "page": 1,
    "total_pages": 4,
    "per_page": 2,
    "total_count": 7,
    "next_cursor": 10002
  }
}

GET /state_rule_groups/new

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/state_rule_groups/new

Build State Call Rules with defaults.

Returns a blank State Call Rules group populated with default attribute values, without saving it. Requires the company_preferences permission.

Params

Param name	Description
rule_scope Optional Blank value allowed	Rule Scope Must be one of: `company`, `offer`.
offer_ids Optional Blank value allowed	Offer Ids Must be an array of decimal values. EG: `[0, 1, 2, 3]`
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
state_business_hour_ids Optional Blank value allowed	State Business Hour Ids Must be an array of decimal values. EG: `[0, 1, 2, 3]`
state_call_limit_ids Optional Blank value allowed	State Call Limit Ids Must be an array of decimal values. EG: `[0, 1, 2, 3]`
state_holiday_ids Optional Blank value allowed	State Holidays Ids Must be an array of decimal values. EG: `[0, 1, 2, 3]`

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/state_rule_groups/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "state_rule_group": {
    "id": null,
    "type": "StateRuleGroup",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/state_rule_groups/new",
    "routes_edit_path": "/state_rule_groups/new",
    "external_record_id": null,
    "company_id": 10001,
    "rule_scope": "company",
    "offer_ids": null,
    "name": null,
    "description": null,
    "state_business_hour_ids": null,
    "state_call_limit_ids": null,
    "state_holiday_ids": null
  },
  "metadata": {
    "root": "state_rule_group"
  }
}

POST /state_rule_groups

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/state_rule_groups

Create State Call Rules.

Creates a State Call Rules group with a rule_scope (account-wide or restricted to specific offer_ids) and at least one of state_business_hour_ids, state_call_limit_ids, or state_holiday_ids attached. Requires the company_preferences permission.

Params

Param name	Description
rule_scope Optional Blank value allowed	Rule Scope Must be one of: `company`, `offer`.
offer_ids Optional Blank value allowed	Offer Ids Must be an array of decimal values. EG: `[0, 1, 2, 3]`
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
state_business_hour_ids Optional Blank value allowed	State Business Hour Ids Must be an array of decimal values. EG: `[0, 1, 2, 3]`
state_call_limit_ids Optional Blank value allowed	State Call Limit Ids Must be an array of decimal values. EG: `[0, 1, 2, 3]`
state_holiday_ids Optional Blank value allowed	State Holidays Ids Must be an array of decimal values. EG: `[0, 1, 2, 3]`

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/state_rule_groups/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example State Rule Group",
  "description": "Restricts calls by state business hours, call limits, and holidays.",
  "rule_scope": "company",
  "state_business_hour_ids": [
    "a6af7847-1b1e-4760-ac0d-e1813a6d3a09"
  ],
  "state_call_limit_ids": [
    "a09e6bca-255b-4217-af73-cb9601c80217"
  ],
  "state_holiday_ids": [
    "49cca320-d2dd-4768-a730-8fc3e0a664e7"
  ]
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "state_rule_group": {
    "id": "8a10bcf5-8767-4aa3-a10b-5458e72d5bf9",
    "type": "StateRuleGroup",
    "uuid": "8a10bcf5-8767-4aa3-a10b-5458e72d5bf9",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/state_rule_groups/8a10bcf5-8767-4aa3-a10b-5458e72d5bf9",
    "routes_edit_path": "/state_rule_groups/8a10bcf5-8767-4aa3-a10b-5458e72d5bf9/edit",
    "external_record_id": null,
    "company_id": 10001,
    "rule_scope": "company",
    "offer_ids": null,
    "name": "Example State Rule Group",
    "description": "Restricts calls by state business hours, call limits, and holidays.",
    "state_business_hour_ids": [
      "a6af7847-1b1e-4760-ac0d-e1813a6d3a09"
    ],
    "state_call_limit_ids": [
      "a09e6bca-255b-4217-af73-cb9601c80217"
    ],
    "state_holiday_ids": [
      "49cca320-d2dd-4768-a730-8fc3e0a664e7"
    ]
  },
  "metadata": {
    "root": "state_rule_group"
  }
}

GET /state_rule_groups/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/state_rule_groups/:id

Get State Call Rules by id.

Fetches a single State Call Rules group by id. Requires the company_preferences permission.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/state_rule_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "state_rule_group": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "StateRuleGroup",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/state_rule_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/state_rule_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "rule_scope": "company",
    "offer_ids": null,
    "name": "Example State Rule Group",
    "description": "desc",
    "state_business_hour_ids": [
      "a09e6bca-255b-4217-af73-cb9601c80217"
    ],
    "state_call_limit_ids": [
      "49cca320-d2dd-4768-a730-8fc3e0a664e7"
    ],
    "state_holiday_ids": [
      "8a10bcf5-8767-4aa3-a10b-5458e72d5bf9"
    ]
  },
  "metadata": {
    "root": "state_rule_group"
  }
}

PUT /state_rule_groups/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/state_rule_groups/:id

Update State Call Rules by id.

Updates a State Call Rules group's scope, offers, or attached business hour, call limit, or holiday rules. Requires the company_preferences permission.

Params

Param name	Description
rule_scope Optional Blank value allowed	Rule Scope Must be one of: `company`, `offer`.
offer_ids Optional Blank value allowed	Offer Ids Must be an array of decimal values. EG: `[0, 1, 2, 3]`
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
state_business_hour_ids Optional Blank value allowed	State Business Hour Ids Must be an array of decimal values. EG: `[0, 1, 2, 3]`
state_call_limit_ids Optional Blank value allowed	State Call Limit Ids Must be an array of decimal values. EG: `[0, 1, 2, 3]`
state_holiday_ids Optional Blank value allowed	State Holidays Ids Must be an array of decimal values. EG: `[0, 1, 2, 3]`

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/state_rule_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example State Rule Group (renamed)"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "state_rule_group": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "StateRuleGroup",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/state_rule_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/state_rule_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "rule_scope": "company",
    "offer_ids": null,
    "name": "Example State Rule Group (renamed)",
    "description": "Restricts calls by state business hours, call limits, and holidays.",
    "state_business_hour_ids": [
      "a09e6bca-255b-4217-af73-cb9601c80217"
    ],
    "state_call_limit_ids": [
      "49cca320-d2dd-4768-a730-8fc3e0a664e7"
    ],
    "state_holiday_ids": [
      "8a10bcf5-8767-4aa3-a10b-5458e72d5bf9"
    ]
  },
  "metadata": {
    "root": "state_rule_group"
  }
}

DELETE /state_rule_groups/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/state_rule_groups/:id

Destroy State Call Rules by id.

Deletes a State Call Rules group by id. Requires the company_preferences permission.

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/state_rule_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "state_rule_group": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "StateRuleGroup",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": "2026-01-15T15:30:00.000Z",
    "user_updated_at": null,
    "routes_show_path": "/state_rule_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/state_rule_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "rule_scope": "company",
    "offer_ids": null,
    "name": "Example State Rule Group",
    "description": "Restricts calls by state business hours, call limits, and holidays.",
    "state_business_hour_ids": [
      "a09e6bca-255b-4217-af73-cb9601c80217"
    ],
    "state_call_limit_ids": [
      "49cca320-d2dd-4768-a730-8fc3e0a664e7"
    ],
    "state_holiday_ids": [
      "8a10bcf5-8767-4aa3-a10b-5458e72d5bf9"
    ]
  },
  "metadata": {
    "root": "state_rule_group"
  }
}

Params

Must be any combination of:

Params

Params

Params