Powered by Redocly

Branding profiles

Branding profiles describe corporate branding and grouping for your customers.

Branding profile

A branding profile determines a provider's visual corporate identity in the Customer Portal and lets a provider differentiate product pricing for connected customers.

id
string <uuid>

Branding Profile identifier.

currency
string <iso-4217>

The default currency for customers created under this branding profile.

name
string [ 1 .. 255 ] characters

Name of the branding profile.

price_list_code_id
string or null <uuid>

Price list code identifier.

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "currency": "EUR",
  • "name": "My Remote Diagnostics",
  • "price_list_code_id": "a29db1be-1640-4931-9c6f-2a65a84af434"
}

Retrieve all branding profiles

Retrieve a list of branding profiles.

SecurityOAuth2
Request
query Parameters
limit
integer <int32> [ 0 .. 1000 ]
Default: 25

Limits the amount of resources in result.

offset
integer <int64> >= 0
Default: 0

Offset of resources in result.

Responses
200

Successful response.

Response Schema: application/json
object >= 0 properties

Applied query parameters, including defaults.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

The applied value of the limit query parameter on the resources in result.

offset
integer <int64> >= 0
Default: 0

The applied value of the offset query parameter on the resources in result.

property name*
additional property
any
Array of objects (Branding profile) >= 0 items

List of branding profiles.

Array (>= 0 items)
id
string <uuid>

Branding Profile identifier.

currency
string <iso-4217>

The default currency for customers created under this branding profile.

name
string [ 1 .. 255 ] characters

Name of the branding profile.

price_list_code_id
string or null <uuid>

Price list code identifier.

total
integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/providers/branding-profiles
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 4
}

Retrieve a branding profile

Retrieve a branding profile by its identifier.

SecurityOAuth2
Request
path Parameters
branding-profile-id
required
string <uuid>

Branding profile identifier.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Branding Profile identifier.

currency
string <iso-4217>

The default currency for customers created under this branding profile.

name
string [ 1 .. 255 ] characters

Name of the branding profile.

price_list_code_id
string or null <uuid>

Price list code identifier.

default

An error occurred - see status code and problem response for more information.

get/v2/providers/branding-profiles/{branding-profile-id}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "currency": "EUR",
  • "name": "My Remote Diagnostics",
  • "price_list_code_id": "a29db1be-1640-4931-9c6f-2a65a84af434"
}
➔ Next to Countries