v1

latestOpenAPI 3.0.12026-07-26101626.2 KB

Registered Clients

Add new Registered client

Create new Registered client with specified data. Client will be created without Logo URL. In order to specify a Logo URL, send separate Update Registered Logo request along with id of just created client.

post/admin/api/v1/SubClient

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 created

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.

{"stackTrail":"components:schemas:B2B2BRegisteredClientDataApiResult:properties:errorData","oasType":"schema","type":"unknown","nullable":true}