paperclip_archive_company
Archive a company using its UUID, setting its status to 'archived'. Requires board-level authentication and is irreversible through the API.
Instructions
⚠ Board-only: Archive a company, setting its status to 'archived'. Uses a dedicated POST endpoint — not a PATCH. This action is irreversible through the API.
Args:
companyId: string — Company UUID to archive (example: "00000000-0000-0000-0000-000000000000")
Returns: The updated company object with status: 'archived' and updated timestamps.
Examples:
Use when: decommissioning a company that is no longer in use
Don't use when: you need to update other company fields — use paperclip_update_company for name/description/budget
Error Handling:
401: authentication failed → check PAPERCLIP_API_KEY
403: board key required → this endpoint requires board-level authentication
404: company not found → verify ID with paperclip_list_companies
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| companyId | Yes | Company UUID to archive |