curl --request PATCH \
--url https://api.watchdog.no/v1/integrations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"enabled": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', enabled: true})
};
fetch('https://api.watchdog.no/v1/integrations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/integrations/{id}"
payload = {
"name": "<string>",
"enabled": True
}
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",
"provider": "<string>",
"name": "<string>",
"status": "connected",
"syncable": true,
"enabled": true,
"auto_sync": true,
"capture": {
"enabled": true,
"cadence": "daily",
"timezone": "<string>",
"last_captured_at": "2023-11-07T05:31:56Z"
},
"scope": {
"suppliers": {
"mode": "all",
"items": [
{
"id": "<string>",
"name": "<string>",
"code": "<string>",
"group": {
"kind": "vendor-sites",
"prefixes": [
"<string>"
],
"site_count": 123,
"inactive_site_count": 1
}
}
],
"include_unidentified": true
},
"companies": [
{
"id": "<string>",
"name": "<string>",
"country_code": "<string>",
"accounting_currency_code": "<string>"
}
],
"processing_statuses": [
"<string>"
],
"module_company_codes": {
"costinvoice": [
"<string>"
],
"purchaseorder": [
"<string>"
]
}
},
"credentials": {
"values": {},
"secrets_set": [
"<string>"
]
},
"realtime": {
"supported": true,
"status": "active"
},
"rate_limited_until": "2023-11-07T05:31:56Z",
"last_successful_sync": {
"started_at": "2023-11-07T05:31:56Z",
"trigger": "manual"
},
"active_sync_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"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": "sync_in_progress",
"message": "A sync is running (workflow_run_id names it), auto_sync needs an enabled and tested integration, or the name is taken.",
"request_id": "req_example"
}
}{
"error": {
"code": "precondition_failed",
"message": "The resource changed since the ETag in If-Match was read. Nothing changed; read it again and retry.",
"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"
}
}Update an integration
Updates any of name, enabled, auto_sync, scope, capture settings and credentials. Send the ETag as If-Match; if the integration changed since, the request fails with 412. Scope and credentials cannot change while a sync runs: cancel the run named in the 409 first. Changing them cancels a running estimate.
curl --request PATCH \
--url https://api.watchdog.no/v1/integrations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"enabled": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', enabled: true})
};
fetch('https://api.watchdog.no/v1/integrations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/integrations/{id}"
payload = {
"name": "<string>",
"enabled": True
}
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",
"provider": "<string>",
"name": "<string>",
"status": "connected",
"syncable": true,
"enabled": true,
"auto_sync": true,
"capture": {
"enabled": true,
"cadence": "daily",
"timezone": "<string>",
"last_captured_at": "2023-11-07T05:31:56Z"
},
"scope": {
"suppliers": {
"mode": "all",
"items": [
{
"id": "<string>",
"name": "<string>",
"code": "<string>",
"group": {
"kind": "vendor-sites",
"prefixes": [
"<string>"
],
"site_count": 123,
"inactive_site_count": 1
}
}
],
"include_unidentified": true
},
"companies": [
{
"id": "<string>",
"name": "<string>",
"country_code": "<string>",
"accounting_currency_code": "<string>"
}
],
"processing_statuses": [
"<string>"
],
"module_company_codes": {
"costinvoice": [
"<string>"
],
"purchaseorder": [
"<string>"
]
}
},
"credentials": {
"values": {},
"secrets_set": [
"<string>"
]
},
"realtime": {
"supported": true,
"status": "active"
},
"rate_limited_until": "2023-11-07T05:31:56Z",
"last_successful_sync": {
"started_at": "2023-11-07T05:31:56Z",
"trigger": "manual"
},
"active_sync_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"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": "sync_in_progress",
"message": "A sync is running (workflow_run_id names it), auto_sync needs an enabled and tested integration, or the name is taken.",
"request_id": "req_example"
}
}{
"error": {
"code": "precondition_failed",
"message": "The resource changed since the ETag in If-Match was read. Nothing changed; read it again and retry.",
"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.
Optional ETag from your last read or edit. If the resource changed since, the request fails with 412 and nothing changes.
1 - 4096Path Parameters
Body
1 - 120Show child attributes
Show child attributes
Show child attributes
Show child attributes
Merge patch: omitted fields keep their saved value and null clears an optional field. Changing credentials resets status to not_tested.
Show child attributes
Show child attributes
Response
The resource.
Result of the latest test or sync. not_tested until the first test.
connected, invalid_credentials, permission_denied, server_error, not_tested Enabled and in a status that allows a sync to start.
Automatic invoice import: after capture for SFTP, otherwise nightly and through supported webhooks.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Secret values are never returned.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The provider asked Watchdog to pause requests until this time.
Latest sync that completed with full coverage.
Show child attributes
Show child attributes