Registered Clients

Update Registered client Logo

Changed on

Adds or update a logo for Registered client. Allowed file extensions are ".png", ".jpg", ".jpeg". Allowed file MIME types are "image/png", "image/jpeg", "image/jpg". Maximum file size is 5MB. Upload logo as form data with key 'logoFile'.

post/admin/api/v1/SubClient/{id}/logo

Request

  • Base URL
    https://dashboard-prd-eus2-api-app.azurewebsites.net
  • URL
    https://dashboard-prd-eus2-api-app.azurewebsites.net/admin/api/v1/SubClient/{id}/logo
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The identifier of the Registered client to update logo for

Request body multipart/form-data

logoFilestring binary required

Logo image file (.png, .jpg, .jpeg only, max 5MB)

Response

Registered client logo added/updated

status'ok' | 'serverFailure' | 'permissionDenied' | 'badRequest' | 'notFound' | 'conflict' | 'tooManyRequest' | 'locked' | 'unavailableForLegalReasons' | 'serviceUnavailable'
messagestring nullable

A message generated by the API

displayMessagestring nullable

User-friendly display message that can be presented to the end user

errorHashstring nullable

An error grouping hash from string components and caller information. Used by bugsnag on FE for correct error grouping

teamCodestring nullable

Opaque team code for error routing. Resolved from exception origin or caller file path via CODEOWNERS. Format: 2-character code (e.g., "7K", "M2"). Use for alerting/routing, not display.

errorTypestring nullable

Strictly-typed error type that is explaining the reason of an unsuccessful status of the operation. All possible error types are available in the documentation.

errorDataunknown

Changes

    • warning

      added the new serviceUnavailable enum value to the response property for the response status