Skip to main content
POST
/
api
/
v1
/
threads
Create a new SMS thread
curl --request POST \
  --url https://prod.featherhq.com/api/v1/threads \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "agentVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "toPhoneNumber": "<string>",
  "fromPhoneNumber": "<string>",
  "fromPhoneNumberId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "initialMessage": "<string>",
  "leadId": "<string>",
  "metadata": {},
  "variables": {}
}
'
{
  "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

Body

application/json
agentVersionId
string<uuid>
required
toPhoneNumber
string
required
fromPhoneNumber
string
required
fromPhoneNumberId
string<uuid>
required
initialMessage
string
leadId
string
metadata
object
variables
object

Response

Thread created successfully

thread
object
required