Chat: Message Endpoint
Send messages and receive responses from a Yext Chat bot.
path Parameters
| accountId required | string |
| botId required | string The ID of the chatbot. |
query Parameters
| v required | string A date in |
Request Body schema: application/json
Array of objects List of messages representing the full conversation history. | |
| conversationId | string A ULID representing the conversation between the user and the chatbot. |
object | |
| context | object Additional, user-defined information that is passed to the chatbot, and can be referenced in the instruction flow. |
| version | string Enum: "LATEST" "STAGING" "PRODUCTION" The version of chatbot. Defaults to |
Responses
Request samples
- Payload
Content type
application/json
{- "messages": [
- {
- "timestamp": "string",
- "source": "USER",
- "text": "string"
}
], - "conversationId": "string",
- "notes": {
- "currentGoal": "string",
- "currentStepIndices": [
- 0
], - "collectedData": { },
- "searchQuery": "string",
- "queryResult": { },
- "goalFirstMsgIndex": 0
}, - "context": { },
- "version": "LATEST"
}Response samples
- 200
- default
Content type
application/json
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "conversationId": "string",
- "message": {
- "timestamp": "string",
- "source": "USER",
- "text": "string"
}, - "notes": {
- "currentGoal": "string",
- "currentStepIndices": [
- 0
], - "collectedData": { },
- "searchQuery": "string",
- "queryResult": { },
- "goalFirstMsgIndex": 0
}
}
}