Messaging
Update SMS Conversation
Updates properties of an existing SMS conversation.
PATCH
/
v1
/
sms
/
conversations
/
{conversation_id}
Update SMS Conversation
curl --request PATCH \
--url https://api.bland.ai/v1/sms/conversations/{conversation_id} \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '
{
"is_active": true
}
'import requests
url = "https://api.bland.ai/v1/sms/conversations/{conversation_id}"
payload = { "is_active": True }
headers = {
"authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({is_active: true})
};
fetch('https://api.bland.ai/v1/sms/conversations/{conversation_id}', 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://api.bland.ai/v1/sms/conversations/{conversation_id}",
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([
'is_active' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <authorization>"
],
]);
$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://api.bland.ai/v1/sms/conversations/{conversation_id}"
payload := strings.NewReader("{\n \"is_active\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("authorization", "<authorization>")
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://api.bland.ai/v1/sms/conversations/{conversation_id}")
.header("authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v1/sms/conversations/{conversation_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"message": "Conversation updated successfully",
"conversation": {
"id": "conv_1234567890",
"is_active": false,
"updated_at": "2024-01-15T10:30:00.000Z"
}
},
"errors": null
}
{
"data": null,
"errors": [
{
"message": "Conversation ID is required",
"error": "CONVERSATION_ID_REQUIRED"
}
]
}
{
"data": null,
"errors": [
{
"message": "Conversation not found",
"error": "CONVERSATION_NOT_FOUND"
}
]
}
Enterprise Feature - This endpoint is available for enterprise customers only.
Headers
Path Parameters
Body Parameters
Sets the active status of the conversation. When set to
false, the conversation will be marked as inactive.Response
{
"data": {
"message": "Conversation updated successfully",
"conversation": {
"id": "conv_1234567890",
"is_active": false,
"updated_at": "2024-01-15T10:30:00.000Z"
}
},
"errors": null
}
{
"data": null,
"errors": [
{
"message": "Conversation ID is required",
"error": "CONVERSATION_ID_REQUIRED"
}
]
}
{
"data": null,
"errors": [
{
"message": "Conversation not found",
"error": "CONVERSATION_NOT_FOUND"
}
]
}
Docs for agents: llms.txt
Was this page helpful?
⌘I
Update SMS Conversation
curl --request PATCH \
--url https://api.bland.ai/v1/sms/conversations/{conversation_id} \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '
{
"is_active": true
}
'import requests
url = "https://api.bland.ai/v1/sms/conversations/{conversation_id}"
payload = { "is_active": True }
headers = {
"authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({is_active: true})
};
fetch('https://api.bland.ai/v1/sms/conversations/{conversation_id}', 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://api.bland.ai/v1/sms/conversations/{conversation_id}",
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([
'is_active' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <authorization>"
],
]);
$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://api.bland.ai/v1/sms/conversations/{conversation_id}"
payload := strings.NewReader("{\n \"is_active\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("authorization", "<authorization>")
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://api.bland.ai/v1/sms/conversations/{conversation_id}")
.header("authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v1/sms/conversations/{conversation_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"message": "Conversation updated successfully",
"conversation": {
"id": "conv_1234567890",
"is_active": false,
"updated_at": "2024-01-15T10:30:00.000Z"
}
},
"errors": null
}
{
"data": null,
"errors": [
{
"message": "Conversation ID is required",
"error": "CONVERSATION_ID_REQUIRED"
}
]
}
{
"data": null,
"errors": [
{
"message": "Conversation not found",
"error": "CONVERSATION_NOT_FOUND"
}
]
}