API documentation

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"
  }
}