# CreateOptOutList Creates a new opt-out list. If the opt-out list name already exists, an error is returned. An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see [ SMS opt out ](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-manage.html#channels-sms-manage-optout) in the AWS End User Messaging SMS User Guide. ## Request Syntax ``` { "ClientToken": "string", "OptOutListName": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientToken](#API_CreateOptOutList_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[!-~]+` Required: No ** [OptOutListName](#API_CreateOptOutList_RequestSyntax) ** The name of the new OptOutList. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[A-Za-z0-9_-]+` Required: Yes ** [Tags](#API_CreateOptOutList_RequestSyntax) ** An array of tags (key and value pairs) to associate with the new OptOutList. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` { "CreatedTimestamp": number, "OptOutListArn": "string", "OptOutListName": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedTimestamp](#API_CreateOptOutList_ResponseSyntax) ** The time when the pool was created, in [UNIX epoch time](https://www.epochconverter.com/) format. Type: Timestamp ** [OptOutListArn](#API_CreateOptOutList_ResponseSyntax) ** The Amazon Resource Name (ARN) for the OptOutList. Type: String ** [OptOutListName](#API_CreateOptOutList_ResponseSyntax) ** The name of the new OptOutList. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[A-Za-z0-9_-]+` ** [Tags](#API_CreateOptOutList_ResponseSyntax) ** An array of tags (key and value pairs) associated with the new OptOutList. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request was denied because you don't have sufficient permissions to access the resource. ** Reason ** The reason for the exception. HTTP Status Code: 400 ** ConflictException ** Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. ** Reason ** The reason for the exception. ** ResourceId ** The unique identifier of the request. ** ResourceType ** The type of resource that caused the exception. HTTP Status Code: 400 ** InternalServerException ** The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future. ** RequestId ** The unique identifier of the request. HTTP Status Code: 500 ** ServiceQuotaExceededException ** The request would cause a service quota to be exceeded. ** Reason ** The reason for the exception. HTTP Status Code: 400 ** ThrottlingException ** An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ** ValidationException ** A validation exception for a field. ** Fields ** The field that failed validation. ** Reason ** The reason for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/pinpoint-sms-voice-v2-2022-03-31/CreateOptOutList) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/pinpoint-sms-voice-v2-2022-03-31/CreateOptOutList) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/pinpoint-sms-voice-v2-2022-03-31/CreateOptOutList) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/pinpoint-sms-voice-v2-2022-03-31/CreateOptOutList) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/pinpoint-sms-voice-v2-2022-03-31/CreateOptOutList) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/pinpoint-sms-voice-v2-2022-03-31/CreateOptOutList) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/pinpoint-sms-voice-v2-2022-03-31/CreateOptOutList) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/pinpoint-sms-voice-v2-2022-03-31/CreateOptOutList) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/pinpoint-sms-voice-v2-2022-03-31/CreateOptOutList) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/pinpoint-sms-voice-v2-2022-03-31/CreateOptOutList)