La referencia de la API se publica en inglés.

Update an organization

PATCH/api/companies/{companyId}
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

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

namestringOpcionalat least 1 character
descriptionstring | nullOpcional
budgetMonthlyCentsintegerOpcional≥ 0
defaultResponsibleUserIdstring | nullOpcionalat least 1 character
statusstringOpcionalone of: "active", "paused", "archived"
spentMonthlyCentsintegerOpcional≥ 0
defaultDecisionOwnerUserIdstring | nullOpcionalat least 1 character
budgetOwnerUserIdstring | nullOpcionalat least 1 character
requireBoardApprovalForNewAgentsbooleanOpcional
requireApprovalForProductionActionsbooleanOpcional
interactionResolverGovernanceobjectOpcional
interactionResolverGovernance.suggest_tasksobjectOpcional
interactionResolverGovernance.suggest_tasks.defaultPolicystringOpcionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.suggest_tasks.capstringOpcionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.ask_user_questionsobjectOpcional
interactionResolverGovernance.ask_user_questions.defaultPolicystringOpcionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.ask_user_questions.capstringOpcionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_confirmationobjectOpcional
interactionResolverGovernance.request_confirmation.defaultPolicystringOpcionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_confirmation.capstringOpcionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_checkbox_confirmationobjectOpcional
interactionResolverGovernance.request_checkbox_confirmation.defaultPolicystringOpcionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_checkbox_confirmation.capstringOpcionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_item_verdictsobjectOpcional
interactionResolverGovernance.request_item_verdicts.defaultPolicystringOpcionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_item_verdicts.capstringOpcionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
feedbackDataSharingEnabledbooleanOpcional
feedbackDataSharingConsentAtstring (date-time) | nullOpcional
feedbackDataSharingConsentByUserIdstring | nullOpcionalat least 1 character
feedbackDataSharingTermsVersionstring | nullOpcionalat least 1 character
logoAssetIdstring (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.

Organizations