> For the complete documentation index, see [llms.txt](https://docs.trustlesswork.com/trustless-work/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/update-escrow-properties.md).
# Update Escrow
### Requirements to use:
1. Only the entity with the admin role has permissions to execute this endpoint
2. If an escrow has funds, the only thing the platform can do is add more milestones. The other properties cannot be modified under any circumstances.
### Headers
Name
Value
Content-Type
application/json
x-api-key
<token>
### Roles:
| Name | Type | Description |
| --------------- | ------ | ------------------------------------------------------------------------------------ |
| approver | string | Address of the entity requiring the service. |
| serviceProvider | string | Address of the entity providing the service. |
| platformAddress | string | Address of the entity that owns the escrow |
| releaseSigner | string | Address of the user in charge of releasing the escrow funds to the service provider. |
| disputeResolver | string | Address in charge of resolving disputes within the escrow. |
| receiver | string | Address where escrow proceeds will be sent to |
### Milestone:
| Name | Type | Description |
| ----------- | ------- | -------------------------------------------------- |
| description | string | Text describing the function of the milestone. |
| status | string | Milestone status. Ex: Approved, In dispute, etc... |
| amount | boolean | Amount of the milestone |
### Trustline
| Name | Type | Description |
| ------- | ------ | -------------------------------------------------------------------------- |
| address | string | Public address establishing permission to accept and use a specific token. |
### Open API
## Replace the on-chain v2 escrow properties
> Full replacement of the platform-controlled fields. Per-milestone state (approvals, dispute, released) is preserved. Admin signs.
```json
{"openapi":"3.0.0","info":{"title":"👋🏼 Trustless Work Core API — All Endpoints (Unified)","version":"1.0"},"security":[{}],"paths":{"/escrow/multi-release/v2/update":{"put":{"description":"Full replacement of the platform-controlled fields. Per-milestone state (approvals, dispute, released) is preserved. Admin signs.","operationId":"UpdateMultiReleaseEscrowV2Controller_update","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMultiReleaseEscrowV2Dto"}}}},"responses":{"200":{"description":"Unsigned XDR built successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsignedTransactionResponse"}}}},"400":{"description":"Request body or query params fail schema validation (wrong type, missing required field, unknown property).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsResponseDto"}}}},"401":{"description":"Missing, malformed, expired, revoked or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsResponseDto"}}}},"403":{"description":"API key is valid but does not have the role required for this operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsResponseDto"}}}},"422":{"description":"Payload is well-formed but a business rule rejects it (e.g. amount out of range, role not allowed for this user).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsResponseDto"}}}},"500":{"description":"Unexpected server-side failure. Use the `traceId` to look up the incident in server logs or contact support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsResponseDto"}}}}},"summary":"Replace the on-chain v2 escrow properties","tags":["Multi Release Escrow V2"]}}},"components":{"schemas":{"UpdateMultiReleaseEscrowV2Dto":{"type":"object","properties":{"contractId":{"type":"string","description":"Deployed multi-release v2 escrow contract (C...)."},"admin":{"type":"string","description":"Admin wallet authorising the update — must equal `roles.admin` of the on-chain escrow. Signs the transaction."},"escrow":{"description":"Full replacement of the on-chain v2 escrow properties.","allOf":[{"$ref":"#/components/schemas/UpdateMultiReleaseEscrowPropertiesV2Dto"}]}},"required":["contractId","admin","escrow"]},"UpdateMultiReleaseEscrowPropertiesV2Dto":{"type":"object","properties":{"engagementId":{"type":"string","description":"Stable identifier the platform uses to correlate the escrow."},"title":{"type":"string","description":"Short title."},"description":{"type":"string","description":"Long-form description."},"platformFee":{"type":"number","description":"Platform fee in percent."},"receiverMemo":{"type":"number","description":"Optional receiver memo (u32 on-chain)."},"roles":{"$ref":"#/components/schemas/MultiReleaseRolesV2Dto"},"milestones":{"description":"Required by the on-chain validator even though the contract preserves the existing on-chain milestones.","type":"array","items":{"$ref":"#/components/schemas/MultiReleaseMilestoneV2Dto"}},"trustline":{"$ref":"#/components/schemas/MultiReleaseTrustlineV2Dto"}},"required":["engagementId","title","description","platformFee","roles","milestones","trustline"]},"MultiReleaseRolesV2Dto":{"type":"object","properties":{"approvers":{"description":"Wallets allowed to approve milestones. Up to 5, no duplicates.","type":"array","items":{"type":"string"}},"serviceProviders":{"description":"Wallets that perform the work and change milestone status. Up to 5.","type":"array","items":{"type":"string"}},"platform":{"type":"string","description":"Trustless Work platform wallet. Receives the platform fee."},"releaseSigners":{"description":"Wallets authorised to release each milestone (or the whole batch). Up to 5, no duplicates.","type":"array","items":{"type":"string"}},"disputeResolvers":{"description":"Wallets that resolve disputes when they are raised. Up to 5, no duplicates. Cannot overlap with any other role.","type":"array","items":{"type":"string"}},"admin":{"type":"string","description":"Admin wallet — authorises update_escrow, manage_milestones and extend_contract_ttl. MUST be distinct from every other role."},"observers":{"description":"Read-only observer wallets attached to the escrow. They have no on-chain authority. Defaults to empty.","type":"array","items":{"type":"string"}}},"required":["approvers","serviceProviders","platform","releaseSigners","disputeResolvers","admin"]},"MultiReleaseMilestoneV2Dto":{"type":"object","properties":{"description":{"type":"string","description":"Human-readable milestone description."},"amount":{"type":"number","description":"Amount allocated to THIS milestone, in human-readable decimals. Each milestone holds and releases its own portion independently."},"receiver":{"type":"string","description":"Final beneficiary of THIS milestone’s payout. Each milestone may pay a different address (multi-release v2 holds `receiver` per milestone — `roles.receiver` does not exist on multi-release v2)."},"status":{"type":"string","description":"Initial status. Convention: pending → in_progress → completed. Defaults to \"pending\"."},"approvalsTarget":{"type":"number","description":"Number of distinct approvers required for the milestone. Must be > 0 and ≤ roles.approvers.length. Defaults to 1."}},"required":["description","amount","receiver"]},"MultiReleaseTrustlineV2Dto":{"type":"object","properties":{"contractId":{"type":"string","description":"Soroban contract address of the asset (C...). Required if symbol+address are not provided."},"symbol":{"type":"string","description":"Asset code / symbol. Required if contractId is not provided; ignored otherwise."},"address":{"type":"string","description":"Issuer account address (G...). Required if contractId is not provided; ignored otherwise."}}},"UnsignedTransactionResponse":{"type":"object","properties":{"unsignedXdr":{"type":"string","description":"Base64-encoded unsigned XDR. Sign it with the appropriate wallet and submit to Soroban / Horizon to execute the operation on-chain."},"txHash":{"type":"string","description":"SHA-256 hash of the prepared transaction. Use as a correlation key between this build call and any follow-up (pending-write tracking, idempotency keys, audit logs)."}},"required":["unsignedXdr","txHash"]},"ProblemDetailsResponseDto":{"type":"object","properties":{"type":{"type":"string","description":"Stable URI identifying the error type. Hash-link points to the docs."},"title":{"type":"string","description":"Short human-readable summary of the problem."},"status":{"type":"number","description":"HTTP status code, repeated here for typed clients."},"code":{"type":"string","description":"Machine-readable error code. Stable across versions; safe to switch on."},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence."},"instance":{"type":"string","description":"URI of the request that triggered the error."},"traceId":{"type":"string","description":"Correlation id propagated from the `X-Trace-Id` header (or generated). Use it when contacting support to reference a specific request."},"extensions":{"type":"object","description":"Optional structured context. Shape depends on the error code; documented per-endpoint when relevant.","additionalProperties":true}},"required":["type","title","status","code","detail"]}}}}
```
### **What this Endpoint returns?**
This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
### Use Example:
```typescript
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
const response = await http.put(
"/escrow/multi-release/v2/update",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/stellar/submit-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/update-escrow-properties.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.