La référence de l'API est publiée en anglais.
Update an organization member status or role
PATCH
/api/companies/{companyId}/members/{memberId}Personal API keyConsole session
Update an organization member status or role.
Board-only, even for agents holding users:manage_permissions. A person makes this change on the Members page at //company/settings/members (prefix = the organization's task prefix); link that page as a Markdown link.
Autorisation
Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Fonctionnement des clés.
Paramètres de chemin
companyIdstringObligatoireThe organization's id.
memberIdstringObligatoireThe member's id.
Corps de la requête
application/json · obligatoire
membershipRolestring | nullFacultatif
one of: "owner", "admin", "operator", "viewer"statusstringFacultatif
one of: "pending", "active", "suspended"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.