Справочник API публикуется на английском языке.

Update an organization

PATCH/api/companies/{companyId}
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Update an organization.

Авторизация

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. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.

Тело запроса

application/json · обязательно

namestringНеобязательныйat least 1 character
descriptionstring | nullНеобязательный
budgetMonthlyCentsintegerНеобязательный≥ 0
defaultResponsibleUserIdstring | nullНеобязательныйat least 1 character
statusstringНеобязательныйone of: "active", "paused", "archived"
spentMonthlyCentsintegerНеобязательный≥ 0
defaultDecisionOwnerUserIdstring | nullНеобязательныйat least 1 character
budgetOwnerUserIdstring | nullНеобязательныйat least 1 character
requireBoardApprovalForNewAgentsbooleanНеобязательный
requireApprovalForProductionActionsbooleanНеобязательный
interactionResolverGovernanceobjectНеобязательный
interactionResolverGovernance.suggest_tasksobjectНеобязательный
interactionResolverGovernance.suggest_tasks.defaultPolicystringНеобязательныйone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.suggest_tasks.capstringНеобязательныйone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.ask_user_questionsobjectНеобязательный
interactionResolverGovernance.ask_user_questions.defaultPolicystringНеобязательныйone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.ask_user_questions.capstringНеобязательныйone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_confirmationobjectНеобязательный
interactionResolverGovernance.request_confirmation.defaultPolicystringНеобязательныйone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_confirmation.capstringНеобязательныйone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_checkbox_confirmationobjectНеобязательный
interactionResolverGovernance.request_checkbox_confirmation.defaultPolicystringНеобязательныйone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_checkbox_confirmation.capstringНеобязательныйone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_item_verdictsobjectНеобязательный
interactionResolverGovernance.request_item_verdicts.defaultPolicystringНеобязательныйone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_item_verdicts.capstringНеобязательныйone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
feedbackDataSharingEnabledbooleanНеобязательный
feedbackDataSharingConsentAtstring (date-time) | nullНеобязательный
feedbackDataSharingConsentByUserIdstring | nullНеобязательныйat least 1 character
feedbackDataSharingTermsVersionstring | nullНеобязательныйat least 1 character
logoAssetIdstring (uuid) | nullНеобязательный

Ответы

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.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Organizations