POST /User/Preferences/Colors

If using POST, it sets the user settings to the values passed. Both GET and POST queries returns the configured values after any updates are made. Secret Hmac Required. Cache Time 1 Hour. Reset if customer information edited.

application/json

Body

  • DarkMode string

    Optional dark mode setting of True, False or Auto

  • BackColor string

    Optional Background color as an html color. Auto sets to the WRTM default

  • BackWinColor string

    Optional Background color of the windows as an html color. Auto sets to the WRTM default

  • LogoColor string

    Optional Logo color as an html color. Auto sets to the WRTM default

  • LogoAlign string

    Optional Logo Alignment of Left, Right, Center or Auto. Auto sets to the WRTM default

  • TitleColor string

    Optional Title color as an html color. Auto sets to the WRTM default

  • TextColor string

    Optional Title color as an html color. Auto sets to the WRTM default

Responses

  • 200 application/json

    User Colors successfully returned

    Hide response attributes Show response attributes object
    • DarkMode string

      Optional dark mode setting of True, False or Auto

    • BackColor string

      Optional Background color as an html color. Auto sets to the WRTM default

    • BackWinColor string

      Optional Background color of the windows as an html color. Auto sets to the WRTM default

    • LogoColor string

      Optional Logo color as an html color. Auto sets to the WRTM default

    • LogoAlign string

      Optional Logo Alignment of Left, Right, Center or Auto. Auto sets to the WRTM default

    • TitleColor string

      Optional Title color as an html color. Auto sets to the WRTM default

    • TextColor string

      Optional Title color as an html color. Auto sets to the WRTM default

POST /User/Preferences/Colors
curl \
 --request POST 'https://api.wrtm.io/v1.0/User/Preferences/Colors' \
 --header "X-ApiKey: $API_KEY" \
 --header "X-ApiDate: $API_KEY" \
 --header "X-ApiHmac: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"DarkMode":"Auto","BackColor":"Auto","BackWinColor":"Auto","LogoColor":"Auto","LogoAlign":"Auto","TitleColor":"Auto","TextColor":"Auto"}'
Request examples
{
  "DarkMode": "Auto",
  "BackColor": "Auto",
  "BackWinColor": "Auto",
  "LogoColor": "Auto",
  "LogoAlign": "Auto",
  "TitleColor": "Auto",
  "TextColor": "Auto"
}
Response examples (200)
{
  "DarkMode": "Auto",
  "BackColor": "Auto",
  "BackWinColor": "Auto",
  "LogoColor": "Auto",
  "LogoAlign": "Auto",
  "TitleColor": "Auto",
  "TextColor": "Auto"
}