Get the brand platform configuration (platform)

GET /platform/config

Headers

  • X-Popsell-Domain string Required

    The domain of the user

Responses

  • 200 application/json

    Returns the 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
GET /platform/config
curl \
 --request GET 'https://domain.tld/api/v2/platform/config' \
 --header "X-Popsell-Domain: example.com"
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."
}