Skip to main content
PUT
/
projects
/
{project_id}
/
playlists
/
{id}
Update
curl --request PUT \
  --url https://api.beyondwords.io/v1/projects/{project_id}/playlists/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "title": "My playlist",
  "enabled": true,
  "type": "manual",
  "content_limit": 25,
  "content": [
    {
      "id": "d7dfd636-098c-4b1b-83e5-15a3cba5a0bd"
    },
    {
      "id": "ed81a10c-83cd-4b1f-ab43-2aa1b4ffefc0"
    },
    {
      "id": "1c0274ba-362d-4dea-8a34-5177061bf032"
    }
  ]
}'
{
  "id": 1,
  "title": "My playlist",
  "enabled": true,
  "type": "manual",
  "content_limit": 25,
  "content": [
    {
      "id": "d7dfd636-098c-4b1b-83e5-15a3cba5a0bd",
      "status": "processed",
      "title": "Content title",
      "source_id": "example-source-id",
      "source_url": "https://example.com/some-article",
      "author": "John Smith",
      "image_url": "https://example.com/image.jpeg",
      "metadata": {
        "key": "value"
      },
      "audio": [
        {
          "id": 1,
          "content_type": "application/vnd.apple.mpegurl",
          "url": "https://example.com/audio.m3u8",
          "duration": 10000
        },
        {
          "id": 2,
          "content_type": "audio/mpeg,",
          "url": "https://example.com/audio.mp3",
          "duration": 10000
        }
      ],
      "video": [
        {
          "id": 1,
          "content_type": "video/mp4",
          "url": "https://example.com/waveform-video.mp4",
          "duration": 10000
        }
      ],
      "ads_enabled": true,
      "created": "2023-01-01 00:00:00 UTC",
      "updated": "2023-01-01 00:00:05 UTC"
    }
  ],
  "settings": null,
  "created": "2023-01-01 00:00:00 UTC",
  "updated": "2023-01-01 00:00:05 UTC"
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
project_id
string
required

The numeric ID of your project

​
id
string
required

The numeric ID of your playlist

Body

application/json
​
title
string
required

The title of the playlist

​
type
enum<string>
required

The type of playlist. The project type is generated automatically. The manual and auto can set content and rules respectively

Available options:
project,
manual,
auto
​
enabled
boolean

Whether the playlist can be played in the BeyondWords player

​
rules_version
enum<string> | null
​
rules
object[]

The rules that will be used to find content for 'auto' playlists

​
content
object[]

The IDs of content to include in the manual playlist

​
image_url
string | null

The image URL of the playlist

Response

200 - application/json

successful

​
id
integer

Unique identifier for the object

​
title
string

The title of the playlist

​
enabled
boolean

Whether the playlist can be played in the BeyondWords player

​
type
enum<string>

The type of playlist. The project type is generated automatically. The manual and auto can set content and rules respectively

Available options:
project,
manual,
auto
​
rules_version
enum<string> | null
​
rules
object[]

The rules that will be used to find content for auto playlists

​
content_limit
integer

The maximum number of content items that will appear in the playlist

​
content
object[]

The content of the playlist (a reduced set of fields are returned). Only the id field is returned for the playlists index endpoint

​
created
string<date-time>

Time at which the object was created (ISO 8601)

​
settings
object
​
updated
string<date-time>

Time at which the object was updated (ISO 8601)