La referencia de la API se publica en inglés.
Update an organization
PATCH
/api/companies/{companyId}Personal API keyAgent API keyConsole session
Update an organization.
Autorización
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. Cómo funcionan las claves.
Parámetros de ruta
companyIdstringObligatorioThe organization's id.
Cuerpo de la solicitud
application/json · obligatorio
namestringOpcional
at least 1 characterdescriptionstring | nullOpcional
budgetMonthlyCentsintegerOpcional
≥ 0defaultResponsibleUserIdstring | nullOpcional
at least 1 characterstatusstringOpcional
one of: "active", "paused", "archived"spentMonthlyCentsintegerOpcional
≥ 0defaultDecisionOwnerUserIdstring | nullOpcional
at least 1 characterbudgetOwnerUserIdstring | nullOpcional
at least 1 characterrequireBoardApprovalForNewAgentsbooleanOpcional
requireApprovalForProductionActionsbooleanOpcional
interactionResolverGovernanceobjectOpcional
interactionResolverGovernance.suggest_tasksobjectOpcional
interactionResolverGovernance.suggest_tasks.defaultPolicystringOpcional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.suggest_tasks.capstringOpcional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.ask_user_questionsobjectOpcional
interactionResolverGovernance.ask_user_questions.defaultPolicystringOpcional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.ask_user_questions.capstringOpcional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_confirmationobjectOpcional
interactionResolverGovernance.request_confirmation.defaultPolicystringOpcional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_confirmation.capstringOpcional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_checkbox_confirmationobjectOpcional
interactionResolverGovernance.request_checkbox_confirmation.defaultPolicystringOpcional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_checkbox_confirmation.capstringOpcional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_item_verdictsobjectOpcional
interactionResolverGovernance.request_item_verdicts.defaultPolicystringOpcional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_item_verdicts.capstringOpcional
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"feedbackDataSharingEnabledbooleanOpcional
feedbackDataSharingConsentAtstring (date-time) | nullOpcional
feedbackDataSharingConsentByUserIdstring | nullOpcional
at least 1 characterfeedbackDataSharingTermsVersionstring | nullOpcional
at least 1 characterlogoAssetIdstring (uuid) | nullOpcional
Respuestas
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.
Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.