Update a brand's setting

Updates a brand's setting by the given brand id.

put

Path parameters

idstringRequired

The id of the brand.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

This class provides the Brand Setting Dto.

domainWhiteListURLsstring | nullableOptional

The domain white list URLs.

googleAnalyticsAccountstring | nullableOptionalDeprecated

The google analytics account.

reCaptchaKeystring | nullableOptionalDeprecated

The reCaptcha key.

currencyCodestring | nullableOptional

The currency code of the brand

cdnURLstring | nullableOptional

The cdn URL.

cdnFolderstring | nullableOptional

The cdn folder.

passwordPolicyLevelstring · enumRequired

This enum is used to define the password levels.

Possible values:

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/brands/{id}/setting HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "domainWhiteListURLs": "text",
  "currencyCode": "text",
  "cdnURL": "text",
  "cdnFolder": "text",
  "passwordPolicyLevel": "Low"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": true,
  "errors": []
}