Skip to main content
POST
/
platform
/
admin
/
proposals
/
{proposalId}
/
execute
Execute transaction proposal
curl --request POST \
  --url https://api.example.com/platform/admin/proposals/{proposalId}/execute
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Initiates blockchain execution of a transaction proposal that has received the required number of custodian approvals. The transaction is signed with the aggregated approvals and submitted to the blockchain network. This is the final step in the multi-approval workflow.

​
Input

  • proposalId (long, required) — The unique identifier of the approved proposal to execute.

​
Output

Returns a containing:
  • success (bool) — Indicates if execution was initiated successfully.
  • message (string) — Status message about the execution request.

​
Examples

Request 
POST /api/platform/tenant/transaction-proposals/10001/execute
Response (200 OK) 
{
  "success": true,
  "message": "Transaction proposal execution initiated successfully"
}

​
Errors

  • 400 Bad Request: Proposal ID is invalid or malformed.
  • 401 Unauthorized: Caller is not authenticated.
  • 403 Forbidden: Caller lacks permission to execute proposals.
  • 404 Not Found: Proposal with specified ID does not exist.
  • 409 Conflict: Proposal has not met approval threshold, is already executed, or has been cancelled.
  • 500 Internal Server Error: An unexpected error occurred during execution initiation.

​
Notes

Proposals must have status “Approved” and meet the approval threshold before execution. Once execution begins, the proposal cannot be cancelled. Use GetProposalExecutionStatus to monitor the blockchain transaction status after execution.

Path Parameters

​
proposalId
integer<int64>
required

The unique identifier of the transaction proposal to execute.

Query Parameters

​
api-version
string | null

Response

Proposal execution started successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.

Example:
{ "success": true }