Update the brand platform configuration (manager)

PATCH /manager/platform-config

Bearer token

application/json

Body

global object

Additional properties are allowed.
Hide global attributes Show global attributes object
- forceBlogRedirect boolean
- pickingURL string
- enableGuestMessaging boolean
- assetsFolderName string
ai object

Additional properties are allowed.
Hide ai attribute Show ai attribute object
- copilotMessageRewordingAssistantId string
theme object

Additional properties are allowed.
Hide theme attributes Show theme attributes object
- text_color_1 string
- text_color_2 string
- text_color_3 string
- text_color_4 string
- background_color_1 string
- background_color_2 string
- background_color_3 string
- background_color_4 string
- white_toolbar_on_mobile boolean

Responses

200 application/json

Returns the updated configuration
Hide response attributes Show response attributes object
- global object
  
  Additional properties are allowed.
  
  Hide global attributes Show global attributes object
  
  forceBlogRedirect boolean
  
  pickingURL string
  
  enableGuestMessaging boolean
  
  assetsFolderName string
- ai object
  
  Additional properties are allowed.
  
  Hide ai attribute Show ai attribute object
  
  copilotMessageRewordingAssistantId string
- theme object
  
  Additional properties are allowed.
  
  Hide theme attributes Show theme attributes object
  
  text_color_1 string
  
  text_color_2 string
  
  text_color_3 string
  
  text_color_4 string
  
  background_color_1 string
  
  background_color_2 string
  
  background_color_3 string
  
  background_color_4 string
  
  white_toolbar_on_mobile boolean
401 application/json

Unauthorized.
Hide response attribute Show response attribute object
- message string
403

Forbidden - You don't have permission to access this route
404

Not found
422 application/json

Unprocessable Content
Hide response attributes Show response attributes object
- message string
  
  Error message.
- errors object
  
  Hide errors attributes Show errors attributes object
  
  field array[string]
  
  Error message details.
  
  * array[string] Additional properties
  
  Error message details.

PATCH /manager/platform-config

curl \
 --request PATCH 'https://domain.tld/api/v2/manager/platform-config' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"global":{"forceBlogRedirect":true,"pickingURL":"string","enableGuestMessaging":true,"assetsFolderName":"string"},"ai":{"copilotMessageRewordingAssistantId":"string"},"theme":{"text_color_1":"string","text_color_2":"string","text_color_3":"string","text_color_4":"string","background_color_1":"string","background_color_2":"string","background_color_3":"string","background_color_4":"string","white_toolbar_on_mobile":true}}'

Request examples

{
  "global": {
    "forceBlogRedirect": true,
    "pickingURL": "string",
    "enableGuestMessaging": true,
    "assetsFolderName": "string"
  },
  "ai": {
    "copilotMessageRewordingAssistantId": "string"
  },
  "theme": {
    "text_color_1": "string",
    "text_color_2": "string",
    "text_color_3": "string",
    "text_color_4": "string",
    "background_color_1": "string",
    "background_color_2": "string",
    "background_color_3": "string",
    "background_color_4": "string",
    "white_toolbar_on_mobile": true
  }
}

Response examples (200)

{
  "global": {
    "forceBlogRedirect": true,
    "pickingURL": "string",
    "enableGuestMessaging": true,
    "assetsFolderName": "string"
  },
  "ai": {
    "copilotMessageRewordingAssistantId": "string"
  },
  "theme": {
    "text_color_1": "string",
    "text_color_2": "string",
    "text_color_3": "string",
    "text_color_4": "string",
    "background_color_1": "string",
    "background_color_2": "string",
    "background_color_3": "string",
    "background_color_4": "string",
    "white_toolbar_on_mobile": true
  }
}

Response examples (401)

{
  "message": "Unauthorized."
}

Response examples (422)

{
  "message": "field is required! (and 3 more error)",
  "errors": {
    "field": [
      "Error message details here"
    ],
    "additionalProperty1": [
      "Error message details here"
    ],
    "additionalProperty2": [
      "Error message details here"
    ]
  }
}