View as Markdown Open in ChatGPT Open in Claude
POST
RCS API · BOTS · v1.0

update bot

Request header should have **apikey** and **botId** Request body validations: - botName: max characters 40 - shortDescription: max characters 100 - botMessageType: should be either "TRANSACTIONAL" or "PROMOTIONAL" - phoneNumbers: max array length 3 - websites: max array length 3 - emails: max array length 3 - color: should be in valid hex code format, example: #FFFFFF - botLogoImage: should be valid url, max size 90 KB, size: 224 px X 224px, Image type: PNG, JPG, JPEG - botBannerImage: should be valid url, max size 360KB, size: 1140px X 448px, Image type: PNG, JPG, JPEG - termsofUseUrl: should be valid url - privacyPolicyUrl: should be valid url Example response ``` json { "status": "SUCCESS", "code": 200, "data": "Bot Details Updated Successfully!" } ```

https://api.example.com/rcs/api/v1/update-bot
infoOverview

About this API

Request header should have **apikey** and **botId** Request body validations: - botName: max characters 40 - shortDescription: max characters 100 - botMessageType: should be either "TRANSACTIONAL" or "PROMOTIONAL" - phoneNumbers: max array length 3 - websites: max array length 3 - emails: max array length 3 - color: should be in valid hex code format, example: #FFFFFF - botLogoImage: should be valid url, max size 90 KB, size: 224 px X 224px, Image type: PNG, JPG, JPEG - botBannerImage: should be valid url, max size 360KB, size: 1140px X 448px, Image type: PNG, JPG, JPEG - termsofUseUrl: should be valid url - privacyPolicyUrl: should be valid url Example response ``` json { "status": "SUCCESS", "code": 200, "data": "Bot Details Updated Successfully!" } ```

MethodPOST
Versionv1.0
Base URLhttps://api.example.com/rcs
Content Typeapplication/json
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
colorstringNot specifiedRequest value for color.
emailsarrayNot specifiedRequest value for emails.
botNamestringNot specifiedRequest value for botName.
websitesarrayNot specifiedRequest value for websites.
botLogoImageobjectNot specifiedRequest value for botLogoImage.
phoneNumbersarrayNot specifiedRequest value for phoneNumbers.
termsofUseUrlstringNot specifiedRequest value for termsofUseUrl.
botBannerImageobjectNot specifiedRequest value for botBannerImage.
privacyPolicyUrlstringNot specifiedRequest value for privacyPolicyUrl.
shortDescriptionstringNot specifiedRequest value for shortDescription.
languagesSupportedstringNot specifiedRequest value for languagesSupported.
{
  "color": "#000000",
  "emails": [
    {
      "email": "botbot@gmail.com",
      "label": "Label for Primary Email"
    }
  ],
  "botName": "PinnacleTransBotProdUpdate1",
  "websites": [
    {
      "url": "https://bot-primary.com",
      "label": "Label for Primary Site"
    }
  ],
  "botLogoImage": {
    "url": "https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/logoimage/1/XQPLDZ74R0WHRJDFDG6E.jpg",
    "type": "image/jpg"
  },
  "phoneNumbers": [
    {
      "label": "primary phone no label",
      "number": "9049566848",
      "country": "India",
      "countryCode": "+91"
    }
  ],
  "termsofUseUrl": "https://bot-terms.com",
  "botBannerImage": {
    "url": "https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/bgimage/1/L6HKQOQLIMD85UD50SLW.jpg",
    "type": "image/jpg"
  },
  "privacyPolicyUrl": "https://bot-privacy.com",
  "shortDescription": "a very short message",
  "languagesSupported": "English "
}
{
  "type": "object",
  "properties": {
    "color": {
      "type": "string"
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string"
          },
          "label": {
            "type": "string"
          }
        }
      }
    },
    "botName": {
      "type": "string"
    },
    "websites": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string"
          },
          "label": {
            "type": "string"
          }
        }
      }
    },
    "botLogoImage": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      }
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "number": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "countryCode": {
            "type": "string"
          }
        }
      }
    },
    "termsofUseUrl": {
      "type": "string"
    },
    "botBannerImage": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      }
    },
    "privacyPolicyUrl": {
      "type": "string"
    },
    "shortDescription": {
      "type": "string"
    },
    "languagesSupported": {
      "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 POST 'https://api.example.com/rcs/api/v1/update-bot' \
  --header 'Content-Type: application/json' \
  --data '{
  "color": "#000000",
  "emails": [
    {
      "email": "botbot@gmail.com",
      "label": "Label for Primary Email"
    }
  ],
  "botName": "PinnacleTransBotProdUpdate1",
  "websites": [
    {
      "url": "https://bot-primary.com",
      "label": "Label for Primary Site"
    }
  ],
  "botLogoImage": {
    "url": "https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/logoimage/1/XQPLDZ74R0WHRJDFDG6E.jpg",
    "type": "image/jpg"
  },
  "phoneNumbers": [
    {
      "label": "primary phone no label",
      "number": "9049566848",
      "country": "India",
      "countryCode": "+91"
    }
  ],
  "termsofUseUrl": "https://bot-terms.com",
  "botBannerImage": {
    "url": "https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/bgimage/1/L6HKQOQLIMD85UD50SLW.jpg",
    "type": "image/jpg"
  },
  "privacyPolicyUrl": "https://bot-privacy.com",
  "shortDescription": "a very short message",
  "languagesSupported": "English "
}'
const response = await fetch('https://api.example.com/rcs/api/v1/update-bot', {
  method: 'POST',
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "color": "#000000",
    "emails": [
      {
        "email": "botbot@gmail.com",
        "label": "Label for Primary Email"
      }
    ],
    "botName": "PinnacleTransBotProdUpdate1",
    "websites": [
      {
        "url": "https://bot-primary.com",
        "label": "Label for Primary Site"
      }
    ],
    "botLogoImage": {
      "url": "https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/logoimage/1/XQPLDZ74R0WHRJDFDG6E.jpg",
      "type": "image/jpg"
    },
    "phoneNumbers": [
      {
        "label": "primary phone no label",
        "number": "9049566848",
        "country": "India",
        "countryCode": "+91"
      }
    ],
    "termsofUseUrl": "https://bot-terms.com",
    "botBannerImage": {
      "url": "https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/bgimage/1/L6HKQOQLIMD85UD50SLW.jpg",
      "type": "image/jpg"
    },
    "privacyPolicyUrl": "https://bot-privacy.com",
    "shortDescription": "a very short message",
    "languagesSupported": "English "
  })
});

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/update-bot', {
  method: 'POST',
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "color": "#000000",
    "emails": [
      {
        "email": "botbot@gmail.com",
        "label": "Label for Primary Email"
      }
    ],
    "botName": "PinnacleTransBotProdUpdate1",
    "websites": [
      {
        "url": "https://bot-primary.com",
        "label": "Label for Primary Site"
      }
    ],
    "botLogoImage": {
      "url": "https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/logoimage/1/XQPLDZ74R0WHRJDFDG6E.jpg",
      "type": "image/jpg"
    },
    "phoneNumbers": [
      {
        "label": "primary phone no label",
        "number": "9049566848",
        "country": "India",
        "countryCode": "+91"
      }
    ],
    "termsofUseUrl": "https://bot-terms.com",
    "botBannerImage": {
      "url": "https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/bgimage/1/L6HKQOQLIMD85UD50SLW.jpg",
      "type": "image/jpg"
    },
    "privacyPolicyUrl": "https://bot-privacy.com",
    "shortDescription": "a very short message",
    "languagesSupported": "English "
  })
});

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/update-bot'
headers = {
  "Content-Type": "application/json"
}
payload = json.loads(r'''{
  "color": "#000000",
  "emails": [
    {
      "email": "botbot@gmail.com",
      "label": "Label for Primary Email"
    }
  ],
  "botName": "PinnacleTransBotProdUpdate1",
  "websites": [
    {
      "url": "https://bot-primary.com",
      "label": "Label for Primary Site"
    }
  ],
  "botLogoImage": {
    "url": "https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/logoimage/1/XQPLDZ74R0WHRJDFDG6E.jpg",
    "type": "image/jpg"
  },
  "phoneNumbers": [
    {
      "label": "primary phone no label",
      "number": "9049566848",
      "country": "India",
      "countryCode": "+91"
    }
  ],
  "termsofUseUrl": "https://bot-terms.com",
  "botBannerImage": {
    "url": "https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/bgimage/1/L6HKQOQLIMD85UD50SLW.jpg",
    "type": "image/jpg"
  },
  "privacyPolicyUrl": "https://bot-privacy.com",
  "shortDescription": "a very short message",
  "languagesSupported": "English "
}''')
response = requests.post(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 = """
{
  "color": "#000000",
  "emails": [
    {
      "email": "botbot@gmail.com",
      "label": "Label for Primary Email"
    }
  ],
  "botName": "PinnacleTransBotProdUpdate1",
  "websites": [
    {
      "url": "https://bot-primary.com",
      "label": "Label for Primary Site"
    }
  ],
  "botLogoImage": {
    "url": "https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/logoimage/1/XQPLDZ74R0WHRJDFDG6E.jpg",
    "type": "image/jpg"
  },
  "phoneNumbers": [
    {
      "label": "primary phone no label",
      "number": "9049566848",
      "country": "India",
      "countryCode": "+91"
    }
  ],
  "termsofUseUrl": "https://bot-terms.com",
  "botBannerImage": {
    "url": "https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/bgimage/1/L6HKQOQLIMD85UD50SLW.jpg",
    "type": "image/jpg"
  },
  "privacyPolicyUrl": "https://bot-privacy.com",
  "shortDescription": "a very short message",
  "languagesSupported": "English "
}
""";
var request = HttpRequest.newBuilder(URI.create("https://api.example.com/rcs/api/v1/update-bot"))
    .header("Content-Type", "application/json")
    .method("POST", 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 = '{
  "color": "#000000",
  "emails": [
    {
      "email": "botbot@gmail.com",
      "label": "Label for Primary Email"
    }
  ],
  "botName": "PinnacleTransBotProdUpdate1",
  "websites": [
    {
      "url": "https://bot-primary.com",
      "label": "Label for Primary Site"
    }
  ],
  "botLogoImage": {
    "url": "https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/logoimage/1/XQPLDZ74R0WHRJDFDG6E.jpg",
    "type": "image/jpg"
  },
  "phoneNumbers": [
    {
      "label": "primary phone no label",
      "number": "9049566848",
      "country": "India",
      "countryCode": "+91"
    }
  ],
  "termsofUseUrl": "https://bot-terms.com",
  "botBannerImage": {
    "url": "https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/bgimage/1/L6HKQOQLIMD85UD50SLW.jpg",
    "type": "image/jpg"
  },
  "privacyPolicyUrl": "https://bot-privacy.com",
  "shortDescription": "a very short message",
  "languagesSupported": "English "
}';
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.example.com/rcs/api/v1/update-bot',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    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 = """
{
  "color": "#000000",
  "emails": [
    {
      "email": "botbot@gmail.com",
      "label": "Label for Primary Email"
    }
  ],
  "botName": "PinnacleTransBotProdUpdate1",
  "websites": [
    {
      "url": "https://bot-primary.com",
      "label": "Label for Primary Site"
    }
  ],
  "botLogoImage": {
    "url": "https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/logoimage/1/XQPLDZ74R0WHRJDFDG6E.jpg",
    "type": "image/jpg"
  },
  "phoneNumbers": [
    {
      "label": "primary phone no label",
      "number": "9049566848",
      "country": "India",
      "countryCode": "+91"
    }
  ],
  "termsofUseUrl": "https://bot-terms.com",
  "botBannerImage": {
    "url": "https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/bgimage/1/L6HKQOQLIMD85UD50SLW.jpg",
    "type": "image/jpg"
  },
  "privacyPolicyUrl": "https://bot-privacy.com",
  "shortDescription": "a very short message",
  "languagesSupported": "English "
}
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.example.com/rcs/api/v1/update-bot", content);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
package main

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

func main() {
    request, err := http.NewRequest("POST", "https://api.example.com/rcs/api/v1/update-bot", bytes.NewBufferString("{\n  \"color\": \"#000000\",\n  \"emails\": [\n    {\n      \"email\": \"botbot@gmail.com\",\n      \"label\": \"Label for Primary Email\"\n    }\n  ],\n  \"botName\": \"PinnacleTransBotProdUpdate1\",\n  \"websites\": [\n    {\n      \"url\": \"https://bot-primary.com\",\n      \"label\": \"Label for Primary Site\"\n    }\n  ],\n  \"botLogoImage\": {\n    \"url\": \"https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/logoimage/1/XQPLDZ74R0WHRJDFDG6E.jpg\",\n    \"type\": \"image/jpg\"\n  },\n  \"phoneNumbers\": [\n    {\n      \"label\": \"primary phone no label\",\n      \"number\": \"9049566848\",\n      \"country\": \"India\",\n      \"countryCode\": \"+91\"\n    }\n  ],\n  \"termsofUseUrl\": \"https://bot-terms.com\",\n  \"botBannerImage\": {\n    \"url\": \"https://portal-vistaging.dotgo.com/rcsbotdirectory/vi/image/bot/6202/bgimage/1/L6HKQOQLIMD85UD50SLW.jpg\",\n    \"type\": \"image/jpg\"\n  },\n  \"privacyPolicyUrl\": \"https://bot-privacy.com\",\n  \"shortDescription\": \"a very short message\",\n  \"languagesSupported\": \"English \"\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.

{}
{}
ruleHTTP Responses

Status Codes

200Successful response
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.