Skip to main content
PATCH
/
v0
/
chatbots
/
{chatbotId}
/
conversation-starters
/
{promptId}
Update Conversation Starter
curl --request PATCH \
  --url https://sitegpt.ai/api/v0/chatbots/{chatbotId}/conversation-starters/{promptId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "conversation starter title",
  "link": "",
  "description": "conversation starter description"
}
'
import requests

url = "https://sitegpt.ai/api/v0/chatbots/{chatbotId}/conversation-starters/{promptId}"

payload = {
"title": "conversation starter title",
"link": "",
"description": "conversation starter description"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: 'conversation starter title',
link: '',
description: 'conversation starter description'
})
};

fetch('https://sitegpt.ai/api/v0/chatbots/{chatbotId}/conversation-starters/{promptId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sitegpt.ai/api/v0/chatbots/{chatbotId}/conversation-starters/{promptId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'title' => 'conversation starter title',
'link' => '',
'description' => 'conversation starter description'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://sitegpt.ai/api/v0/chatbots/{chatbotId}/conversation-starters/{promptId}"

payload := strings.NewReader("{\n \"title\": \"conversation starter title\",\n \"link\": \"\",\n \"description\": \"conversation starter description\"\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://sitegpt.ai/api/v0/chatbots/{chatbotId}/conversation-starters/{promptId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"conversation starter title\",\n \"link\": \"\",\n \"description\": \"conversation starter description\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sitegpt.ai/api/v0/chatbots/{chatbotId}/conversation-starters/{promptId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"conversation starter title\",\n \"link\": \"\",\n \"description\": \"conversation starter description\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "Updated conversation starter of the chatbot successfully",
  "data": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

chatbotId
string
required

Your Chatbot ID

promptId
string
required

Your Conversation Starter ID

Body

application/json

Request body to update the conversation starter

Request body

title
string

Title of the conversation-starter. This is the text that is shown as button in the chatbot.

Link of the conversation starter. If this link is added, then when you click on the conversation starter in the chatbot, this link will be opened instead of sending a message to the chatbot.

description
string

Description of the conversation-starter. This is the message that will be sent to the chatbot when you click on the conversation-starter inside the chatbot.

Response

OK

Success Response

success
boolean

Indicates whether this is success response or error response

message
string

Overall message regarding the operation performed

data
object

Data returned from the server