Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Client Activation

Update Client Connection

Update a OES connection by its connection ID. For use only by OES clients. Allows clients to modify connection properties such as name or active status.

Error scenarios:

  • 400: Invalid Request Error

  • Occurs when the request parameters are invalid or malformed.

  • Examples: Invalid UUID format for connectionId, invalid enterpriseId format, malformed request body.

  • 401: Authentication Error

  • Occurs when the request is not authorized.

  • Examples: Caller is not a member of the enterprise.

  • 403: Permission Denied Error

  • Occurs when the authenticated client doesn't have necessary permissions.

  • Examples: Enterprise does not have OES license.

  • 404: Not Found Error

  • Occurs when the specified connection cannot be found.

  • Examples: Connection ID doesn't exist, connection doesn't belong to this client.

  • 500: Internal Server Error

  • Occurs when there's an unexpected server error processing the request.

  • Examples: Database connection issues, transient network errors.

Requires access token scopes: settlement_network_read, settlement_network_write

put/api/network/v1/enterprises/{enterpriseId}/clients/connections/{connectionId}

Path parameters

enterpriseIdstring required

The enterprise identifier of the client. This identifies the client enterprise that owns the connection.

connectionIdstring required

The unique identifier of the connection to update. This UUID uniquely identifies the connection between a client and a partner.

Request body

activeboolean

Whether the connection is active. When set to false, the connection is deactivated and cannot be allocated to until it is activated again (deallocations can still occur). When set to true, the connection is activated can be allocated to again.

namestring

A user-friendly name for the connection. Allows clients to provide a descriptive label for this particular connection.

Response

OK