Set/update operation metadata
Upsert: paymentPurpose, category (validated code), tags, description, external references and business links (dealId/invoiceId/orderId/settlementId/obligationId). Each change increments version.
curl -X PATCH "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/operations/deposit/example_string/metadata" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"paymentPurpose": "example_string",
"category": "invoice_payment",
"tags": [
"example_string"
],
"description": "example_string",
"externalReference": "example_string",
"clientReference": "example_string",
"dealId": "example_string",
"invoiceId": "example_string",
"orderId": "example_string",
"settlementId": "example_string",
"obligationId": "example_string"
}'
import requests
import json
url = "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/operations/deposit/example_string/metadata"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"paymentPurpose": "example_string",
"category": "invoice_payment",
"tags": [
"example_string"
],
"description": "example_string",
"externalReference": "example_string",
"clientReference": "example_string",
"dealId": "example_string",
"invoiceId": "example_string",
"orderId": "example_string",
"settlementId": "example_string",
"obligationId": "example_string"
}
response = requests.patch(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/operations/deposit/example_string/metadata", {
method: "PATCH",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"paymentPurpose": "example_string",
"category": "invoice_payment",
"tags": [
"example_string"
],
"description": "example_string",
"externalReference": "example_string",
"clientReference": "example_string",
"dealId": "example_string",
"invoiceId": "example_string",
"orderId": "example_string",
"settlementId": "example_string",
"obligationId": "example_string"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"paymentPurpose": "example_string",
"category": "invoice_payment",
"tags": [
"example_string"
],
"description": "example_string",
"externalReference": "example_string",
"clientReference": "example_string",
"dealId": "example_string",
"invoiceId": "example_string",
"orderId": "example_string",
"settlementId": "example_string",
"obligationId": "example_string"
}`)
req, err := http.NewRequest("PATCH", "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/operations/deposit/example_string/metadata", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/operations/deposit/example_string/metadata')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"paymentPurpose": "example_string",
"category": "invoice_payment",
"tags": [
"example_string"
],
"description": "example_string",
"externalReference": "example_string",
"clientReference": "example_string",
"dealId": "example_string",
"invoiceId": "example_string",
"orderId": "example_string",
"settlementId": "example_string",
"obligationId": "example_string"
}'
response = http.request(request)
puts response.body
{
"id": "cmr3f41z20001psp7phmyapw3",
"vaultId": "example_string",
"operationType": "deposit",
"operationId": "example_string",
"paymentPurpose": "example_string",
"category": "example_string",
"tagsJson": [
"example_string"
],
"description": "example_string",
"externalReference": "example_string",
"clientReference": "example_string",
"dealId": "example_string",
"invoiceId": "example_string",
"orderId": "example_string",
"settlementId": "example_string",
"obligationId": "example_string",
"version": 42,
"createdById": "example_string",
"updatedById": "example_string",
"createdAt": "2026-07-02T11:25:15.134000Z",
"updatedAt": "2026-07-02T11:25:15.134000Z"
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
/api/v1/vaults/{code}/operations/{operationType}/{operationId}/metadataTarget server for requests. Edit to use your own host.
Session token. Mobile/services. The web uses a cookie.
API key (sent in cookie)
Unique Vault code (slug)
The media type of the request body
Validated string code (the list is extensible)
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Session token. Mobile/services. The web uses a cookie.
API Key for authentication. Provide your API key in the cookie.
Path Parameters
deposittransferBody
Validated string code (the list is extensible)
Responses
cuid
deposittransferCategory code (built-in: invoice_payment, advance, refund, asset_purchase, asset_sale, debt_repayment, deposit, withdrawal, internal_transfer, adjustment, unknown)