API documentation

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