Ctrl+K

Update Network Partner

put/api/network/v1/admin/partners/{partnerId}

Update a OES partner's configuration and settings. This admin-only endpoint allows BitGo administrators to modify existing partner settings including activation status, settlement configuration, and timing parameters. Partners are identified by their unique partnerId.

Path Parameters

  • partnerIdstringRequired
    The unique identifier of the partner to update. This is a UUID that uniquely identifies the partner record.

Query Parameters

  • trustOrgstringRequired
    Trust organization identifier. Used for filtering by the trust organization the partner belongs to.
    Enum: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1

Request Body

name string
The name of the partner. This will be displayed in the UI.
Min length: >= 1 characters
institutionId
string or null
Optional UUID for the partner's institution record. Links the partner to an institution in the BitGo system. Can be set to null to remove the association.
connectionKeySchema string
The key schema used for partner connections. Defines the structure and validation rules for connection keys.
Allowed values: token tokenAndSignature apiKeyAndSecret clearloop
active boolean
Whether the partner is active. When set to false, the partner is deactivated and no further operations can be performed. When set to true, the partner is activated and operations can be performed.
clientDisputeWindowMinutes number
Window (in minutes) for clients to dispute settlements. Defines how long after a settlement clients have to raise disputes. Can be set to null to remove the dispute window configuration.
topUpWindowMinutes number
Window (in minutes) for topping up settlements. Defines the period during which a settlement can be topped up. Can be set to null to remove the top-up window configuration.
allocationPoliciesEnabled boolean
Optional flag to enable or disable allocation policies for the partner. When true, policy evaluation features (allocation/deallocation) are enabled. When false, these features are disabled. If not provided, the existing value is preserved.

200 Response

partner object required
The complete partner object after successful update.
id string required
enterpriseId string required
Min length: >= 1 characters
trustOrg string required
Allowed values: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1
institutionId string
institutionIdentifier string required
Min length: >= 1 characters
name string required
Min length: >= 1 characters
connectionKeySchema string required
Allowed values: token tokenAndSignature apiKeyAndSecret clearloop
createdAt string <date-time>required
Timestamp when the partner was created in the system.
updatedAt string <date-time>required
Timestamp of the most recent update to the partner record.
clientId string required
broker boolean required
active boolean required
settlementTransactionRouteId string
clientDisputeWindowMinutes number
topUpWindowMinutes number
allocationPoliciesEnabled boolean required
publicKey string
Optional RSA public key associated with the partner. This key is used for secure communication and encrypting connection keys. If not supplied, encryption is not required for the partner.

400 Response

401 Response

error string required

403 Response

error string required

404 Response

error string required

500 Response

error string required