Skip to main content
POST
Create a greeting

Authorizations

Authorization
string
header
required

A secret key (dk_live_…). Scopes: conversations:read, contacts:read, contacts:write, meetings:read, analytics:read, events:read, webhooks:write, knowledge:read, knowledge:write, agent:read, agent:write, experiments:read, experiments:write, privacy:write, chat:write.

Headers

Idempotency-Key
string

Retry safely: the first response is replayed for 24 hours (not for streamed answers).

Maximum string length: 255

Body

application/json
name
string

What your team calls it.

Required string length: 1 - 60
text
string

What the chat says. Put a person's details in braces with words for when the link has none: {first|there}, {company|your team}, {title}, {last}. A field with no fallback is left out with the space before it.

Required string length: 1 - 200
buttons
object[]

Up to four reply buttons. They replace the page's own; an empty list keeps the page's.

Maximum array length: 4
agent_note
string | null

What the agent should know about people you send this to, e.g. why you reached out. Fields allowed. Null or empty removes it.

Maximum string length: 500

Response

OK

id
string
required
Pattern: ^gr_
Example:

"gr_m3k8wq"

object
string
required
Allowed value: "link_greeting"
name
string
required
text
string
required
Example:

"Hi {first|there}, want to see what we could do for {company|your team}?"

buttons
object[]
required
agent_note
string | null
required

What the agent is told about people shown this greeting.

fields
string[]
required
preview
object
required

How many links use it.

Required range: -9007199254740991 <= x <= 9007199254740991
results
object
required

The last 30 days: people who opened it, how many of them chatted, and how many booked. Your team's and test visits are left out.