Create a comment or reply
curl --request POST \
--url https://api.watchdog.no/v1/comments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"body": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
body: JSON.stringify('<string>')
})
};
fetch('https://api.watchdog.no/v1/comments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/comments"
payload = {
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"body": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"type": "comment",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_type": "invoice",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_comment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"body": "<string>",
"author": {
"user_id": "<string>",
"name": "<string>",
"deleted": true
},
"occurred_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"reply_count": 1
}{
"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": "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"
}
}Activity and comments
Create a comment or reply
Comments on an invoice, agreement, alert or claim as you, or replies to a top-level comment on the same record. The body is 1–5,000 characters. Not idempotent: after an uncertain response, check the timeline or replies before retrying.
Create a comment or reply
curl --request POST \
--url https://api.watchdog.no/v1/comments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"body": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
body: JSON.stringify('<string>')
})
};
fetch('https://api.watchdog.no/v1/comments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/comments"
payload = {
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"body": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"type": "comment",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_type": "invoice",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_comment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"body": "<string>",
"author": {
"user_id": "<string>",
"name": "<string>",
"deleted": true
},
"occurred_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"reply_count": 1
}{
"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": "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.
Body
application/json
Response
Created comment.
Available options:
comment Available options:
invoice, agreement, alert, claim Show child attributes
Show child attributes
Required range:
x >= 0