Skip to main content
PATCH
Update company defaults

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Path Parameters

id
string<uuid>
required

Company ID

Body

application/json

Partial update: only provided fields change. The description, requirements, instructions and ai_context fields feed the AI assistant; write factual reference data only.

email_format
string | null

Email address pattern for new users, e.g. "first.last"

Maximum string length: 500
default_email_domain
string | null

Max 500 characters; null or "" clears

Maximum string length: 500
preferred_contact_method
string | null

Max 500 characters; null or "" clears

Maximum string length: 500
standard_computer_model
string | null

Deprecated alias for standard_laptop_model

Maximum string length: 500
standard_laptop_model
string | null

Max 500 characters; null or "" clears

Maximum string length: 500
standard_desktop_model
string | null

Max 500 characters; null or "" clears

Maximum string length: 500
standard_monitor_model
string | null

Max 500 characters; null or "" clears

Maximum string length: 500
standard_keyboard_model
string | null

Max 500 characters; null or "" clears

Maximum string length: 500
standard_mouse_model
string | null

Max 500 characters; null or "" clears

Maximum string length: 500
exclude_from_global_hardware_defaults
boolean

When true, this company does not inherit tenant-wide hardware defaults

other_peripherals
string[] | null

Replaces the whole list; null clears

Maximum array length: 100
Required string length: 1 - 500
standard_software
string[] | null

Replaces the whole list; null clears

Maximum array length: 100
Required string length: 1 - 500
operating_system
string | null

Max 500 characters; null or "" clears

Maximum string length: 500
default_location
string | null

Max 500 characters; null or "" clears

Maximum string length: 500
default_office
string | null

Max 500 characters; null or "" clears

Maximum string length: 500
default_department
string | null

Max 500 characters; null or "" clears

Maximum string length: 500
default_time_zone
string | null

Max 500 characters; null or "" clears

Maximum string length: 500
business_hours
object | null

e.g. {"start":"8:00","end":"17:00","days":["Mon","Tue"]}; unknown keys are rejected; null clears

default_user_type
string | null

Max 500 characters; null or "" clears

Maximum string length: 500
onboarding_checklist
string[] | null

Replaces the whole list; null clears

Maximum array length: 100
Required string length: 1 - 500
vpn_required
boolean | null

null clears

mfa_required
boolean | null

null clears

network_access_level
string | null

Max 500 characters; null or "" clears

Maximum string length: 500
security_clearance_required
boolean | null

null clears

default_ticket_priority
string | null

Max 500 characters; null or "" clears

Maximum string length: 500
default_ticket_urgency
string | null

Max 500 characters; null or "" clears

Maximum string length: 500
default_response_time_hours
integer | null
Required range: 0 <= x <= 8760
auto_assign_tickets
boolean | null

null clears

default_assignee_group
string | null

Max 500 characters; null or "" clears

Maximum string length: 500
company_description
string | null

Max 10000 characters; null or "" clears

Maximum string length: 10000
industry_specific_requirements
string | null

Max 10000 characters; null or "" clears

Maximum string length: 10000
special_instructions
string | null

Max 10000 characters; null or "" clears

Maximum string length: 10000
ai_context
object | null

Structured AI reference data for this company (e.g. VIP users, escalation contacts). Replaces the whole object; null clears; at most 20000 serialized characters.

Response

Company defaults after the update

data
object
required