Upload Branding Image

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.zerionsoftware.com/doc/iformbuilder-v80/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "iFormBuilder V80 MCP server": {
    "url": "https://apidocs.zerionsoftware.com/doc/iformbuilder-v80/mcp"
  }
}

Close
POST /branding/images/{name}

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.

Headers

  • Authorization string

    e.g. Bearer {access_token}

Path parameters

  • name string Required

    the image name; see the table above

multipart/form-data

Body Required

  • file string(binary) Required

    one PNG image; its bytes are checked, not its file name or declared type

Responses

  • 201 application/json

    Created - the image was stored.

    Hide response attributes Show response attributes object
    • name string Required

      the image name from the path

    • url string Required

      the public URL of the stored image

  • 400 application/json

    Bad Request - no file was uploaded, or the file is not a PNG image GD can read.

    Hide response attribute Show response attribute object
    • error_message string Required

      human-readable reason for the failure

  • 401 application/json

    Unauthorized - missing or invalid bearer token.

    Hide response attribute Show response attribute object
    • error_message string Required

      human-readable reason for the failure

  • 403 application/json

    Forbidden - the client is not internal, or the user is not a SERVER user.

    Hide response attribute Show response attribute object
    • error_message string Required

      human-readable reason for the failure

  • 404 application/json

    Not Found - name is not an image name, or is an sso_* name while SSO is off.

    Hide response attribute Show response attribute object
    • error_message string Required

      human-readable reason for the failure

  • 502 application/json

    Bad Gateway - the image could not be written to the branding bucket.

    Hide response attribute Show response attribute object
    • error_message string Required

      human-readable reason for the failure

POST /branding/images/{name}
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"
Response examples (201)
{
  "name": "logo",
  "url": "https://iform-artwork.s3.amazonaws.com/app/logo.png"
}
Response examples (400)
{
  "error_message": "string"
}
Response examples (401)
{
  "error_message": "string"
}
Response examples (403)
{
  "error_message": "string"
}
Response examples (404)
{
  "error_message": "string"
}
Response examples (502)
{
  "error_message": "string"
}