Partially update your company (PATCH)
curl --request PATCH \
--url https://paradigm.lighton.ai/api/v3/company \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"min_password_length": 2,
"max_password_length": 2,
"kg_tags_enabled": true,
"kg_summaries_enabled": true,
"kg_queries_enabled": true,
"is_telemetry_enabled": true,
"is_telemetry_ids_allowed": true
}
'import requests
url = "https://paradigm.lighton.ai/api/v3/company"
payload = {
"name": "<string>",
"min_password_length": 2,
"max_password_length": 2,
"kg_tags_enabled": True,
"kg_summaries_enabled": True,
"kg_queries_enabled": True,
"is_telemetry_enabled": True,
"is_telemetry_ids_allowed": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
min_password_length: 2,
max_password_length: 2,
kg_tags_enabled: true,
kg_summaries_enabled: true,
kg_queries_enabled: true,
is_telemetry_enabled: true,
is_telemetry_ids_allowed: true
})
};
fetch('https://paradigm.lighton.ai/api/v3/company', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": 123,
"name": "<string>",
"allow_company_admins_to_manage_sso": true,
"created_at": "2023-11-07T05:31:56Z",
"dpo_email": "jsmith@example.com",
"max_users": -1,
"auto_provision_external_users": true,
"storage_limit_company_ws": -1,
"storage_limit_personal_ws": -1,
"storage_limit_custom_ws": -1,
"login_method": "password",
"min_password_length": 16383,
"max_password_length": 16383,
"kg_tags_enabled": true,
"kg_summaries_enabled": true,
"kg_queries_enabled": true,
"tier": "free",
"is_telemetry_enabled": true,
"is_telemetry_ids_allowed": true
}{
"id": null,
"code": 401,
"error": "unauthorized",
"detail": "Authentication credentials were not provided or are invalid.",
"doc_url": "https://developers.lighton.ai/errors#unauthorized"
}{
"id": null,
"code": 403,
"error": "insufficient_permissions",
"detail": "You do not have permission to perform this action.",
"doc_url": "https://developers.lighton.ai/errors#insufficient_permissions"
}{
"id": null,
"code": 409,
"error": "conflict",
"detail": "A resource with this name already exists.",
"doc_url": "https://developers.lighton.ai/errors#conflict"
}{
"id": null,
"code": 422,
"error": "validation_error",
"detail": "One or more fields failed validation.",
"doc_url": "https://developers.lighton.ai/errors#validation_error",
"fields": {
"<field_name>": [
{
"error": "required",
"detail": "This field is required."
}
]
}
}{
"detail": "System is under maintenance.",
"error": "service_maintenance",
"mode": "full_shutdown",
"reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"endpoint_category_names": [
"<string>"
]
}Companies
Partially update your company (PATCH)
This endpoint partially updates the authenticated user’s own company.
It takes no company identifier — the company is resolved from the caller, so no other company can be addressed. Only the fields a Company Admin may change are accepted: name, the password policy (min_password_length, max_password_length), the Knowledge Graph toggles and telemetry consent (is_telemetry_enabled, is_telemetry_ids_allowed). Any other company field must be changed through the instance-level company endpoint.
Fields outside that set are rejected rather than silently ignored.
Access levels:
- Company Admin: Can update their own company
- SysAdmin/Account Manager: Can update their own company through this endpoint too, and any company through the instance-level endpoint
Company name must be unique.
PATCH
/
api
/
v3
/
company
Partially update your company (PATCH)
curl --request PATCH \
--url https://paradigm.lighton.ai/api/v3/company \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"min_password_length": 2,
"max_password_length": 2,
"kg_tags_enabled": true,
"kg_summaries_enabled": true,
"kg_queries_enabled": true,
"is_telemetry_enabled": true,
"is_telemetry_ids_allowed": true
}
'import requests
url = "https://paradigm.lighton.ai/api/v3/company"
payload = {
"name": "<string>",
"min_password_length": 2,
"max_password_length": 2,
"kg_tags_enabled": True,
"kg_summaries_enabled": True,
"kg_queries_enabled": True,
"is_telemetry_enabled": True,
"is_telemetry_ids_allowed": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
min_password_length: 2,
max_password_length: 2,
kg_tags_enabled: true,
kg_summaries_enabled: true,
kg_queries_enabled: true,
is_telemetry_enabled: true,
is_telemetry_ids_allowed: true
})
};
fetch('https://paradigm.lighton.ai/api/v3/company', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": 123,
"name": "<string>",
"allow_company_admins_to_manage_sso": true,
"created_at": "2023-11-07T05:31:56Z",
"dpo_email": "jsmith@example.com",
"max_users": -1,
"auto_provision_external_users": true,
"storage_limit_company_ws": -1,
"storage_limit_personal_ws": -1,
"storage_limit_custom_ws": -1,
"login_method": "password",
"min_password_length": 16383,
"max_password_length": 16383,
"kg_tags_enabled": true,
"kg_summaries_enabled": true,
"kg_queries_enabled": true,
"tier": "free",
"is_telemetry_enabled": true,
"is_telemetry_ids_allowed": true
}{
"id": null,
"code": 401,
"error": "unauthorized",
"detail": "Authentication credentials were not provided or are invalid.",
"doc_url": "https://developers.lighton.ai/errors#unauthorized"
}{
"id": null,
"code": 403,
"error": "insufficient_permissions",
"detail": "You do not have permission to perform this action.",
"doc_url": "https://developers.lighton.ai/errors#insufficient_permissions"
}{
"id": null,
"code": 409,
"error": "conflict",
"detail": "A resource with this name already exists.",
"doc_url": "https://developers.lighton.ai/errors#conflict"
}{
"id": null,
"code": 422,
"error": "validation_error",
"detail": "One or more fields failed validation.",
"doc_url": "https://developers.lighton.ai/errors#validation_error",
"fields": {
"<field_name>": [
{
"error": "required",
"detail": "This field is required."
}
]
}
}{
"detail": "System is under maintenance.",
"error": "service_maintenance",
"mode": "full_shutdown",
"reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"endpoint_category_names": [
"<string>"
]
}Authorizations
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Response
Company updated successfully
Serializer for detailed company view