API documentation

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