Skip to content
API Reference
/
/
Update a theme

Update a theme

Request

Security
form_session or user_session or component_session or component_token or api_token
Path
theme_idstring(ThemeId)^theme_required

Theme Identifier

Bodyapplication/jsonrequired
namestring, non-empty(nonEmptyString)

a non empty string

lightobject
darkobject
curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/themes/{theme_id}' \
  -H 'Authorization: Bearer <YOUR_Onboarded form session token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "light": {
      "logo": "string",
      "show_header": true,
      "show_form_name": true,
      "show_updated_fields_count": true,
      "next_button_text": "string",
      "back_button_text": "string",
      "custom_background": "#FFF",
      "custom_foreground": "#FFF",
      "primary_background": "#FFF",
      "primary_foreground": "#FFF",
      "secondary_background": "#FFF",
      "secondary_foreground": "#FFF",
      "progress": "#FFF",
      "border": "#FFF",
      "radius": "string"
    },
    "dark": {
      "logo": "string",
      "show_header": true,
      "show_form_name": true,
      "show_updated_fields_count": true,
      "next_button_text": "string",
      "back_button_text": "string",
      "custom_background": "#FFF",
      "custom_foreground": "#FFF",
      "primary_background": "#FFF",
      "primary_foreground": "#FFF",
      "secondary_background": "#FFF",
      "secondary_foreground": "#FFF",
      "progress": "#FFF",
      "border": "#FFF",
      "radius": "string"
    }
  }'

Responses

Theme

Bodyapplication/json
idstring(ThemeId)^theme_required

Theme Identifier

namestring, non-empty(nonEmptyString)required

a non empty string

lightobject
darkobject
created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

_tagstringrequired
Value:"Theme"
Response
{
  "id": "theme_abc123def456",
  "name": "string",
  "light": {
    "logo": "string",
    "show_header": true,
    "show_form_name": true,
    "show_updated_fields_count": true,
    "next_button_text": "string",
    "back_button_text": "string",
    "custom_background": "#FFF",
    "custom_foreground": "#FFF",
    "primary_background": "#FFF",
    "primary_foreground": "#FFF",
    "secondary_background": "#FFF",
    "secondary_foreground": "#FFF",
    "progress": "#FFF",
    "border": "#FFF",
    "radius": "string"
  },
  "dark": {
    "logo": "string",
    "show_header": true,
    "show_form_name": true,
    "show_updated_fields_count": true,
    "next_button_text": "string",
    "back_button_text": "string",
    "custom_background": "#FFF",
    "custom_foreground": "#FFF",
    "primary_background": "#FFF",
    "primary_foreground": "#FFF",
    "secondary_background": "#FFF",
    "secondary_foreground": "#FFF",
    "progress": "#FFF",
    "border": "#FFF",
    "radius": "string"
  },
  "created_at": "string",
  "updated_at": "string",
  "_tag": "Theme"
}