API documentation

GET /schedule_ring_pools

Authorization Required

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

List Schedule Number Pool records.

List the number pools assigned to your schedules, in sort order, along with the filter group each assignment uses to decide when it applies.

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 schedule_id ring_pool_id description sortable_order name context_menu_name record_token_filter_id record_token_filter_data_count record_token_filter_data 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/schedule_ring_pools/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "schedule_ring_pools": [
    {
      "id": 10001,
      "type": "ScheduleRingPool",
      "uuid": null,
      "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": null,
      "routes_edit_path": "/schedule_ring_pools/10001/edit",
      "external_record_id": null,
      "company_id": 10002,
      "schedule_id": 10003,
      "ring_pool_id": 10004,
      "description": "Route After Hours Overflow through Toll-Free Tracking Pool",
      "sortable_order": 0,
      "name": "Toll-Free Tracking Pool",
      "context_menu_name": "Toll-Free Tracking Pool - Route After Hours Overflow through Toll-Free Tracking Pool",
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    },
    {
      "id": 10005,
      "type": "ScheduleRingPool",
      "uuid": null,
      "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": null,
      "routes_edit_path": "/schedule_ring_pools/10005/edit",
      "external_record_id": null,
      "company_id": 10002,
      "schedule_id": 10006,
      "ring_pool_id": 10007,
      "description": "Route Primary Lead Distribution through Local Tracking Pool",
      "sortable_order": 0,
      "name": "Local Tracking Pool",
      "context_menu_name": "Local Tracking Pool - Route Primary Lead Distribution through Local Tracking Pool",
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    }
  ],
  "metadata": {
    "root": "schedule_ring_pools",
    "page": 1,
    "total_pages": 2,
    "per_page": 2,
    "total_count": 4,
    "next_cursor": 10008
  }
}

GET /schedule_ring_pools/new

Authorization Required

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

Build Schedule Number Pool with defaults.

Return a blank schedule number pool assignment populated with default attribute values, useful for building a create form.

Params

Param name	Description
schedule_id Optional Blank value allowed	Schedule Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
ring_pool_id Optional Blank value allowed	Number Pool Must be a valid foreign key reference to an Number Pool. Refer to: /api/docs/1.0/ring_pools
filter_group_id Optional Blank value allowed	This Number Pool will be used for outbound calls when the call matches this Filter Group. Must be a valid foreign key reference to an Filter Group. Refer to: /api/docs/1.0/filter_groups
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
token_value_ids Optional Blank value allowed	Outbound calls matching these tokens will use this Number Pool. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
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"`

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "schedule_ring_pool": {
    "id": null,
    "type": "ScheduleRingPool",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": null,
    "external_record_id": null,
    "company_id": 10001,
    "schedule_id": null,
    "ring_pool_id": null,
    "description": null,
    "sortable_order": 0,
    "name": null,
    "context_menu_name": "",
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "schedule_ring_pool"
  }
}

POST /schedule_ring_pools

Authorization Required

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

Create Schedule Number Pool.

Assign a number pool to a schedule, optionally scoped to a filter group. When placing outbound calls, the schedule evaluates its assigned pools in sort order and uses the first one whose filter group matches, falling back to the last pool in the list if none match.

Params

Param name	Description
schedule_id Optional Blank value allowed	Schedule Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
ring_pool_id Optional Blank value allowed	Number Pool Must be a valid foreign key reference to an Number Pool. Refer to: /api/docs/1.0/ring_pools
filter_group_id Optional Blank value allowed	This Number Pool will be used for outbound calls when the call matches this Filter Group. Must be a valid foreign key reference to an Filter Group. Refer to: /api/docs/1.0/filter_groups
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
token_value_ids Optional Blank value allowed	Outbound calls matching these tokens will use this Number Pool. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
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"`
record_token_filter_id Optional Blank value allowed	Attach an existing Record Token Filter instead of building one from token_value_ids or record_token_filter_list. Must be a valid foreign key reference to an Filters. Refer to: /api/docs/1.0/record_token_filters

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/schedule_ring_pools/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "schedule_id": 10001,
  "ring_pool_id": 10002,
  "description": "Example schedule ring pool created by the API docs generator."
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "schedule_ring_pool": {
    "id": 10003,
    "type": "ScheduleRingPool",
    "uuid": null,
    "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": null,
    "routes_edit_path": "/schedule_ring_pools/10003/edit",
    "external_record_id": null,
    "company_id": 10004,
    "schedule_id": 10001,
    "ring_pool_id": 10002,
    "description": "Example schedule ring pool created by the API docs generator.",
    "sortable_order": 0,
    "name": "Local Tracking Pool",
    "context_menu_name": "Local Tracking Pool - Example schedule ring pool created by the API docs generator.",
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "schedule_ring_pool"
  }
}

GET /schedule_ring_pools/:id

Authorization Required

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

Get Schedule Number Pool by id.

Get the details of a single schedule number pool assignment by id.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "schedule_ring_pool": {
    "id": 10001,
    "type": "ScheduleRingPool",
    "uuid": null,
    "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": null,
    "routes_edit_path": "/schedule_ring_pools/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "schedule_id": 10003,
    "ring_pool_id": 10004,
    "description": "Route After Hours Overflow through Toll-Free Tracking Pool",
    "sortable_order": 0,
    "name": "Toll-Free Tracking Pool",
    "context_menu_name": "Toll-Free Tracking Pool - Route After Hours Overflow through Toll-Free Tracking Pool",
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "schedule_ring_pool"
  }
}

PUT /schedule_ring_pools/:id

Authorization Required

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

Update Schedule Number Pool by id.

Update which number pool, filter group, name, or description a schedule number pool assignment uses.

Params

Param name	Description
schedule_id Optional Blank value allowed	Schedule Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
ring_pool_id Optional Blank value allowed	Number Pool Must be a valid foreign key reference to an Number Pool. Refer to: /api/docs/1.0/ring_pools
filter_group_id Optional Blank value allowed	This Number Pool will be used for outbound calls when the call matches this Filter Group. Must be a valid foreign key reference to an Filter Group. Refer to: /api/docs/1.0/filter_groups
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
token_value_ids Optional Blank value allowed	Outbound calls matching these tokens will use this Number Pool. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
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"`

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/schedule_ring_pools/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "Example schedule ring pool (renamed)."
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "schedule_ring_pool": {
    "id": 10001,
    "type": "ScheduleRingPool",
    "uuid": null,
    "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": null,
    "routes_edit_path": "/schedule_ring_pools/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "schedule_id": 10003,
    "ring_pool_id": 10004,
    "description": "Example schedule ring pool (renamed).",
    "sortable_order": 0,
    "name": "Local Tracking Pool",
    "context_menu_name": "Local Tracking Pool - Example schedule ring pool (renamed).",
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "schedule_ring_pool"
  }
}

DELETE /schedule_ring_pools/:id

Authorization Required

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

Destroy Schedule Number Pool by id.

Remove a number pool assignment from a schedule.

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/schedule_ring_pools/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "schedule_ring_pool": {
    "id": 10001,
    "type": "ScheduleRingPool",
    "uuid": null,
    "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": null,
    "routes_edit_path": "/schedule_ring_pools/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "schedule_id": 10003,
    "ring_pool_id": 10004,
    "description": "Example schedule ring pool created by the API docs generator.",
    "sortable_order": 0,
    "name": "Local Tracking Pool",
    "context_menu_name": "Local Tracking Pool - Example schedule ring pool created by the API docs generator.",
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "schedule_ring_pool"
  }
}

Params

Must be any combination of:

Params

Params

Params