MEmeshconnect
Registered Clients

Update Registered client

Changed on

Update information about already Registered client by client id. This request does not support updating client Logo URL. In order to update a Logo URL, send separate Update Registered Logo request along with id of the client.

put/admin/api/v1/SubClient/{id}

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}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The identifier of the Registered client to update

Request body

businessLegalNamestring required

Registered client Business Legal Name

displayNamestring required

Registered client Display Name

callbackUrlsstring[] nullable

Registered client Allowed Link URLs. If no Allowed Link URLs are specified, Allowed Link URLs from main client will be used.

Response

Registered client 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

  • ac9d647737b7Revision changes
    • warning

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