Archive an organization member

POST/api/companies/{companyId}/members/{memberId}/archive
Personal API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

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.

Authorization

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. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.
memberIdstringRequiredThe member's id.

Request body

application/json · required

reassignmentobject | nullOptional
reassignment.assigneeAgentIdstring (uuid) | nullOptional
reassignment.assigneeUserIdstring (uuid) | nullOptional

Responses

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.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Members, invites and keys