Archive an inbox item
Remove one inbox group from your inbox (it is marked read too), up to the `through` of the read you saw it in. Only your inbox changes.
bearerAuthorizationBearer <API key or OAuth token>An organization API key (ink_live_…, ADR-0124), or the OAuth access token a person's AI client gets from the Recruiter MCP sign-in. Only the Authorization header is accepted.
Idempotency-Key?stringMakes a write safe to repeat: the same key and input return the first result. Required for agents' writes and for anything a person confirms.
^[A-Za-z0-9._:-]+$8 <= length <= 128application/json- body
input*confirmation?stringThe id from a confirm or awaiting_approval Outcome, sent with the same input and key to go ahead.
Done. A replay of the same key and input omits output.
application/json- response
status*unknownoutput?actionId*stringcurl -X POST 'https://www.invyte.ai/api/recruiter/v1/operations/inbox.archive' \ -H 'Content-Type: application/json' \ -d '{ "input": { "groupKey": "string", "through": "string" }}'{ "status": "done", "output": {}, "actionId": "string"}Record that a person asked us to stop POST
The thread's person asked not to be contacted again ("please stop emailing me"): nothing more goes on the thread, and the opt-out reaches every other sender. An applicant stops getting this Job's application emails and can't be nudged; someone with no Application is no longer emailed about roles. Use only when the person said so themselves.
Read your inbox POST
Your inbox, newest first, a page at a time (20 by default, at most 50): each group says what happened and on which Job or candidate. Pass `nextCursor` for the next page. To mark read or archive, pass an item's `groupKey` and the `through` this read returned.