Change a greeting
curl --request PATCH \
--url https://api.meetdarwin.ai/v1/greetings/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"page": "<string>",
"show_to": [
{
"values": []
}
],
"name": "<string>",
"text": "<string>",
"buttons": [
{
"label": "<string>",
"message": "<string>"
}
],
"agent_note": "<string>",
"outcome": "<string>",
"end_test": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
page: '<string>',
show_to: [{values: []}],
name: '<string>',
text: '<string>',
buttons: [{label: '<string>', message: '<string>'}],
agent_note: '<string>',
outcome: '<string>',
end_test: true
})
};
fetch('https://api.meetdarwin.ai/v1/greetings/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.meetdarwin.ai/v1/greetings/{id}"
payload = {
"page": "<string>",
"show_to": [{ "values": [] }],
"name": "<string>",
"text": "<string>",
"buttons": [
{
"label": "<string>",
"message": "<string>"
}
],
"agent_note": "<string>",
"outcome": "<string>",
"end_test": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "gr_yjh2jw",
"object": "greeting",
"type": "page",
"name": "<string>",
"text": "Comparing plans? Give me a rough count of meetings a month and I'll find your cheapest fit.",
"buttons": [
{
"label": "<string>",
"message": "<string>"
}
],
"agent_note": "<string>",
"outcome": "<string>",
"page": "<string>",
"links": [
"<string>"
],
"show_to": [
{
"field": "<string>",
"op": "<string>",
"values": [
"<string>"
]
}
],
"audience": "Page is any of /pricing",
"stays": "match",
"status": "live",
"testing": "auto",
"position": 0,
"created_by_darwin": true,
"test": {
"id": "<string>",
"name": "<string>",
"status": "<string>",
"unit": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}Greetings
Change a greeting
Requires the agent:write scope.
Omit what should stay. Changing the words, buttons or audience of a greeting under test is refused (409) unless end_test is true, which ends the test first and keeps its results. status live restores an archived greeting. The website default takes words, buttons and testing, not an audience.
PATCH
/
greetings
/
{id}
Change a greeting
curl --request PATCH \
--url https://api.meetdarwin.ai/v1/greetings/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"page": "<string>",
"show_to": [
{
"values": []
}
],
"name": "<string>",
"text": "<string>",
"buttons": [
{
"label": "<string>",
"message": "<string>"
}
],
"agent_note": "<string>",
"outcome": "<string>",
"end_test": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
page: '<string>',
show_to: [{values: []}],
name: '<string>',
text: '<string>',
buttons: [{label: '<string>', message: '<string>'}],
agent_note: '<string>',
outcome: '<string>',
end_test: true
})
};
fetch('https://api.meetdarwin.ai/v1/greetings/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.meetdarwin.ai/v1/greetings/{id}"
payload = {
"page": "<string>",
"show_to": [{ "values": [] }],
"name": "<string>",
"text": "<string>",
"buttons": [
{
"label": "<string>",
"message": "<string>"
}
],
"agent_note": "<string>",
"outcome": "<string>",
"end_test": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "gr_yjh2jw",
"object": "greeting",
"type": "page",
"name": "<string>",
"text": "Comparing plans? Give me a rough count of meetings a month and I'll find your cheapest fit.",
"buttons": [
{
"label": "<string>",
"message": "<string>"
}
],
"agent_note": "<string>",
"outcome": "<string>",
"page": "<string>",
"links": [
"<string>"
],
"show_to": [
{
"field": "<string>",
"op": "<string>",
"values": [
"<string>"
]
}
],
"audience": "Page is any of /pricing",
"stays": "match",
"status": "live",
"testing": "auto",
"position": 0,
"created_by_darwin": true,
"test": {
"id": "<string>",
"name": "<string>",
"status": "<string>",
"unit": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}Authorizations
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
Retry safely: the first response is replayed for 24 hours (not for streamed answers).
Maximum string length:
255Path Parameters
Body
application/json
One-page greetings: move it to another page.
Required string length:
1 - 500Audience greetings: replace the filters.
Maximum array length:
12Show child attributes
Show child attributes
What your team calls it. Defaults to the page or type.
Required string length:
1 - 80What the chat says first. Openings shown beside the launcher read best under 120 characters. Link greetings may use {first|there}, {company|your team}, {title}, {last}.
Required string length:
1 - 300Up to four reply buttons. Their label is what the visitor taps; message is what it sends (the label when left out).
Maximum array length:
4Show child attributes
Show child attributes
What the agent should know about people who see it. Null removes it.
Maximum string length:
500What it steers toward: "meeting" or an outcome form id (out_…). Null keeps the chat's usual.
How long it stays once it matched: match (only matching pages), visit (this visit), return (every visit for 90 days).
Available options:
match, visit, return live greets visitors; draft and paused don't. An archived greeting comes back with live.
Available options:
live, draft, paused auto: Darwin may test new openings on it (one-page greetings and the default); off: it keeps these words.
Available options:
auto, off Changing the words, buttons or audience of a greeting under test is refused (409) unless end_test is true: the test ends first and its results are kept.
Response
OK
Pattern:
^gr_Example:
"gr_yjh2jw"
Allowed value:
"greeting"page: one page. audience: visitors who match show_to. link: people who open its personal links. default: everyone else (the catch-all), one per workspace.
Available options:
page, audience, link, default What the chat says first.
Example:
"Comparing plans? Give me a rough count of meetings a month and I'll find your cheapest fit."
Reply buttons. Your locked buttons (Agent Studio) are added when it is shown.
Show child attributes
Show child attributes
What the agent is told about people shown this greeting.
What it steers toward: "meeting" or an outcome form (out_…). Null: the chat's usual.
For type page: the page it shows on.
For type link: the personal links (lk_…) that open with it.
For type audience: the filters a visit must all match.
Show child attributes
Show child attributes
Who sees it, in words.
Example:
"Page is any of /pricing"
match: only on pages it matches. visit: the rest of the visit. return: every visit for 90 days.
Available options:
match, visit, return Available options:
live, draft, paused, archived auto: Darwin may test new openings on it (one-page greetings and the default). off: it keeps these words.
Available options:
auto, off Order among greetings of the same kind, lowest first.
Required range:
-9007199254740991 <= x <= 9007199254740991The test running on it now (exp_…); read it with GET /experiments/{id}.
Show child attributes
Show child attributes
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$