Create Folder Icons

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 /profiles/{profile_id}/icons/{folder}

Uploads one or more icons into an icon folder of the profile. Today the only folder is drawing_custom_icons, the custom icon set of the Drawing element.

Request body

A single { "file_data": ... } object or a JSON array of them. file_data is the base64-encoded image. Each image must be PNG or JPEG and at most 256 KB; anything else fails that item with Unsupported Media Type or Payload Too Large.

Limit

The server's icon limit is counted per folder: icons in drawing_custom_icons do not count towards the default page-icon folder, and the other way round. Once the folder is full, each further item fails with Profile has reached the limit of icons.

HTTP status

  • 201 every item was stored
  • 207 some items failed and some did not
  • 400 every item failed
  • 401 no valid bearer token
  • 403 not an internal client app, or another profile's profile_id
  • 404 folder is not an allowed icon folder

Authorization

Restricted to internal client apps, the same as POST /profiles/{profile_id}/icons.

Headers

  • Authorization string

    e.g. Bearer {access_token}

Path parameters

  • profile_id string Required

    id of the profile

  • folder string Required

    name of the icon folder

    Value is drawing_custom_icons.

application/json
Body object | array[object] Required
One of:
Hide attribute Show attribute object
  • file_data string Required

    base64-encoded PNG or JPEG image, at most 256 KB

Responses

  • 201 application/json

    Created - every icon was stored. A single object in the request returns a single IconOutcome; an array returns an array, in request order.

    One of:

    per-icon outcome of an icons POST or DELETE request

    Hide attributes Show attributes object

    per-icon outcome of an icons POST or DELETE request

    • url string

      the icon's url; on POST, the url of the stored icon, on DELETE, the url exactly as submitted. Absent when the item failed.

    • error_message string

      present only when the item failed

  • 207 application/json

    Multi-Status - some icons were stored and some failed. The body has the same shape as 201; failed items carry error_message instead of url.

    Hide response attributes Show response attributes object
    • url string

      the icon's url; on POST, the url of the stored icon, on DELETE, the url exactly as submitted. Absent when the item failed.

    • error_message string

      present only when the item failed

  • 400 application/json

    Bad Request - every icon failed. The body has the same shape as 201, with an error_message on each item (for example a missing file_data, Payload Too Large, Unsupported Media Type or Profile has reached the limit of icons).

    One of:

    per-icon outcome of an icons POST or DELETE request

    Hide attributes Show attributes object

    per-icon outcome of an icons POST or DELETE request

    • url string

      the icon's url; on POST, the url of the stored icon, on DELETE, the url exactly as submitted. Absent when the item failed.

    • error_message string

      present only when the item failed

  • 401

    Unauthorized - missing or invalid bearer token.

  • 403

    Forbidden - the token is not from an internal client app, or profile_id is not the caller's own profile.

  • 404

    Not Found - folder is not an allowed icon folder, or profile_id does not exist.

POST /profiles/{profile_id}/icons/{folder}
curl \
 --request POST 'https://api.iformbuilder.com/exzact/api/v80/[servername]/profiles/self/icons/drawing_custom_icons' \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer {access_token}" \
 --data '{
  "file_data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="
}'
Request examples
{
  "file_data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="
}
[
  {
    "file_data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="
  },
  {
    "file_data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="
  }
]
Response examples (201)
{
  "url": "https://zerion-iform-icons-example.s3.amazonaws.com/app/67890/drawing_custom_icons/field_17306240006721a2f0b1c3d.png"
}
Response examples (207)
[
  {
    "url": "https://zerion-iform-icons-example.s3.amazonaws.com/app/67890/drawing_custom_icons/field_17306240006721a2f0b1c3d.png"
  },
  {
    "error_message": "Profile has reached the limit of icons"
  }
]
Response examples (400)
{
  "error_message": "Profile has reached the limit of icons"
}