---
title: "Whitelist Number for Test Agent"
method: POST
path: "/rcs/test/agents/{agentId}/whitelist"
tags: ["rcs > test"]
---

# Whitelist Number for Test Agent

`POST /rcs/test/agents/{agentId}/whitelist`

## Request

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

Whitelist a phone number for testing with a specific test agent.

During development and testing, RCS agents can only send messages to whitelisted phone numbers.
Use this endpoint to whitelist specific phone numbers so you can send and receive messages from the test agent.

## Verification Process

After whitelisting, the recipient must accept the tester invite:

1. The recipient's device will receive a message from "RBM Tester Management".
2. The recipient must tap "Make me a tester" to accept.
3. Once accepted, the status transitions from `PENDING` to `ACCEPTED`.

## Verification

<div style="display: flex; gap: 16px;">
  <div style="flex: 1; text-align: center;">
    <strong>Accepting the invite</strong><br/>
    <img src="https://pncl.to/f769cAvCbEx-MmezZjR6dz6KVkr5ZO" alt="Accepting the tester invite" style="max-width: 100%;" />
  </div>
  <div style="flex: 1; text-align: center;">
    <strong>Declining the invite</strong><br/>
    <img src="https://pncl.to/VRere3tEKfx4n0HNaxK-vwl7pbLHTJ" alt="Declining the tester invite" style="max-width: 100%;" />
  </div>
</div>

## Cooldown

There is a **2-minute cooldown** after creating or updating a test agent before you can whitelist numbers.
Attempting to whitelist during the cooldown returns a `500` error with the remaining wait time.

## Path parameters

- `agentId` string, required

## Request body

- TestAgentWhitelistRequest: Request body for whitelisting a phone number on a specific test agent.
  - `phoneNumber` string, required: Phone number to whitelist for testing in E.164 format.

## Response `200`

Returns the whitelist status of the phone number.

- TestAgentWhitelistResponse: Response containing the whitelist status of a phone number.
  - `status` 'PENDING' | 'ACCEPTED' | 'REJECTED', required: Status of a whitelisted phone number for RCS testing. - `PENDING` — The tester invite has been sent but the recipient has not yet accepted or rejected it. - `ACCEPTED` — The recipient accepted the tester invite and can send/receive messages with the test agent. - `REJECTED` — The recipient rejected the tester invite or the invite could not be delivered.

## Other responses

- `400`: Validation failed. The payload has missing required fields and/or invalid types. <br> See https://zod.dev/error-formatting for more information.
- `401`: The request lacks valid authentication credentials or the provided credentials are invalid. <br> Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint.
- `403`: Your subscription does not include access to this feature. <br> This occurs when attempting to use functionality that requires a higher subscription tier. Please upgrade your subscription to access this feature.
- `404`: The requested resource could not be found. <br> This may occur if the identifier is incorrect, the resource has been deleted, or you don't have permission to access it.
- `500`: An internal error occurred. Common causes: - **Cooldown period:** The 2-minute cooldown after agent creation/update has not expired.

---

[API](https://skmtc.dev/pinnacle/apis/pinnacle-2.md) - [All operations](https://skmtc.dev/pinnacle/apis/pinnacle-2/llms.txt) - [OpenAPI document](https://skmtc.dev/pinnacle/apis/pinnacle-2/revisions/45416dadab79?raw)