Skip to main content
POST
/
v1
/
api
/
conversations
/
{id}
/
nudge
Nudge a conversation
curl --request POST \
  --url https://api.hq.zone/v1/api/conversations/{id}/nudge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>"
}
'
{
  "buffered": true,
  "pending_count": 1
}

Authorizations

​
Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Path Parameters

​
id
string<uuid>
required

Conversation id

Body

application/json
​
text
string
required

Response

Nudge buffered for the in-flight turn

​
buffered
boolean
required
​
pending_count
integer
required
Required range: x >= 0