Unset Asset

Prev Next
Post
/api/v1/assets.unsetAsset

Remove an asset by name. Permissions required: manage-assets .

Changelog

Version Description
0.69.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example
{
  "assetName": "logo",
  "refreshAllClients": true
}
object
assetName
string Required

Type of asset to remove. The value can be one of the following:

  • logo
  • background
  • favicon_ico
  • favicon
  • favicon_16
  • favicon_32
  • favicon_192
  • favicon_512
  • touchicon_180
  • touchicon_180_pre
  • tile_70
  • tile_144
  • tile_150
  • tile_310_square
  • tile_310_wide
  • safari_pinned
refreshAllClients
boolean

Set to true if all clients must be refreshed to immediately apply the changes.

Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'assetName' [invalid-params]",
  "errorType": "invalid-params"
}
object
success
boolean
error
string
errorType
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string