setStateExpiry

Updates the State expiry.

POST /v1/chat/states/{type}/{id}/{name}/expiry

cURL

cURL

curl --request POST \
  --url https://api.botpress.cloud/v1/chat/states/{type}/{id}/{name}/expiry \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <x-bot-id>' \
  --data '
{
  "expiry": 1296000000.5
}
'

import requests

url = "https://api.botpress.cloud/v1/chat/states/{type}/{id}/{name}/expiry"

payload = { "expiry": 1296000000.5 }
headers = {
    "x-bot-id": "<x-bot-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-bot-id': '<x-bot-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({expiry: 1296000000.5})
};

fetch('https://api.botpress.cloud/v1/chat/states/{type}/{id}/{name}/expiry', 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.botpress.cloud/v1/chat/states/{type}/{id}/{name}/expiry",
  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([
    'expiry' => 1296000000.5
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-bot-id: <x-bot-id>"
  ],
]);

$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.botpress.cloud/v1/chat/states/{type}/{id}/{name}/expiry"

	payload := strings.NewReader("{\n  \"expiry\": 1296000000.5\n}")

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

	req.Header.Add("x-bot-id", "<x-bot-id>")
	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("https://api.botpress.cloud/v1/chat/states/{type}/{id}/{name}/expiry")
  .header("x-bot-id", "<x-bot-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expiry\": 1296000000.5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.botpress.cloud/v1/chat/states/{type}/{id}/{name}/expiry")

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

request = Net::HTTP::Post.new(url)
request["x-bot-id"] = '<x-bot-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expiry\": 1296000000.5\n}"

response = http.request(request)
puts response.read_body

200

{
  "state": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "botId": "<string>",
    "name": "<string>",
    "payload": {},
    "conversationId": "<string>",
    "userId": "<string>"
  }
}

{
  "state": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "botId": "<string>",
    "name": "<string>",
    "payload": {},
    "conversationId": "<string>",
    "userId": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Headers

x-bot-id · string · required

Bot id

x-integration-id · string

Integration id

x-integration-alias · string

Integration alias

Path Parameters

type · enum<string> · required

Represents the resource type that the state is related to

Available options: conversation, user, bot, integration, task, workflow

id · string · required

Id of the State which will be either the botId, the userId or the conversationId

name · string · required

Name of the State which is declared inside the bot definition

Body

application/json

State expiry

expiry · number | null · required

Expiry of the State in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire.

Required range: 1 <= x <= 2592000000

Response

200

application/json

Returns the updated State object if a valid identifier was provided. Returns an an error otherwise

state · object · required

The state object represents the current payload. A state is always linked to either a bot, a conversation or a user.

Show child attributes