Update an organization
PATCH
/api/companies/{companyId}Personal API keyAgent API keyConsole session
Update an organization.
Authorization
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.
Path parameters
companyIdstringRequiredThe organization's id.
Request body
application/json · required
namestringOptional
at least 1 characterdescriptionstring | nullOptional
budgetMonthlyCentsintegerOptional
≥ 0defaultResponsibleUserIdstring | nullOptional
at least 1 characterstatusstringOptional
one of: "active", "paused", "archived"spentMonthlyCentsintegerOptional
≥ 0defaultDecisionOwnerUserIdstring | nullOptional
at least 1 characterbudgetOwnerUserIdstring | nullOptional
at least 1 characterrequireBoardApprovalForNewAgentsbooleanOptional
requireApprovalForProductionActionsbooleanOptional
interactionResolverGovernanceobjectOptional
interactionResolverGovernance.suggest_tasksobjectOptional
interactionResolverGovernance.suggest_tasks.defaultPolicystringOptional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.suggest_tasks.capstringOptional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.ask_user_questionsobjectOptional
interactionResolverGovernance.ask_user_questions.defaultPolicystringOptional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.ask_user_questions.capstringOptional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_confirmationobjectOptional
interactionResolverGovernance.request_confirmation.defaultPolicystringOptional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_confirmation.capstringOptional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_checkbox_confirmationobjectOptional
interactionResolverGovernance.request_checkbox_confirmation.defaultPolicystringOptional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_checkbox_confirmation.capstringOptional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_item_verdictsobjectOptional
interactionResolverGovernance.request_item_verdicts.defaultPolicystringOptional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_item_verdicts.capstringOptional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"feedbackDataSharingEnabledbooleanOptional
feedbackDataSharingConsentAtstring (date-time) | nullOptional
feedbackDataSharingConsentByUserIdstring | nullOptional
at least 1 characterfeedbackDataSharingTermsVersionstring | nullOptional
at least 1 characterlogoAssetIdstring (uuid) | nullOptional
Responses
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Errors return {"error": "..."}, often with a code and details. See errors and limits.