Update details of a single role.

PUT

https://demo.azuracast.com/api/admin/role/{id}

curl -X PUT 'https://demo.azuracast.com/api/admin/role/0' \
  -H 'X-API-Key: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "name": "Super Administrator",
  "permissions": {
    "global": [
      "administer all"
    ],
    "station": [
      {
        "id": 0,
        "permissions": [
          "administer all"
        ]
      }
    ]
  }
}'

const body = `{
  "name": "Super Administrator",
  "permissions": {
    "global": [
      "administer all"
    ],
    "station": [
      {
        "id": 0,
        "permissions": [
          "administer all"
        ]
      }
    ]
  }
}`;

const response = await fetch('https://demo.azuracast.com/api/admin/role/0', {
  method: 'PUT',
  headers: {
    'X-API-Key': 'YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "name": "Super Administrator",
  "permissions": {
    "global": [
      "administer all"
    ],
    "station": [
      {
        "id": 0,
        "permissions": [
          "administer all"
        ]
      }
    ]
  }
}'''

response = requests.put(
    'https://demo.azuracast.com/api/admin/role/0',
    data=body.encode('utf-8'),
    headers={
        'X-API-Key': 'YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "name": "Super Administrator",
  "permissions": {
    "global": [
      "administer all"
    ],
    "station": [
      {
        "id": 0,
        "permissions": [
          "administer all"
        ]
      }
    ]
  }
}

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

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

Body

application/json

namestringrequired

Example

Super Administrator

permissionsApi_Admin_RolePermissions

Show child attributes

globalArray<GlobalPermissions>administer allview administrationview system logsadminister settingsadminister api keysadminister stationsadminister custom fieldsadminister backupsadminister storage locationsrequired

stationArray<Api_Admin_RoleStationPermission>required

Show child attributes

idintegerrequired

The station ID.

permissionsArray<StationPermissions>administer allview station managementview station reportsview station logsmanage station profilemanage station broadcastingmanage station streamersmanage station mountsmanage station remotesmanage station mediadelete station mediamanage station automationmanage station web hooksmanage station podcastsrequired

Parameters

idinteger<int64>requiredpath

Role ID

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

404Not FoundApi_Error

Record not found.

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