Archive a child thread in a Forward session.
HTTP 200 OK
Returns the archived Thread object.
Request headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT> |
Idempotency-Key | No | Optional idempotency key for unsafe requests. |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
session_id | string | Yes | Session ID. |
thread_id | string | Yes | Thread ID. |
Example request
Example response
HTTP 200 OK
Response fields
Returns the archived Thread object.
Errors
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 401 | authentication_error | authentication_required | PAT invalid or expired. |
| 404 | not_found_error | session_not_found | Session does not exist. |
| 404 | not_found_error | thread_not_found | Thread does not exist or does not belong to the Session. |
| 409 | conflict_error | coordinator_thread_not_archivable | Caller attempted to archive the coordinator thread. |
| 409 | conflict_error | thread_not_idle | Thread is not idle. |
Notes
- Only
role=childandstatus=idlethreads are archivable. - The response uses the filtered Forward Thread object.