rcs > test

Update Test Agent

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:

ImageFormatMax Size
LogoJPEG, PNG50 KB
HeroJPEG, PNG200 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.

patch/rcs/test/agents/{agentId}

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/rcs/test/agents/{agentId}
  • Auth: API key in header PINNACLE-API-KEY

Path parameters

agentIdstring required

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

Request body

displayNamestring

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

descriptionstring

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

logoUrlstring uri

URL to the agent's logo image.

Requirements:

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

URL to the agent's hero banner image.

Requirements:

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

URL to the agent's privacy policy.

termsUrlstring uri

URL to the agent's terms and conditions.

colorstring

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

isConversationalboolean

Whether the agent supports two-way conversations.

agentUseCase'TRANSACTIONAL' | 'PROMOTIONAL' | 'OTP' | 'MULTI_USE'

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.

Response

The test agent was updated successfully.

idstring required

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

type'TEST' required

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

serviceIdstring required

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.

Changes

No recorded changes to this operation across all 1 revision of this API.