Update a claim
curl --request PATCH \
--url https://api-canary.watchdog.no/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('https://api-canary.watchdog.no/v1/claims/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-canary.watchdog.no/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>",
"deleted": true
},
"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>"
}
]
},
"by_verdict": {
"pending": {
"credited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"uncredited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
}
},
"accepted": {
"credited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"uncredited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
}
},
"dismissed": {
"credited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"uncredited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
}
}
}
}
}{
"error": {
"code": "validation_error",
"message": "The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "The bearer token is missing or invalid.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.",
"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 completed and locked, or the change is not allowed in its current status.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Wait for the Retry-After delay before retrying.",
"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": "Temporarily unavailable. Retry after the Retry-After delay, when provided.",
"request_id": "req_example"
}
}Claims
Update a claim
Updates the title and status in one transaction. Null clears the title. A completed claim cannot be cancelled directly; reopen it first. Cancelling dismisses pending and accepted verdicts, including credited members; credit is kept. Reopening does not change alert verdicts.
Update a claim
curl --request PATCH \
--url https://api-canary.watchdog.no/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('https://api-canary.watchdog.no/v1/claims/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-canary.watchdog.no/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>",
"deleted": true
},
"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>"
}
]
},
"by_verdict": {
"pending": {
"credited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"uncredited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
}
},
"accepted": {
"credited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"uncredited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
}
},
"dismissed": {
"credited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"uncredited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
}
}
}
}
}{
"error": {
"code": "validation_error",
"message": "The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "The bearer token is missing or invalid.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.",
"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 completed and locked, or the change is not allowed in its current status.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Wait for the Retry-After delay before retrying.",
"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": "Temporarily unavailable. Retry after the Retry-After delay, when provided.",
"request_id": "req_example"
}
}Authorizations
Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).
Headers
The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.
Path Parameters
Body
application/json
Response
The claim with its 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