Import playlists from a JSON configuration dump, creating new playlists on the station.

POST

https://demo.azuracast.com/api/station/{station_id}/playlists/import-config

curl -X POST 'https://demo.azuracast.com/api/station/0/playlists/import-config' \
  -H 'X-API-Key: YOUR_TOKEN' \
  --form-string 'name_prefix=string'

const form = new FormData();
form.append('name_prefix', 'string');
const response = await fetch('https://demo.azuracast.com/api/station/0/playlists/import-config', {
  method: 'POST',
  headers: {"X-API-Key":"YOUR_TOKEN"},
  body: form,
});
console.log(await response.text());

import requests
from contextlib import ExitStack

with ExitStack() as stack:
    files = [
        ('name_prefix', (None, 'string')),
    ]
    response = requests.request('POST', 'https://demo.azuracast.com/api/station/0/playlists/import-config', headers={"X-API-Key":"YOUR_TOKEN"}, files=files)
    print(response.text)

Request Body

{
  "config_file": "<binary>",
  "name_prefix": "string"
}

{
  "success": true,
  "message": "Changes saved successfully.",
  "formatted_message": "<b>Changes saved successfully.</b>"
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

Body

multipart/form-data

config_filestring<binary>

The JSON configuration dump to import.

name_prefixstring | null

Optional prefix prepended to every imported playlist name.

Parameters

station_idinteger | stringrequiredpath

Response

200OKApi_Status

Success

Response fields application/json

successbooleanrequired

Example

true

messagestringrequired

Example

Changes saved successfully.

formatted_messagestringrequired

Example

<b>Changes saved successfully.</b>

403ForbiddenApi_Error

Access denied.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

500Internal Server ErrorApi_Error

A generic exception has occurred.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

Authorization

ApiKeyapiKey in header

Docs by Sourcey