Skip to main content
PATCH
/
api
/
v1
/
threads
/
{threadId}
/
close
Close an SMS thread
curl --request PATCH \
  --url https://prod.featherhq.com/api/v1/threads/{threadId}/close \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reason": "<string>"
}
'
{
  "thread": {
    "id": "<string>",
    "organizationId": "<string>",
    "agentVersionId": "<string>",
    "toPhoneNumber": "<string>",
    "fromPhoneNumber": "<string>",
    "fromPhoneNumberId": "<string>",
    "leadId": "<string>",
    "isActive": true,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "closedAt": "<string>",
    "closedReason": "<string>",
    "metadata": {},
    "variables": {}
  }
}

Authorizations

X-API-Key
string
header
required

Path Parameters

threadId
string<uuid>
required

Body

application/json
reason
string

Response

Thread closed successfully

thread
object
required