Update Configurations

Update a configuration item by sending only the properties you would like to update. The request payload should only contain those properties which you are updating. If updating branding, use the Upload endpoint first to get a pre-signed url, upload the file to the S3 bucket using a file transfer utility and then send the published url in this request.

SecurityOAuth2
Request
header Parameters
content-type
string
Example: application/json
Authorization
string
Example: Bearer <token>
Request Body schema: application/json
accentColor
string or null
object or null
object or null
displayCollections
boolean

If true, Collections will be displayed on the Home Page to users.

defaultContentView
string
Enum: "Grid" "Masonry" "List"
Responses
200

Successful Request. Configurations Updated Successfully.

400

One or more required parameters are missing or invalid.

401

Authentication failed (unauthorized).

403

Forbidden. You do not have permissions to perform this action, or your connection information is not correct.

503

The server is too busy to handle the request.

patch/configurations
Request samples
application/json
{
  • "accentColor": "#3a91c3",
  • "terminology": {
    },
  • "landingPage": {
    },
  • "displayCollections": true,
  • "defaultContentView": "Grid"
}