Branding Detail - Fetch branding-related details

Retrieves branding-related details.

get

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

Responses

200

Success: Successfully retrieved branding details.

text/plainapplication/jsontext/json

Class for storing information about branding.

brandNamestring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the BrandName property.

logoUrlstring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the LogoUrl property.

imageExtensionstring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the ImageExtension property.

copyrightValuestring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the CopyrightText property.

privacyPolicystring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the PrivacyPolicyUrl property.

headerColorstring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the HeaderColor property.

headerTextColorstring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the HeaderFontColor property.

leftNavColorstring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the LeftNavColor property.

leftNavTextColorstring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the LeftNavFontColor property.

204

Success: No brand related details exist

400

Bad Request: The request could not be processed due to invalid syntax or missing/incorrect parameters.

text/plainapplication/jsontext/json

401

Unauthorized: Invalid credentials or missing/invalid authentication token.

text/plainapplication/jsontext/json

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

get

/branding

HTTPcURLJavaScriptPython

GET /branding HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "brandName": "text",
  "logoUrl": "text",
  "imageExtension": "text",
  "copyrightValue": "text",
  "privacyPolicy": "text",
  "headerColor": "text",
  "headerTextColor": "text",
  "leftNavColor": "text",
  "leftNavTextColor": "text"
}