Skip to content
Console
On this page

Archive an inbox item

Archives an inbox item.

Archives an inbox item.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item:archive
  • Scope notify:write
  • Effect write — a successful call changes state.
  • Collection inbox_items

Request

FieldTypeWhat it is
namestringThe name of the inbox item. Required.

Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/recipients/{recipient}/inbox_items/{inbox_item}.
uidstringibx_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
messagestringThe Message that produced it. Output only.
titlestringThe rendered title. Output only.
bodystringThe rendered body. Output only.
action_uristringWhere the item links. Output only.
stateInboxItemStateRead, unread, or archived. Output only. One of unread, read, archived.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

Errors

Every error arrives in the body Errors describes.

Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item:archive" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'