Process

post

https://api.closebot.ai/message

Instead of the endpoint listed, you can also use the obscured endpoint here https://xljmafyych.execute-api.us-west-2.amazonaws.com/message

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

api_key

string

Your account API key. This is required unless you're connected to a GoHighLevel CRM via integration

string

required

ID of the contact used to track a conversation

@rep_name

string

Name you want your bot to call itself, setting this overwrites the name you identify within your bot settings

@lead_name

string

Name of the contact your bot is engaging with (first name)

message

string

Message body from @lead_name that you need a processed response for

goals_finished

array of strings

List of any goals already accomplished for this contact that the bot should skip

goals_finished

limit

int32

Defaults to 100

Limit the number of times you want to allow the bot to process a message for a given contact before it ignores their messages (used to protect against a contact overusing the bot)

extra_prompt

string

Any extra instructions (500 characters or less) you would like for your bot to follow for the contact in addition to what is in your bot settings

bot

int32

Defaults to null

ID of the bot that you want to be used. If not specified, your earliest created bot will be used

model

string

Defaults to text-davinci-003

Model you wish to use to process the final response | 'gpt-4' | 'gpt-4-1106-preview'

followup

boolean

Defaults to false

Set follow-up to TRUE if you would like the bot to process a followup for the contact instead of generating a response to a message

is_update

boolean

Defaults to false

Set to TRUE if you would like the bot to use the message as an update to its memory of what you have manually sent to @lead_name instead of processing for a reply

@example_variable

string

Add any number of additional keys with values that will be injected into your bot settings to replace "@example_variable" with VALUE

character_limit

int32

Defaults to 225

Limit the character count of the output to this new maximum

delay

int32

Defaults to 0

Extra delay in seconds that you want your bot to wait before it begins processing the message

channel

string

Override the channel the reply is sent to for GHL users (Acceptable values case sensitive: Live_Chat, SMS, FB, Email, IG, WhatsApp)

Responses

200200

201201

410410

420420

430430

440440

450450

4XX4XX