Set Asset

Prev Next
Post
/api/v1/assets.setAsset

Upload an asset by name. Permissions required: manage-assets. Make sure that the workspace's file upload settings are configured as required. The allowed file size and type depend on the file upload settings.

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
object
asset
string Required

Upload the file as form-data.

assetName
string Required

Type of asset to upload. 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

No asset name
{
  "success": false,
  "error": "Invalid asset"
}
Example 1
{
  "success": false,
  "error": "[No file uploaded]",
  "errorType": "No file uploaded"
}
object
success
boolean
error
string
401

Unauthorized

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