reporting module route (requires reporting:report:write)

PUT

/v1/m/reporting/branding

curl --request PUT \
  --url https://example.com/v1/m/reporting/branding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "company_name": "example", "footer_text": "example", "logo_path": "example", "primary_color": "example", "secondary_color": "example" }'

• this engine

Replaces the tenant report branding, and answers 501 when no branding store is wired.

Authorizations

• bearerAuth

Parameters

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body ^required

Media type application/json

object

company_name

Any of:

string

string

null

null

footer_text

Any of:

string

string

null

null

logo_path

Any of:

string

string

null

null

primary_color

Any of:

string

string

null

null

secondary_color

Any of:

string

string

null

null

key

additional properties

any

Example ^generated

{
  "company_name": "example",
  "footer_text": "example",
  "logo_path": "example",
  "primary_color": "example",
  "secondary_color": "example"
}

Responses

200

OK

Media type application/json

object

Example ^generated

{}

400

Bad request

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

409

Conflict / setup required

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}