| settings |
-ConversationSettings |
+ConversationSettings [^] |
| slots |
@@ -1023,7 +1024,7 @@ Schemas
Conversation
| settings |
-ConversationSettings |
+ConversationSettings [^] |
The settings for to use for this conversation. |
Yes |
No |
@@ -1121,8 +1122,8 @@ ConversationSettings
If set to true, Structurely drip campaigns will be used for an unresponsive lead. Only runs if there is no lead message following a system response in the messages list. |
Yes |
No |
+No |
false |
- |
| reDripsEnabled |
@@ -1130,8 +1131,17 @@ ConversationSettings
If set to true, Structurely will re-engage leads that have responded but are not responding to the current prompt. Will use the current context to determine outbound re-drips even if a custom response is generated by the third party user. |
Yes |
No |
+No |
+false |
+
+
+| activateGenerativeAi |
+Boolean |
+If set to true, Structurely will use Generative AI to enhance scripted responses, which results in better conversations and lower carrier filtering. |
+Yes |
+No |
+No |
false |
- |
| liveTransferUrl |
diff --git a/source/includes/_conversations.md b/source/includes/_conversations.md
index 64b7621a942..13ee2c37bef 100644
--- a/source/includes/_conversations.md
+++ b/source/includes/_conversations.md
@@ -20,6 +20,7 @@ curl 'https://api.structurely.com/v1/conversations' \
"settings": {
"chatbotName": "Aisa",
"timeZone": "America/Chicago",
+ "activateGenerativeAi": true,
"liveTransferUrl": "https://your-domain/api/structurely-live-transfer-start/leadId"
},
"slots": [
@@ -50,7 +51,7 @@ This endpoint creates and returns a new conversation object.
Parameter | Type
--------- | ----
-settings | `ConversationSettings`
+settings | `ConversationSettings` [[^]](#conversationsettings)
slots | `List`
muted | `Boolean`
messages | `List`
@@ -405,7 +406,7 @@ Be sure to include the header `Content-Type: application/json` with your request
Field | Type | Description | Readable? | Writable? | Required? | Default
----- | ---- | ----------- | --------- | --------- | --------- | -------
id | `ObjectId` | The ID of the conversation this resource represents. | Yes | No | No
-settings | `ConversationSettings` | The settings for to use for this conversation. | Yes | No | Yes
+settings | `ConversationSettings` [[^]](#conversationsettings) | The settings for to use for this conversation. | Yes | No | Yes
slots | `List` | A list of extracted or pre-filled values relating to the conversation. | Yes | No | Yes
muted | `Boolean` | A boolean flag to tell whether or not this conversation is muted. Once muted, a conversation can still receive messages but will no longer generate replies. It is not possible to unmute a conversation. | Yes | Yes | No | `false`
stages | `List` | A list of stages this conversation is currently in. | Yes | No | No
@@ -419,8 +420,9 @@ timeZone | `String` | The time zone the realtor and/or lead. (See [list](https:/
chatbotName | `String` | The name of conversation AI to use in responses. | Yes | No | No | Aisa
leadTypes | `List` | The lead types that will be supported in this conversation. Possible values are `buyer`, `seller`, and `renter` | Yes | No | No | `['buyer', 'seller']`
allowedDomains | `List` | The domains that this conversation can use for conversation flows. Possible values are `real_estate` and `mortgage`. When a lead sets or changes its lead type, the domain determines what scripts to use. | Yes | No | No | `['real_estate']`
-dripCampaignEnabled | `Boolean` | If set to true, Structurely drip campaigns will be used for an unresponsive lead. Only runs if there is no lead message following a system response in the messages list. | Yes | No | `false`
-reDripsEnabled | `Boolean` | If set to true, Structurely will re-engage leads that have responded but are not responding to the current prompt. Will use the current context to determine outbound re-drips even if a custom response is generated by the third party user. | Yes | No | `false`
+dripCampaignEnabled | `Boolean` | If set to true, Structurely drip campaigns will be used for an unresponsive lead. Only runs if there is no lead message following a system response in the messages list. | Yes | No | No | `false`
+reDripsEnabled | `Boolean` | If set to true, Structurely will re-engage leads that have responded but are not responding to the current prompt. Will use the current context to determine outbound re-drips even if a custom response is generated by the third party user. | Yes | No | No | `false`
+activateGenerativeAi | `Boolean` | If set to `true`, Structurely will use Generative AI to enhance scripted responses, which results in better conversations and lower carrier filtering. | Yes | No | No | `false`
liveTransferUrl | `URL` | Enables [Live Transfer](#live-transfer), must be a valid URL using `https://` | Yes | No | No | `undefined`
liveTransferStatusUpdateUrl | `URL` | Sends [Live Transfer](#live-transfer) status reports, must be a valid URL using `https://` | Yes | No | No | `undefined`