Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Deletes an existing keyword from an origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, End User Messaging SMS responds with a customizable message.

Keywords "HELP" and "STOP" can't be deleted or modified.

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

Headers

X-Amz-Target'PinpointSMSVoiceV2.DeleteKeyword' required

Request body

OriginationIdentitystring required
<p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use <a>DescribePhoneNumbers</a> to find the values for PhoneNumberId and PhoneNumberArn and <a>DescribePools</a> to find the values of PoolId and PoolArn.</p> <important> <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p> </important>
Keywordstring required

The keyword to delete.

Response

Success

OriginationIdentityArnstring

The PhoneNumberArn or PoolArn that the keyword was associated with.

OriginationIdentitystring

The PhoneNumberId or PoolId that the keyword was associated with.

Keywordstring

The keyword that was deleted.

KeywordMessagestring

The message that was associated with the deleted keyword.

KeywordAction'AUTOMATIC_RESPONSE' | 'OPT_OUT' | 'OPT_IN'

The action that was associated with the deleted keyword.