Create archive

Archives one of the caller's notifications — read, and out of the live inbox — and answers it.

POST /v1/team/inbox/{id}/archive

Team → · All API references → · Get started →


Address	`https://api.hanzo.ai/v1/team/inbox/{id}/archive`
Method	`POST`
Operation	`post_team_inbox_by_id_archive`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Archives one of the caller's notifications — read, and out of the live inbox — and answers it. It is listed again with archived=true.

Request

3 fields, body application/json (required).

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the notification, from the path.
`id`	body	string	—	ID is the notification, from the path.
`space`	body	string	—	Space is the space uuid it was filed in.

Response

Status	Body	Meaning
`200`	team.teamInboxItem	ok
`default`	problem-details	refused

200 body — 31 fields.

Field	In	Type	Always	Description
`archived`	body	boolean	—	Archived reports that the caller archived it.
`createdOn`	body	integer (int64)	—	CreatedOn is when it was filed, unix milliseconds.
`doc`	body	string	—	Doc is the document it is about, when it is about a document.
`id`	body	string	—	ID is the notification's own id — what read and archive address.
`message`	body	team.teamMessage	—
`message.author`	body	string	—	Author is the team account uuid that wrote it.
`message.createdOn`	body	integer (int64)	—	CreatedOn is unix MILLIseconds, which is what the platform stamps.
`message.doc`	body	string	—	Doc is the document this message is a comment on.
`message.editedOn`	body	integer (int64)	—	EditedOn is when the author last edited the message, unix milliseconds.
`message.files`	body	team.teamFile[]	—	Files are the files attached to the message.
`message.files[].file`	body	string	—	File is the blob id, readable at GET /v1/team/files/{space}/{name}?file={file}.
`message.files[].id`	body	string	—	ID is the attachment document's own id.
`message.files[].name`	body	string	—	Name is the file's name as the person uploaded it.
`message.files[].size`	body	integer (int64)	—	Size is the file's length in bytes, as the uploader stated it.
`message.files[].type`	body	string	—	Type is the media type the uploader declared.
`message.id`	body	string	—	ID is the message document's own id.
`message.lastReply`	body	integer (int64)	—	LastReply is when the thread was last answered, unix milliseconds.
`message.mentions`	body	string[]	—	Mentions are the account uuids the message @-mentions — exactly the people notify.go told they were mentioned.
`message.reactions`	body	team.teamReaction[]	—	Reactions are the emoji people reacted with, one entry per emoji, in the order each emoji was first used.
`message.reactions[].accounts`	body	string[]	—	Accounts are the account uuids that reacted with it, earliest first.
`message.reactions[].count`	body	integer (int64)	—	Count is how many people reacted with it.
`message.reactions[].emoji`	body	string	—	Emoji is the reaction itself, as the person picked it.
`message.replies`	body	integer (int64)	—	Replies is how many replies the message's thread holds.
`message.room`	body	string	—	Room is the room it was said in — the same id the room listing answers with, so a caller holding a message can name its room without a second read.
`message.text`	body	string	—	Text is the message as PLAIN TEXT.
`message.thread`	body	string	—	Thread is the message this one replies to.
`read`	body	boolean	—	Read reports that the caller has seen it.
`reason`	body	string	—	Reason is why it was filed: "mention", "dm" (a direct message), "reply" (in a thread the caller is in), "comment" (on something the caller follows), "assigned", or "other".
`room`	body	string	—	Room is the room it is about, when it is about a room.
`space`	body	string	—	Space is the space uuid it was filed in.
`thread`	body	string	—	Thread is the message whose thread it is about, for a reply.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.

import { Configuration, TeamApi } from 'hanzoai';

const api = new TeamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postTeamInboxByIdArchive({ id: 'id', id: "<id>", space: "<space>" });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import TeamApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = TeamApi(client).post_team_inbox_by_id_archive(id='id', id="<id>", space="<space>")

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.TeamAPI.PostTeamInboxByIdArchive(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, team_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = team_api::post_team_inbox_by_id_archive(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.TeamApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new TeamApi(client).postTeamInboxByIdArchive();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl -X POST https://api.hanzo.ai/v1/team/inbox/<id>/archive \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "id": "<id>",
       "space": "<space>"
     }'

MCP reaches team through the team tool, which names its 18 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "get_collaborator"
         }
       }
     }'

Team API · All Hanzo APIs · Interactive reference

Request

Response

Examples

On this page