Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Associates the specified origination identity with a pool.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

If the origination identity configuration doesn't match the pool's configuration, an error is returned.

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

Headers

X-Amz-Target'PinpointSMSVoiceV2.AssociateOriginationIdentity' required

Request body

PoolIdstring required
<p>The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_DescribePools.html">DescribePools</a>.</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 PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. You can use <a>DescribePhoneNumbers</a> to find the values for PhoneNumberId and PhoneNumberArn, while <a>DescribeSenderIds</a> can be used 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 new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity. 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 that 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 that is now associated with the origination identity.

PoolIdstring

The PoolId of the pool that is now 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.

All 109 operations