Update a session followup cadence without recreating it
curl --request POST \
--url http://localhost:3000/api/v1/sessions/followups/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"barrier": "<string>",
"description": "<string>",
"message": "<string>",
"name": "<string>",
"recalculateNext": true,
"step": [
"<string>"
]
}
'import requests
url = "http://localhost:3000/api/v1/sessions/followups/update"
payload = {
"id": "<string>",
"barrier": "<string>",
"description": "<string>",
"message": "<string>",
"name": "<string>",
"recalculateNext": True,
"step": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
barrier: '<string>',
description: '<string>',
message: '<string>',
name: '<string>',
recalculateNext: true,
step: ['<string>']
})
};
fetch('http://localhost:3000/api/v1/sessions/followups/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/sessions/followups/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'barrier' => '<string>',
'description' => '<string>',
'message' => '<string>',
'name' => '<string>',
'recalculateNext' => true,
'step' => [
'<string>'
]
]),
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 := "http://localhost:3000/api/v1/sessions/followups/update"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"barrier\": \"<string>\",\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"name\": \"<string>\",\n \"recalculateNext\": true,\n \"step\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("http://localhost:3000/api/v1/sessions/followups/update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"barrier\": \"<string>\",\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"name\": \"<string>\",\n \"recalculateNext\": true,\n \"step\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/sessions/followups/update")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"barrier\": \"<string>\",\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"name\": \"<string>\",\n \"recalculateNext\": true,\n \"step\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"followup": {
"createdAt": 123,
"deliveryBarrier": "immediate_interrupt",
"enabled": true,
"id": "<string>",
"lastRunAtIso": "<string>",
"messageTemplate": "<string>",
"name": "<string>",
"nextRunAtIso": "<string>",
"ownerId": "<string>",
"ownerType": "<string>",
"schedule": {
"type": "every",
"at": 123,
"cron": "<string>",
"every": 123,
"steps": [
{
"afterMs": 123,
"messageTemplate": "<string>",
"label": "<string>"
}
],
"timezone": "<string>"
},
"scheduleDescription": "<string>",
"targetRef": "<string>",
"targetType": "session",
"updatedAt": 123,
"description": "<string>",
"lastError": "<string>",
"lastRunAt": 123,
"lastStatus": "ok",
"metadata": {},
"nextRunAt": 123,
"steps": [
{
"afterMs": 123,
"messageTemplate": "<string>",
"label": "<string>"
}
]
}
}sessions
Update a session followup cadence without recreating it
POST
/
api
/
v1
/
sessions
/
followups
/
update
Update a session followup cadence without recreating it
curl --request POST \
--url http://localhost:3000/api/v1/sessions/followups/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"barrier": "<string>",
"description": "<string>",
"message": "<string>",
"name": "<string>",
"recalculateNext": true,
"step": [
"<string>"
]
}
'import requests
url = "http://localhost:3000/api/v1/sessions/followups/update"
payload = {
"id": "<string>",
"barrier": "<string>",
"description": "<string>",
"message": "<string>",
"name": "<string>",
"recalculateNext": True,
"step": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
barrier: '<string>',
description: '<string>',
message: '<string>',
name: '<string>',
recalculateNext: true,
step: ['<string>']
})
};
fetch('http://localhost:3000/api/v1/sessions/followups/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/sessions/followups/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'barrier' => '<string>',
'description' => '<string>',
'message' => '<string>',
'name' => '<string>',
'recalculateNext' => true,
'step' => [
'<string>'
]
]),
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 := "http://localhost:3000/api/v1/sessions/followups/update"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"barrier\": \"<string>\",\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"name\": \"<string>\",\n \"recalculateNext\": true,\n \"step\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("http://localhost:3000/api/v1/sessions/followups/update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"barrier\": \"<string>\",\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"name\": \"<string>\",\n \"recalculateNext\": true,\n \"step\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/sessions/followups/update")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"barrier\": \"<string>\",\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"name\": \"<string>\",\n \"recalculateNext\": true,\n \"step\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"followup": {
"createdAt": 123,
"deliveryBarrier": "immediate_interrupt",
"enabled": true,
"id": "<string>",
"lastRunAtIso": "<string>",
"messageTemplate": "<string>",
"name": "<string>",
"nextRunAtIso": "<string>",
"ownerId": "<string>",
"ownerType": "<string>",
"schedule": {
"type": "every",
"at": 123,
"cron": "<string>",
"every": 123,
"steps": [
{
"afterMs": 123,
"messageTemplate": "<string>",
"label": "<string>"
}
],
"timezone": "<string>"
},
"scheduleDescription": "<string>",
"targetRef": "<string>",
"targetType": "session",
"updatedAt": 123,
"description": "<string>",
"lastError": "<string>",
"lastRunAt": 123,
"lastStatus": "ok",
"metadata": {},
"nextRunAt": 123,
"steps": [
{
"afterMs": 123,
"messageTemplate": "<string>",
"label": "<string>"
}
]
}
}Authorizations
Runtime context-key (rctx_*) issued by the Ravi gateway. Required for every non-open scope. Bootstrap the first key with ravi daemon init-admin-key; rotate, derive, and revoke via the ravi context family. Specs: runtime/context-keys, sdk/auth.
Body
application/json
Followup cadence id
Delivery barrier: followup|steer|p0|p1|p2|p3
Update description; pass empty string to clear
Update default followup message template
Update cadence name
Recalculate next run from the updated schedule
Replace idle followup steps; repeat or quote, e.g. --step '2h=First' --step '3h=Second'
Response
Success — body conforms to the @Returns schema.
Show child attributes
Show child attributes