Edit a claim title
curl --request PATCH \
--url http://localhost:3500/v1/claims/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({title: '<string>'})
};
fetch('http://localhost:3500/v1/claims/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/claims/{id}"
payload = { "title": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agreement": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"suppliers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"title": "<string>",
"status": "pending",
"creator": {
"user_id": "<string>",
"label": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"refund_summary": {
"refund_count": 123,
"amount_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"summary": {
"total": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"pending": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"claimed": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"credited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"dismissed": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
}
}
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "The claim is locked, the selected membership changed, or the operation is incompatible.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Claims
Edit a claim title
Only title is editable. Null clears the title; omission and an unchanged title are no-ops. Agreement and status cannot be edited here. Commands serialize with other claim writes; no client revision is required.
Edit a claim title
curl --request PATCH \
--url http://localhost:3500/v1/claims/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({title: '<string>'})
};
fetch('http://localhost:3500/v1/claims/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/claims/{id}"
payload = { "title": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agreement": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"suppliers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"title": "<string>",
"status": "pending",
"creator": {
"user_id": "<string>",
"label": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"refund_summary": {
"refund_count": 123,
"amount_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"summary": {
"total": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"pending": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"claimed": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"credited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"dismissed": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
}
}
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "The claim is locked, the selected membership changed, or the operation is incompatible.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Authorizations
ApiKeyBearerClerkSessionBearer
Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.
Headers
Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.
Path Parameters
Body
application/json
Required string length:
1 - 200Response
The canonical claim with current counts and amounts.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
pending, in_progress, completed, cancelled Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes