Update a brand's setting

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

put

Path parameters

idstringRequired

The id of the brand.

Query parameters

api-versionstringOptional

Header parameters

BrandUrlstringRequired

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

Example: YOUR_BRAND_URL

AuthkeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

This class provides the Brand Setting Dto.

domainWhiteListUrlsstring | nullableOptional

The domain white list urls.

googleAnalyticsAccountstring | nullableOptional

The google analytics account.

reCaptchaKeystring | nullableOptional

The reCaptcha key.

coinCurrencyCodestring | nullableOptional

The coin earning code of the brand system.

cdnUrlstring | nullableOptional

The cdn url.

cdnFolderstring | nullableOptional

The cdn folder.

passwordPolicyLevelstring · enumOptionalPossible 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 AuthKey header.

application/json

403

The user's access was denied.

application/json

429

The user has exceeded the rate limit.

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/brands/{id}/setting HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Authkey: text
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "domainWhiteListUrls": "text",
  "googleAnalyticsAccount": "text",
  "reCaptchaKey": "text",
  "coinCurrencyCode": "text",
  "cdnUrl": "text",
  "cdnFolder": "text",
  "passwordPolicyLevel": "1 - Low"
}

application/jsontext/jsonapplication/*+json

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