Unset Asset
- Print
- DarkLight
- PDF
Unset Asset
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/assets.unsetAsset
Unset 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
Asset name to unset. assetName can be one of these: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
If needs refresh all clients to apply changes immediately.
Responses
200
OK
Success
{
"success": true
}object
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?