API referansı İngilizce yayımlanır.

Update an organization

PATCH/api/companies/{companyId}
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Update an organization.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

companyIdstringZorunluThe organization's id.

İstek gövdesi

application/json · zorunlu

namestringİsteğe bağlıat least 1 character
descriptionstring | nullİsteğe bağlı
budgetMonthlyCentsintegerİsteğe bağlı≥ 0
defaultResponsibleUserIdstring | nullİsteğe bağlıat least 1 character
statusstringİsteğe bağlıone of: "active", "paused", "archived"
spentMonthlyCentsintegerİsteğe bağlı≥ 0
defaultDecisionOwnerUserIdstring | nullİsteğe bağlıat least 1 character
budgetOwnerUserIdstring | nullİsteğe bağlıat least 1 character
requireBoardApprovalForNewAgentsbooleanİsteğe bağlı
requireApprovalForProductionActionsbooleanİsteğe bağlı
interactionResolverGovernanceobjectİsteğe bağlı
interactionResolverGovernance.suggest_tasksobjectİsteğe bağlı
interactionResolverGovernance.suggest_tasks.defaultPolicystringİsteğe bağlıone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.suggest_tasks.capstringİsteğe bağlıone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.ask_user_questionsobjectİsteğe bağlı
interactionResolverGovernance.ask_user_questions.defaultPolicystringİsteğe bağlıone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.ask_user_questions.capstringİsteğe bağlıone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_confirmationobjectİsteğe bağlı
interactionResolverGovernance.request_confirmation.defaultPolicystringİsteğe bağlıone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_confirmation.capstringİsteğe bağlıone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_checkbox_confirmationobjectİsteğe bağlı
interactionResolverGovernance.request_checkbox_confirmation.defaultPolicystringİsteğe bağlıone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_checkbox_confirmation.capstringİsteğe bağlıone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_item_verdictsobjectİsteğe bağlı
interactionResolverGovernance.request_item_verdicts.defaultPolicystringİsteğe bağlıone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
interactionResolverGovernance.request_item_verdicts.capstringİsteğe bağlıone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
feedbackDataSharingEnabledbooleanİsteğe bağlı
feedbackDataSharingConsentAtstring (date-time) | nullİsteğe bağlı
feedbackDataSharingConsentByUserIdstring | nullİsteğe bağlıat least 1 character
feedbackDataSharingTermsVersionstring | nullİsteğe bağlıat least 1 character
logoAssetIdstring (uuid) | nullİsteğe bağlı

Yanıtlar

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.

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Organizations