---
title: "Update Partner Deallocations"
method: PUT
path: "/api/network/v1/enterprises/{enterpriseId}/partners/deallocations"
tags: ["Partner Allocations & Deallocations"]
---

# Update Partner Deallocations

`PUT /api/network/v1/enterprises/{enterpriseId}/partners/deallocations`

This API call allows partners to inform the OES system about an update to a deallocation made to one of
their connections. This endpoint is only relevant to OES partners that have async deallocations enabled.

A successful response indicates that the allocation was successfully updated in the OES system and the funds
are cleared (if cleared is passed for status) or released (if released is passed for status).

**Requires access token scopes:** `settlement_network_read`, `settlement_network_write`

## Path parameters

- `enterpriseId` string, required

## Request body

- object
  - `deallocationId` string, required — The unique identifier of the deallocation to update. This UUID uniquely identifies the deallocation record.
  - `amount` PositivePartnerCurrencyAmount, required
    - `currency` string, required
    - `quantity` string, required
  - `clientId` string, required — The unique identifier of the client which initiated the deallocation. This UUID uniquely identifies the client within the BitGo system.
  - `connectionId` string, required — The unique identifier of the connection to deallocate from. This UUID uniquely identifies the connection between a client and a partner.
  - `partnersClientId` string, required — The unique identifier of the client in the partner system. This value uniquely identifies the client within the partner's system.
  - `partnersConnectionId` string, required — The unique identifier of the connection in the partner system. This value uniquely identifies the connection between a client and a partner in the partner's system.
  - `partnersDeallocationId` string, required — The unique identifier of the deallocation in the partner system. This value uniquely identifies the deallocation record within the partner's system.
  - `evaluationId` string — The unique identifier of the policy evaluation for this deallocation. Present when policy evaluation was performed as part of the deallocation update flow.
  - `pendingApprovalId` string — The unique identifier of the pending approval for this deallocation. Present when policy evaluation resulted in a PENDING status requiring manual approval.
  - `policyResult` 'approved' | 'rejected' — The result of the policy evaluation for this deallocation. - APPROVED: Policy evaluation passed and the operation was allowed - REJECTED: Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.
  - `status` 'cleared' | 'released', required
  - `nonce` string, required — Unique nonce to prevent replay attacks. This value: - Must be unique for each request requiring a nonce. - Should be a cryptographically strong random value. - Is used as part of the request signing process. - Helps ensure the signature can only be used once.
  - `rejectReason` string — The reason for releasing the deallocation.
  - `payload` string, required — Payload formed by stringifying the object containing all other request properties. This includes: - status - rejectReason (only if status is 'released') - deallocationId - amount - clientId - connectionId - partnersClientId - partnersConnectionId - partnersDeallocationId - nonce The payload must be signed using your BitGo account's private key to create the signature parameter.
  - `signature` string, required — Digital signature of the payload parameter. This signature: - Must be created using your BitGo account's private key. - Verifies that the request is authentic and hasn't been tampered with. - Provides non-repudiation for the allocation request.

## Response `200`

OK

- V1PartnerUpdateDeallocationResponse
  - `deallocationId` string, required — The unique identifier of the deallocation to update. This UUID uniquely identifies the deallocation record.
  - `amount` PositivePartnerCurrencyAmount, required
    - `currency` string, required
    - `quantity` string, required
  - `clientId` string, required — The unique identifier of the client which initiated the deallocation. This UUID uniquely identifies the client within the BitGo system.
  - `connectionId` string, required — The unique identifier of the connection to deallocate from. This UUID uniquely identifies the connection between a client and a partner.
  - `partnersClientId` string, required — The unique identifier of the client in the partner system. This value uniquely identifies the client within the partner's system.
  - `partnersConnectionId` string, required — The unique identifier of the connection in the partner system. This value uniquely identifies the connection between a client and a partner in the partner's system.
  - `partnersDeallocationId` string, required — The unique identifier of the deallocation in the partner system. This value uniquely identifies the deallocation record within the partner's system.
  - `evaluationId` string — The unique identifier of the policy evaluation for this deallocation. Present when policy evaluation was performed as part of the deallocation update flow.
  - `pendingApprovalId` string — The unique identifier of the pending approval for this deallocation. Present when policy evaluation resulted in a PENDING status requiring manual approval.
  - `policyResult` 'approved' | 'rejected' — The result of the policy evaluation for this deallocation. - APPROVED: Policy evaluation passed and the operation was allowed - REJECTED: Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `409` — Conflict
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/bitgo/apis/bitgo-api.md) · [All operations](https://skmtc.net/bitgo/apis/bitgo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitgo/bitgo-api/revisions/e445c15e5bee/schema)