API referansı İngilizce yayımlanır.
Archive an organization member
POST
/api/companies/{companyId}/members/{memberId}/archivePersonal API keyConsole session
Archive an organization member.
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.
Yetkilendirme
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. Anahtarlar nasıl çalışır.
Yol parametreleri
companyIdstringZorunluThe organization's id.
memberIdstringZorunluThe member's id.
İstek gövdesi
application/json · zorunlu
reassignmentobject | nullİsteğe bağlı
reassignment.assigneeAgentIdstring (uuid) | nullİsteğe bağlı
reassignment.assigneeUserIdstring (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.