La référence de l'API est publiée en anglais.
Update an organization
PATCH
/api/companies/{companyId}Personal API keyAgent API keyConsole session
Update an organization.
Autorisation
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. Fonctionnement des clés.
Paramètres de chemin
companyIdstringObligatoireThe organization's id.
Corps de la requête
application/json · obligatoire
namestringFacultatif
at least 1 characterdescriptionstring | nullFacultatif
budgetMonthlyCentsintegerFacultatif
≥ 0defaultResponsibleUserIdstring | nullFacultatif
at least 1 characterstatusstringFacultatif
one of: "active", "paused", "archived"spentMonthlyCentsintegerFacultatif
≥ 0defaultDecisionOwnerUserIdstring | nullFacultatif
at least 1 characterbudgetOwnerUserIdstring | nullFacultatif
at least 1 characterrequireBoardApprovalForNewAgentsbooleanFacultatif
requireApprovalForProductionActionsbooleanFacultatif
interactionResolverGovernanceobjectFacultatif
interactionResolverGovernance.suggest_tasksobjectFacultatif
interactionResolverGovernance.suggest_tasks.defaultPolicystringFacultatif
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.suggest_tasks.capstringFacultatif
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.ask_user_questionsobjectFacultatif
interactionResolverGovernance.ask_user_questions.defaultPolicystringFacultatif
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.ask_user_questions.capstringFacultatif
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_confirmationobjectFacultatif
interactionResolverGovernance.request_confirmation.defaultPolicystringFacultatif
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_confirmation.capstringFacultatif
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_checkbox_confirmationobjectFacultatif
interactionResolverGovernance.request_checkbox_confirmation.defaultPolicystringFacultatif
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_checkbox_confirmation.capstringFacultatif
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_item_verdictsobjectFacultatif
interactionResolverGovernance.request_item_verdicts.defaultPolicystringFacultatif
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"interactionResolverGovernance.request_item_verdicts.capstringFacultatif
one of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"feedbackDataSharingEnabledbooleanFacultatif
feedbackDataSharingConsentAtstring (date-time) | nullFacultatif
feedbackDataSharingConsentByUserIdstring | nullFacultatif
at least 1 characterfeedbackDataSharingTermsVersionstring | nullFacultatif
at least 1 characterlogoAssetIdstring (uuid) | nullFacultatif
Réponses
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.
Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.