Update a brand's profile

Updates a brand's profile 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 Profile Dto.

sloganstring · min: 1Required

The slogan.

logoURLstring · uri · nullableOptional

The logo URL.

faviconURLstring · uri · nullableOptional

The favicon URL.

primaryColorstring · nullableOptional

The primary color. Color for primary actions, buttons, text links. 3 and 6 digit hex code values accepted.

primaryColorHoverstring · nullableOptional

The primary color hover. Color for primary actions, buttons, text links hover. 3 and 6 digit hex code values accepted.

secondaryColorstring · nullableOptional

This value is used to determine the secondary color of the brand. Color for background to accent your UI. 3 and 6 digit hex code values accepted.

tertiaryColorstring · nullableOptional

This value is used to determine the tertiary color of the brand. Color for background to accent your UI. 3 and 6 digit hex code values accepted.

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

databooleanRead-onlyOptional

This is the data to be returned to the client.

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

/api/v1/brands/{id}/profile

HTTPcURLJavaScriptPython

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

{
  "slogan": "text",
  "logoURL": "https://example.com",
  "faviconURL": "https://example.com",
  "primaryColor": "text",
  "primaryColorHover": "text",
  "secondaryColor": "text",
  "tertiaryColor": "text"
}

application/jsontext/jsonapplication/*+json

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