Replaces one of the server's branding images. The upload is resized to the image's fixed size, ignoring its aspect ratio, and stored at [servername]/[name].png in the server's branding bucket, public-read. The console pages and devices read that object directly, so it is the image they show from then on.
| name | size (px) |
|---|---|
sign_in |
70 x 28 |
content |
800 x 600 |
header_bg |
65 x 85 |
login_bg |
439 x 325 |
dataview_login |
350 x 33 |
login |
109 x 38 |
logo |
248 x 58 |
pw_reset_header |
350 x 33 |
reset_password |
168 x 38 |
formbuilder_logo |
355 x 70 |
formbuilder_sidebar |
70 x 560 |
logout |
70 x 28 |
activate |
168 x 38 |
web_page_icon |
32 x 32 |
sso_login_bg |
878 x 325 |
sso_dataview_login |
350 x 33 |
sso_login |
109 x 38 |
The three sso_* names exist only while SSO is enabled on the server.
Authorization
Internal API clients only, and SERVER users only, whatever the server's ZWS mode.
Responses
-
Created - the image was stored.
-
Bad Request - no file was uploaded, or the file is not a PNG image GD can read.
-
Unauthorized - missing or invalid bearer token.
-
Forbidden - the client is not internal, or the user is not a SERVER user.
-
Not Found -
nameis not an image name, or is ansso_*name while SSO is off. -
Bad Gateway - the image could not be written to the branding bucket.
curl \
--request POST 'https://api.iformbuilder.com/exzact/api/v80/[servername]/branding/images/logo' \
--header "Content-Type: multipart/form-data" \
--header "Authorization: Bearer {access_token}" \
--form "file=@file"
{
"name": "logo",
"url": "https://iform-artwork.s3.amazonaws.com/app/logo.png"
}
{
"error_message": "string"
}
{
"error_message": "string"
}
{
"error_message": "string"
}
{
"error_message": "string"
}
{
"error_message": "string"
}