Update Test Agent API Reference

Serverhttps://api.pinnacle.sh/

Update an existing RCS test agent's configuration.

All fields are optional — only include the fields you want to update.

Image Requirements

If updating images, the same requirements apply as when creating an agent:

Image	Format	Max Size
Logo	JPEG, PNG	50 KB
Hero	JPEG, PNG	200 KB

2-Minute Cooldown

After updating a test agent, there is a mandatory 2-minute cooldown before you can whitelist phone numbers. This is a requirement imposed by Google's RBM platform.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Path Parameters

agentIdstring

The RCS agent ID (must be prefixed with agent_).

Match

^agent_.*

Example

"agent_abc123def456"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for updating an existing RCS test agent.

All fields are optional — only include the fields you want to update. At least one field must be provided.

Properties

1 <= properties

displayNamestringOptional

Display name of the agent shown to users in RCS conversations. Must be between 1 and 40 characters.

Length

1 <= length <= 40

Example

"Acme Support"

descriptionstringOptional

Short description of what the agent does. Must be between 1 and 100 characters.

Length

1 <= length <= 100

Example

"Get help with your Acme orders and account"

logoUrlstringOptional

URL to the agent's logo image.

Requirements:

Format: JPEG or PNG
Max file size: 50 KB
Recommended: Square aspect ratio

Format

uri

Example

"https://example.com/assets/message-image.jpg"

heroUrlstringOptional

URL to the agent's hero banner image.

Requirements:

Format: JPEG or PNG
Max file size: 200 KB
Recommended: Landscape aspect ratio

Format

uri

Example

"https://example.com/assets/message-image.jpg"

array<object>Optional

Contact phone numbers displayed on the agent's profile. At least 1 and up to 3 entries.

Items

1 <= items <= 3

array<object>Optional

Contact email addresses displayed on the agent's profile. At least 1 and up to 3 entries.

Items

1 <= items <= 3

array<object>Optional

Website links displayed on the agent's profile. At least 1 and up to 3 entries.

Items

1 <= items <= 3

privacyUrlstringOptional

URL to the agent's privacy policy.

Format

uri

Example

"https://pinnacle.sh"

termsUrlstringOptional

URL to the agent's terms and conditions.

Format

uri

Example

"https://pinnacle.sh"

colorstringOptional

The agent's brand color as a hex color code. Must have sufficient contrast with white.

Match

^#([0-9A-Fa-f]{6})$

Example

"#FF6B00"

isConversationalbooleanOptional

Whether the agent supports two-way conversations.

Example

true

agentUseCasestringOptional

The primary use case for the RCS agent. This helps carriers understand the purpose of the agent during review.

TRANSACTIONAL — Order confirmations, shipping updates, appointment reminders, and similar transactional notifications.
PROMOTIONAL — Marketing messages, offers, discounts, and promotional content.
OTP — One-time passwords and verification codes.
MULTI_USE — A combination of transactional, promotional, and/or OTP messaging.

Allowed values

"TRANSACTIONAL""PROMOTIONAL""OTP""MULTI_USE"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.rcs.test.updateAgent("agent_abc123def456", {
    displayName: "Acme Premium Support"
});

Responses

{  "id": "agent_abc123def456",  "type": "TEST",  "serviceId": "acme-support_agent",  "details": {    "name": "Acme Premium Support",    "description": "Premium support for Acme customers",    "iconUrl": "https://example.com/logo.png",    "heroUrl": "https://example.com/hero.png",    "color": "#0066FF",    "phones": [      {        "phone": "+14155550123",        "label": "Support"      }    ],    "emails": [      {        "email": "support@example.com",        "label": "Support"      }    ],    "websites": [      {        "url": "https://example.com",        "label": "Website"      }    ],    "privacyUrl": "https://example.com/privacy",    "termsUrl": "https://example.com/terms",    "isConversational": true,    "agentUseCase": "MULTI_USE"  }}

Update Test Agent

Image Requirements

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`