Update Test Agent | Pinnacle

import { PinnacleClient } from "rcs-js";
async function main() {
    const client = new PinnacleClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.rcs.test.updateAgent("agent_abc123def456", {
        displayName: "Acme Premium Support",
    });
}
main();

{
  "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 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.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Path parameters

agentIdstringRequiredformat: "^agent_.*"

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

Request

This endpoint expects an object.

displayNamestringOptional1-40 characters

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

descriptionstringOptional1-100 characters

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

logoUrlstringOptionalformat: "uri"

URL to the agent's logo image.

Requirements:

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

heroUrlstringOptionalformat: "uri"

URL to the agent's hero banner image.

Requirements:

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

phoneNumberslist of objectsOptional

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

emailslist of objectsOptional

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

websiteslist of objectsOptional

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

privacyUrlstringOptionalformat: "uri"

URL to the agent's privacy policy.

termsUrlstringOptionalformat: "uri"

URL to the agent's terms and conditions.

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

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

isConversationalbooleanOptional

Whether the agent supports two-way conversations.

agentUseCaseenumOptional

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:

Response

The test agent was updated successfully.

idstring

The unique agent ID. Use this ID when sending messages, whitelisting numbers, and performing other agent operations. Always prefixed with agent_.

typeenum

The type of the agent. Test agents always have type TEST.

Allowed values:

serviceIdstring

The RCS service ID assigned to this agent by the carrier network. Used internally for routing messages. You can use this to construct RCS deep links manually.

detailsobject

The configuration details of an RCS agent, as returned by the GET endpoint.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error