Skip to main content
POST
/
v1
/
threads
/
{threadId}
/
archive
Archive thread
curl --request POST \
  --url https://capy.ai/api/v1/threads/{threadId}/archive \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "impersonateUserEmail": "jsmith@example.com"
}
'
{
  "id": "<string>"
}

Authorizations

​
Authorization
string
header
required

API token (capy_xxxx). Generate at capy.ai/settings/tokens

Path Parameters

​
threadId
string
required

Thread jam ID.

Body

application/json
​
impersonateUserEmail
string<email>
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Response

Success

​
id
string
required
​
status
enum<string>
required
Available options:
active,
idle,
archived