Update an organization
curl --request PATCH \
--url https://api.watchdog.no/v1/organization \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"settings": {
"currency": "<string>",
"timezone": "<string>",
"require_mfa": true,
"allowed_invite_domains": [
"<string>"
],
"agreement_defaults": {
"alerts": {
"flag_undercharges": true,
"flag_uncovered_items": true
}
},
"subprocessor_opt_outs": [
"typesafe"
]
}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
settings: {
currency: '<string>',
timezone: '<string>',
require_mfa: true,
allowed_invite_domains: ['<string>'],
agreement_defaults: {alerts: {flag_undercharges: true, flag_uncovered_items: true}},
subprocessor_opt_outs: ['typesafe']
}
})
};
fetch('https://api.watchdog.no/v1/organization', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/organization"
payload = { "settings": {
"currency": "<string>",
"timezone": "<string>",
"require_mfa": True,
"allowed_invite_domains": ["<string>"],
"agreement_defaults": { "alerts": {
"flag_undercharges": True,
"flag_uncovered_items": True
} },
"subprocessor_opt_outs": ["typesafe"]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"logo_url": "<string>",
"email_slug": "<string>",
"settings": {
"currency": "<string>",
"timezone": "<string>",
"language": "en",
"require_mfa": true,
"allowed_invite_domains": [
"<string>"
],
"agreement_defaults": {
"alerts": {
"flag_undercharges": true,
"flag_uncovered_items": true
}
},
"subprocessor_opt_outs": [
"typesafe"
],
"conversion_workflow": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "queued"
}
},
"onboarding_complete": true,
"access": {
"role": "admin",
"configured_level": "read",
"effective_level": "read"
},
"members_count": 1,
"capabilities": {
"can_delete": true,
"can_manage_members": true,
"supported_roles": [
"admin"
]
},
"member_limit": 123
}{
"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 operation conflicts with the current organization state. Refresh before retrying.",
"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"
}
}Organizations
Update an organization
Updates the name, slug or settings; omitted fields are unchanged. Changing the currency starts a conversion run, shown in settings.conversion_workflow; saving the same currency again retries a failed conversion.
Update an organization
curl --request PATCH \
--url https://api.watchdog.no/v1/organization \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"settings": {
"currency": "<string>",
"timezone": "<string>",
"require_mfa": true,
"allowed_invite_domains": [
"<string>"
],
"agreement_defaults": {
"alerts": {
"flag_undercharges": true,
"flag_uncovered_items": true
}
},
"subprocessor_opt_outs": [
"typesafe"
]
}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
settings: {
currency: '<string>',
timezone: '<string>',
require_mfa: true,
allowed_invite_domains: ['<string>'],
agreement_defaults: {alerts: {flag_undercharges: true, flag_uncovered_items: true}},
subprocessor_opt_outs: ['typesafe']
}
})
};
fetch('https://api.watchdog.no/v1/organization', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/organization"
payload = { "settings": {
"currency": "<string>",
"timezone": "<string>",
"require_mfa": True,
"allowed_invite_domains": ["<string>"],
"agreement_defaults": { "alerts": {
"flag_undercharges": True,
"flag_uncovered_items": True
} },
"subprocessor_opt_outs": ["typesafe"]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"logo_url": "<string>",
"email_slug": "<string>",
"settings": {
"currency": "<string>",
"timezone": "<string>",
"language": "en",
"require_mfa": true,
"allowed_invite_domains": [
"<string>"
],
"agreement_defaults": {
"alerts": {
"flag_undercharges": true,
"flag_uncovered_items": true
}
},
"subprocessor_opt_outs": [
"typesafe"
],
"conversion_workflow": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "queued"
}
},
"onboarding_complete": true,
"access": {
"role": "admin",
"configured_level": "read",
"effective_level": "read"
},
"members_count": 1,
"capabilities": {
"can_delete": true,
"can_manage_members": true,
"supported_roles": [
"admin"
]
},
"member_limit": 123
}{
"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 operation conflicts with the current organization state. Refresh before retrying.",
"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
The updated organization.
Required string length:
1 - 255Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required range:
x >= 0Show child attributes
Show child attributes
Maximum number of members. Null means unlimited; omitted when not yet known.