Update a theme

PUT

https://www.rapidoform.com/be/api/theme/:themeId

All requests require X-EMAIL and X-API-KEY. See authentication and errors. JSON request bodies also require Content-Type: application/json. All IDs in examples are synthetic; replace them with your own values.

Parameters

NameType / locationDescription
themeIdpath stringRequired theme ObjectId.
themeNamestringOptional; defaults to My Theme.
backgroundColor, questionColor, questionTypeColor, btnBackgroundColor, btnTextColor, bottomLineColorstringOptional CSS colors.
backgroundImage, backgroundImageType, backgroundImageTypeColorstringOptional background media and treatment.
logo, logoType, logoTypeColor, logoAltTextstringOptional logo configuration.
textAlignment, welcomeTextAlignmentstringOptional text alignment.
fontSize, welcomeFontSizestringOptional font size; default is "1.5".
fontFamily, fontUrl, radiusstringOptional font family, font resource and border radius.
bgImgBrigthness, logoSizenumberOptional image brightness (default 1) and logo size (default 72). Keep the spelling bgImgBrigthness.
isPaidThemebooleanOptional; defaults to false.

Requires a writable Owner/Admin account and a theme you created or a private theme in your workspace. Clone gallery themes before changing them. Missing themes return HTTP 404. Send only editable fields; ownership, gallery flags, timestamps and update operators are rejected. This returns a confirmation message; retrieve the form/workspace theme to inspect its values.

Example request

curl --request PUT 'https://www.rapidoform.com/be/api/theme/000000000000000000000002' \
  --header "X-EMAIL: $RAPIDOFORM_EMAIL" \
  --header "X-API-KEY: $RAPIDOFORM_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"backgroundColor":"#f8fafc"}'

JSON request body

{
  "backgroundColor": "#f8fafc"
}

Response

Examples show selected fields, not every stored property. Empty arrays are valid for list/report endpoints.

{
  "Errors": [],
  "Info": [],
  "Data": [
    {
      "message": "Theme Updated Successfully"
    }
  ],
  "ErrorCode": "SUCCESS",
  "fieldErrors": {
    "List": []
  }
}

HTTP 200 alone does not indicate success. Check ErrorCode and Errors; see troubleshooting.