Currently, the POST /delegatedforms API endpoint supports Font Awesome icons via the useFaIcon and faIcon fields. However, it is not possible to set or upload a custom image icon for a Delegated Form through
the API — this can only be done manually through the HelloID web interface.
Requested improvement:
Add API support for custom form icons, so that Delegated Forms can be fully configured via the API without requiring manual intervention in the UI.
Suggested implementation options:
Option A — Dedicated upload endpoint:
POST /delegatedforms/{DelegatedFormGUID}/icon
Content-Type: multipart/form-data
Body: file (image/png or image/svg+xml)
Returns the stored icon reference (URL or GUID).
Option B — Base64 field on existing endpoint:
Extend POST /delegatedforms with:
{
"customIconBase64": "<base64-encoded image>",
"customIconMimeType": "image/png"
}
Suggested icon specs (aligned with current UI behavior):
- Accepted formats: PNG, SVG
- Recommended size: 64×64 px or scalable SVG
- Max file size: 100 KB
Use case:
We manage multiple HelloID tenants and provision Delegated Forms fully via createform.ps1 scripts. Custom icons are part of the form's identity and user experience. Being unable to set them via the API forces an extra manual step after every (re-)import, which breaks our fully automated deployment pipeline.