Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Removes the specified origination identity from an existing pool.

If the origination identity isn't associated with the specified pool, an error is returned.

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

Headers

X-Amz-Target'PinpointSMSVoiceV2.DisassociateOriginationIdentity' required

Request body

PoolIdstring required
<p>The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or 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>
OriginationIdentitystring required
<p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use <a>DescribePhoneNumbers</a> find the values for PhoneNumberId and PhoneNumberArn, or use <a>DescribeSenderIds</a> to get the values for SenderId and SenderIdArn.</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>
IsoCountryCodestring

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. This field is optional and is not required for origination identity types that are not country-specific, such as RCS agents.

ClientTokenstring

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

Response

Success

PoolArnstring

The Amazon Resource Name (ARN) of the pool.

PoolIdstring

The PoolId of the pool no longer associated with the origination identity.

OriginationIdentityArnstring

The PhoneNumberArn or SenderIdArn of the origination identity.

OriginationIdentitystring

The PhoneNumberId or SenderId of the origination identity.

IsoCountryCodestring

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.