Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Deletes an existing RCS agent. If deletion protection is enabled, an error is returned.

post/#X-Amz-Target=PinpointSMSVoiceV2.DeleteRcsAgent

Headers

X-Amz-Target'PinpointSMSVoiceV2.DeleteRcsAgent' required

Request body

RcsAgentIdstring required

The unique identifier of the RCS agent to delete. You can use either the RcsAgentId or RcsAgentArn.

Response

Success

RcsAgentArnstring required

The Amazon Resource Name (ARN) of the deleted RCS agent.

RcsAgentIdstring required

The unique identifier for the deleted RCS agent.

Status'CREATED' | 'PENDING' | 'TESTING' | 'PARTIAL' | 'ACTIVE' | 'DELETED' required

The current status of the RCS agent.

CreatedTimestampstring date-time required

The time when the RCS agent was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.

DeletionProtectionEnabledboolean required

When set to true deletion protection is enabled. By default this is set to false.

OptOutListNamestring

The name of the OptOutList that was associated with the deleted RCS agent.

SelfManagedOptOutsEnabledboolean required

By default this is set to false. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

TwoWayChannelArnstring

The Amazon Resource Name (ARN) of the two way channel.

TwoWayChannelRolestring

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

TwoWayEnabledboolean required

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

TwoWayRcsEventsEnabledRcsEventType[]

The list of RCS event types that were enabled for two-way messaging on the deleted agent.