Update an organization

PATCH/api/companies/{companyId}
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

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

namestringOptionalat least 1 character
descriptionstring | nullOptional
budgetMonthlyCentsintegerOptional≥ 0
defaultResponsibleUserIdstring | nullOptionalat least 1 character
statusstringOptionalone of: "active", "paused", "archived"
spentMonthlyCentsintegerOptional≥ 0
defaultDecisionOwnerUserIdstring | nullOptionalat least 1 character
budgetOwnerUserIdstring | nullOptionalat least 1 character
requireBoardApprovalForNewAgentsbooleanOptional
requireApprovalForProductionActionsbooleanOptional
interactionResolverGovernanceobjectOptional
interactionResolverGovernance.suggest_tasksobjectOptional
interactionResolverGovernance.suggest_tasks.defaultPolicystringOptionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.suggest_tasks.capstringOptionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.ask_user_questionsobjectOptional
interactionResolverGovernance.ask_user_questions.defaultPolicystringOptionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.ask_user_questions.capstringOptionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_confirmationobjectOptional
interactionResolverGovernance.request_confirmation.defaultPolicystringOptionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_confirmation.capstringOptionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_checkbox_confirmationobjectOptional
interactionResolverGovernance.request_checkbox_confirmation.defaultPolicystringOptionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_checkbox_confirmation.capstringOptionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_item_verdictsobjectOptional
interactionResolverGovernance.request_item_verdicts.defaultPolicystringOptionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_item_verdicts.capstringOptionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
feedbackDataSharingEnabledbooleanOptional
feedbackDataSharingConsentAtstring (date-time) | nullOptional
feedbackDataSharingConsentByUserIdstring | nullOptionalat least 1 character
feedbackDataSharingTermsVersionstring | nullOptionalat least 1 character
logoAssetIdstring (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.

Organizations