Get Conversation Starters

post

https://gus.assistant.unbxd.io/v1/sites/{sitekey}/conversation/{conversationid}/questions

Returns suggested questions for the current page and an optional welcome message.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

sitekey

string

required

Your site key, provided during onboarding. The site key is associated with a specific region.

conversationid

string

required

Conversation ID returned by Start a conversation.

Query Params

uid

string

required

Stable identifier for the shopper. Use the same value that started the conversation.

Body Params

pagetype

string

enum

required

Page the shopper is on.

Allowed:

metadata

object

required

Page context. Required keys depend on pagetype: search requires query; category requires category_id; pdp requires uniqueId; cart requires uniqueIds; home can send an empty object.

welcome_message

boolean

Defaults to false

Set to true to also get a welcome message. Defaults to false.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

404

Wrong path or HTTP method.

502

Service temporarily unavailable or timed out.

503

Service temporarily unavailable.

504

Gateway timeout.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200Suggested questions returned.

400Invalid request, such as missing uid, invalid JSON, or message longer than 1,000 characters.

500The assistant could not complete the request.