View as Markdown Open in ChatGPT Open in Claude
PUT
RCS API · BOTS / CONFIG · v1.0

set-payload-transform-type

https://api.example.com/rcs/api/v1/bot/config/set-payload-transform-type
infoOverview

About this API

keySecurity

Authentication

This endpoint does not require authentication.

uploadInput

Request Body

Send a application/json payload. Replace placeholder values with data from your integration.

Top-Level Fields

NameTypeRequirementDescription
botIdstringNot specifiedRequest value for botId.
payloadTransformTypestringNot specifiedRequest value for payloadTransformType.
{
  "botId": "68218acedb298103bc8d5931",
  "payloadTransformType": "DEFAULT"
}
{
  "type": "object",
  "properties": {
    "botId": {
      "type": "string"
    },
    "payloadTransformType": {
      "type": "string"
    }
  }
}
codeIntegration

Code Examples

Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.

shield_lockCredentials protectedAdd secrets only in your secure server environment.
downloadSDK
curl --request PUT 'https://api.example.com/rcs/api/v1/bot/config/set-payload-transform-type' \
  --header 'Content-Type: application/json' \
  --data '{
  "botId": "68218acedb298103bc8d5931",
  "payloadTransformType": "DEFAULT"
}'
const response = await fetch('https://api.example.com/rcs/api/v1/bot/config/set-payload-transform-type', {
  method: 'PUT',
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "botId": "68218acedb298103bc8d5931",
    "payloadTransformType": "DEFAULT"
  })
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);
const response = await fetch('https://api.example.com/rcs/api/v1/bot/config/set-payload-transform-type', {
  method: 'PUT',
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "botId": "68218acedb298103bc8d5931",
    "payloadTransformType": "DEFAULT"
  })
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);
import json
import requests

url = 'https://api.example.com/rcs/api/v1/bot/config/set-payload-transform-type'
headers = {
  "Content-Type": "application/json"
}
payload = json.loads(r'''{
  "botId": "68218acedb298103bc8d5931",
  "payloadTransformType": "DEFAULT"
}''')
response = requests.put(url, headers=headers, json=payload)

response.raise_for_status()
print(response.json())
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var client = HttpClient.newHttpClient();
String body = """
{
  "botId": "68218acedb298103bc8d5931",
  "payloadTransformType": "DEFAULT"
}
""";
var request = HttpRequest.newBuilder(URI.create("https://api.example.com/rcs/api/v1/bot/config/set-payload-transform-type"))
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString(body))
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
<?php
$curl = curl_init();
$payload = '{
  "botId": "68218acedb298103bc8d5931",
  "payloadTransformType": "DEFAULT"
}';
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.example.com/rcs/api/v1/bot/config/set-payload-transform-type',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => ["Content-Type: application/json"],
    CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
var json = """
{
  "botId": "68218acedb298103bc8d5931",
  "payloadTransformType": "DEFAULT"
}
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PutAsync("https://api.example.com/rcs/api/v1/bot/config/set-payload-transform-type", content);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
package main

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

func main() {
    request, err := http.NewRequest("PUT", "https://api.example.com/rcs/api/v1/bot/config/set-payload-transform-type", bytes.NewBufferString("{\n  \"botId\": \"68218acedb298103bc8d5931\",\n  \"payloadTransformType\": \"DEFAULT\"\n}"))
    if err != nil { panic(err) }
    request.Header.Set("Content-Type", "application/json")
    request.Header.Set("Accept", "application/json")
    response, err := http.DefaultClient.Do(request)
    if err != nil { panic(err) }
    defer response.Body.Close()
    data, err := io.ReadAll(response.Body)
    if err != nil { panic(err) }
    if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
    fmt.Println(string(data))
}
downloadOutput

Response

A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.

{
  "403": {
    "code": 403,
    "status": "ERROR",
    "message": "Unauthorized for this domain \"localhost\""
  }
}
{}
ruleHTTP Responses

Status Codes

403Forbidden
Global API SearchProducts, versions, endpoints, paths, and payload fields
Esc
Full search page
manage_searchSearch the complete API catalogEnter at least two characters to begin.