API documentation

GET /sound_playlists

Authorization Required

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

List Playlist records.

Lists the sound playlists in your account, used for hold music and other audio prompts. Supports the standard search parameters such as pagination, sorting, and full-text search, and can be filtered to a specific list of playlist ids.

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 name order_type use_predefined_playlist predefined_playlist_id description sound_file_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/sound_playlists/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "sound_playlists": [
    {
      "id": 10001,
      "type": "SoundPlaylist",
      "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": "/sound_playlists/10001",
      "routes_edit_path": "/sound_playlists/10001/edit",
      "external_record_id": null,
      "company_id": 10002,
      "name": "Standard Hold Music",
      "order_type": "random",
      "use_predefined_playlist": false,
      "predefined_playlist_id": null,
      "description": "Default hold music playlist for inbound callers",
      "sound_file_ids": []
    },
    {
      "id": 10003,
      "type": "SoundPlaylist",
      "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
      "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": "/sound_playlists/10003",
      "routes_edit_path": "/sound_playlists/10003/edit",
      "external_record_id": null,
      "company_id": 10002,
      "name": "Premium Hold Music",
      "order_type": "round_robin",
      "use_predefined_playlist": false,
      "predefined_playlist_id": null,
      "description": "Premium hold music for high-value buyer queues",
      "sound_file_ids": []
    }
  ],
  "metadata": {
    "root": "sound_playlists",
    "page": 1,
    "total_pages": 3,
    "per_page": 2,
    "total_count": 5,
    "next_cursor": 10004
  }
}

GET /sound_playlists/new

Authorization Required

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

Build Playlist with defaults.

Builds an unsaved playlist populated with Trackdrive's default attribute values so you can preview the settings before calling create. Nothing is saved to your account.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
order_type Optional Blank value allowed	How sound files in this playlist are picked for playback. One of `sortable_order`, `random`, or `round_robin`. Must be one of: `sortable_order`, `random`, `round_robin`.
use_predefined_playlist Optional Blank value allowed	When true, this playlist plays a built-in Trackdrive playlist instead of its own uploaded sound files. Must be a boolean value: 1, true, yes, on, 0, false, no, off
predefined_playlist_id Optional Blank value allowed	The built-in Trackdrive playlist played when `use_predefined_playlist` is true. Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
sound_file_ids Optional Blank value allowed	The Sound Files in this playlist, in playback order. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Sound File. Refer to: /api/docs/1.0/sound_files

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "sound_playlist": {
    "id": null,
    "type": "SoundPlaylist",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/sound_playlists/new",
    "routes_edit_path": "/sound_playlists/new",
    "external_record_id": null,
    "company_id": 10001,
    "name": null,
    "order_type": null,
    "use_predefined_playlist": null,
    "predefined_playlist_id": null,
    "description": null,
    "sound_file_ids": []
  },
  "metadata": {
    "root": "sound_playlist"
  }
}

POST /sound_playlists

Authorization Required

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

Create Playlist.

Creates a new sound playlist in your account with the given name, description, and playback order_type, optionally attaching its sound files and their play order via sound_file_ids, or cloning a predefined playlist's files via use_predefined_playlist/predefined_playlist_id.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
order_type Optional Blank value allowed	How sound files in this playlist are picked for playback. One of `sortable_order`, `random`, or `round_robin`. Must be one of: `sortable_order`, `random`, `round_robin`.
use_predefined_playlist Optional Blank value allowed	When true, this playlist plays a built-in Trackdrive playlist instead of its own uploaded sound files. Must be a boolean value: 1, true, yes, on, 0, false, no, off
predefined_playlist_id Optional Blank value allowed	The built-in Trackdrive playlist played when `use_predefined_playlist` is true. Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
sound_file_ids Optional Blank value allowed	The Sound Files in this playlist, in playback order. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Sound File. Refer to: /api/docs/1.0/sound_files

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/sound_playlists/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example Sound Playlist",
  "description": "Rotates greetings played at the start of a call",
  "order_type": "round_robin"
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "sound_playlist": {
    "id": 10001,
    "type": "SoundPlaylist",
    "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": "/sound_playlists/10001",
    "routes_edit_path": "/sound_playlists/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "name": "Example Sound Playlist",
    "order_type": "round_robin",
    "use_predefined_playlist": null,
    "predefined_playlist_id": null,
    "description": "Rotates greetings played at the start of a call",
    "sound_file_ids": []
  },
  "metadata": {
    "root": "sound_playlist"
  }
}

GET /sound_playlists/:id

Authorization Required

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

Get Playlist by id.

Retrieves a single sound playlist by its Trackdrive internal ID.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "sound_playlist": {
    "id": 10001,
    "type": "SoundPlaylist",
    "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": "/sound_playlists/10001",
    "routes_edit_path": "/sound_playlists/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "name": "Standard Hold Music",
    "order_type": "random",
    "use_predefined_playlist": false,
    "predefined_playlist_id": null,
    "description": "Default hold music playlist for inbound callers",
    "sound_file_ids": []
  },
  "metadata": {
    "root": "sound_playlist"
  }
}

PUT /sound_playlists/:id

Authorization Required

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

Update Playlist by id.

Updates an existing playlist's name, description, or playback order_type, and can replace its sound files and their play order via sound_file_ids. Only the attributes you include are changed.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
order_type Optional Blank value allowed	How sound files in this playlist are picked for playback. One of `sortable_order`, `random`, or `round_robin`. Must be one of: `sortable_order`, `random`, `round_robin`.
use_predefined_playlist Optional Blank value allowed	When true, this playlist plays a built-in Trackdrive playlist instead of its own uploaded sound files. Must be a boolean value: 1, true, yes, on, 0, false, no, off
predefined_playlist_id Optional Blank value allowed	The built-in Trackdrive playlist played when `use_predefined_playlist` is true. Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
sound_file_ids Optional Blank value allowed	The Sound Files in this playlist, in playback order. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Sound File. Refer to: /api/docs/1.0/sound_files

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/sound_playlists/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example Sound Playlist (renamed)"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "sound_playlist": {
    "id": 10001,
    "type": "SoundPlaylist",
    "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": "/sound_playlists/10001",
    "routes_edit_path": "/sound_playlists/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "name": "Example Sound Playlist (renamed)",
    "order_type": "round_robin",
    "use_predefined_playlist": null,
    "predefined_playlist_id": null,
    "description": "Rotates greetings played at the start of a call",
    "sound_file_ids": []
  },
  "metadata": {
    "root": "sound_playlist"
  }
}

DELETE /sound_playlists/:id

Authorization Required

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

Destroy Playlist by id.

Permanently deletes a sound playlist by its Trackdrive internal ID. Unlike buyers and schedules, playlists are not soft-deleted, so this action cannot be undone.

Example Request

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

Example Response 204

Params

Must be any combination of:

Params

Params

Params