AWS API Changes

2026/05/13 - AWS End User Messaging Social - 5 updated api methods

Changes Adds parameters to call the GetWhatsAppMessageTemplate and UpdateWhatsAppMessageTemplate APIs with a template name and language code in place of the template ID. Linked WhatsApp accounts also describe whether the WABA is onboarded to Meta's Marketing Messages API.

AssociateWhatsAppBusinessAccount (updated)

Link ¶
Changes (response)

{'linkedWhatsAppBusinessAccountId': 'string'}

This is only used through the Amazon Web Services console during sign-up to associate your WhatsApp Business Account to your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.associate_whatsapp_business_account(
    signupCallback={
        'accessToken': 'string',
        'callbackUrl': 'string'
    },
    setupFinalization={
        'associateInProgressToken': 'string',
        'phoneNumbers': [
            {
                'id': 'string',
                'twoFactorPin': 'string',
                'dataLocalizationRegion': 'string',
                'tags': [
                    {
                        'key': 'string',
                        'value': 'string'
                    },
                ]
            },
        ],
        'phoneNumberParent': 'string',
        'waba': {
            'id': 'string',
            'eventDestinations': [
                {
                    'eventDestinationArn': 'string',
                    'roleArn': 'string'
                },
            ],
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ]
        }
    }
)

type signupCallback:

dict

param signupCallback:

Contains the callback access token.

accessToken (string) -- [REQUIRED]

The access token for your WhatsApp Business Account. The accessToken value is provided by Meta.
callbackUrl (string) --

The URL where WhatsApp will send callback notifications for this account.

type setupFinalization:

dict

param setupFinalization:

A JSON object that contains the phone numbers and WhatsApp Business Account to link to your account.

associateInProgressToken (string) -- [REQUIRED]

An Amazon Web Services access token generated by WhatsAppSignupCallback and used by WhatsAppSetupFinalization.
phoneNumbers (list) -- [REQUIRED]

An array of WabaPhoneNumberSetupFinalization objects containing the details of each phone number associated with the WhatsApp Business Account.
- (dict) --
  
  The registration details for a linked phone number.
  - id (string) -- [REQUIRED]
    
    The unique identifier of the originating phone number associated with the media. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use the GetLinkedWhatsAppBusinessAccount API action to find a phone number's id.
  - twoFactorPin (string) -- [REQUIRED]
    
    The PIN to use for two-step verification. To reset your PIN follow the directions in Updating PIN in the WhatsApp Business Platform Cloud API Reference.
  - dataLocalizationRegion (string) --
    
    The two letter ISO region for the location of where Meta will store data.
    
    Asia–Pacific (APAC)
    - Australia AU
    - Indonesia ID
    - India IN
    - Japan JP
    - Singapore SG
    - South Korea KR
    Europe
    - Germany DE
    - Switzerland CH
    - United Kingdom GB
    Latin America (LATAM)
    - Brazil BR
    Middle East and Africa (MEA)
    - Bahrain BH
    - South Africa ZA
    - United Arab Emirates AE
    North America (NORAM)
    - Canada CA
  - tags (list) --
    
    An array of key and value pair tags.
    - (dict) --
      
      The tag for a resource.
      - key (string) -- [REQUIRED]
        
        The tag key.
      - value (string) --
        
        The tag value.
phoneNumberParent (string) --

Used to add a new phone number to an existing WhatsApp Business Account. This field can't be used when the waba field is present.
waba (dict) --

Used to create a new WhatsApp Business Account and add a phone number. This field can't be used when the phoneNumberParent field is present.
- id (string) --
  
  The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.
- eventDestinations (list) --
  
  The event destinations for the linked WhatsApp Business Account.
  - (dict) --
    
    Contains information on the event destination.
    - eventDestinationArn (string) -- [REQUIRED]
      
      The ARN of the event destination.
    - roleArn (string) --
      
      The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to import phone numbers and write events.
- tags (list) --
  
  An array of key and value pair tags.
  - (dict) --
    
    The tag for a resource.
    - key (string) -- [REQUIRED]
      
      The tag key.
    - value (string) --
      
      The tag value.

rtype:

dict

returns:

Response Syntax

{
    'signupCallbackResult': {
        'associateInProgressToken': 'string',
        'linkedAccountsWithIncompleteSetup': {
            'string': {
                'accountName': 'string',
                'registrationStatus': 'COMPLETE'|'INCOMPLETE',
                'unregisteredWhatsAppPhoneNumbers': [
                    {
                        'arn': 'string',
                        'phoneNumber': 'string',
                        'phoneNumberId': 'string',
                        'metaPhoneNumberId': 'string',
                        'displayPhoneNumberName': 'string',
                        'displayPhoneNumber': 'string',
                        'qualityRating': 'string',
                        'dataLocalizationRegion': 'string'
                    },
                ],
                'wabaId': 'string'
            }
        }
    },
    'statusCode': 123,
    'linkedWhatsAppBusinessAccountId': 'string'
}

Response Structure

(dict) --
- signupCallbackResult (dict) --
  
  Contains your WhatsApp registration status.
  - associateInProgressToken (string) --
    
    An Amazon Web Services access token generated by WhatsAppSignupCallback and used by WhatsAppSetupFinalization.
  - linkedAccountsWithIncompleteSetup (dict) --
    
    A LinkedWhatsAppBusinessAccountIdMetaData object map containing the details of any WhatsAppBusiness accounts that have incomplete setup.
    - (string) --
      - (dict) --
        
        Contains your WhatsApp registration status and details of any unregistered WhatsApp phone number.
        
        accountName (string) --
        
        The name of your account.
        
        registrationStatus (string) --
        
        The registration status of the linked WhatsApp Business Account.
        
        unregisteredWhatsAppPhoneNumbers (list) --
        
        The details for unregistered WhatsApp phone numbers.
        
        (dict) --
        
        The details of your WhatsApp phone number.
        
        arn (string) --
        
        The ARN of the WhatsApp phone number.
        
        phoneNumber (string) --
        
        The phone number for sending WhatsApp.
        
        phoneNumberId (string) --
        
        The phone number ID. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901.
        
        metaPhoneNumberId (string) --
        
        The phone number ID from Meta.
        
        displayPhoneNumberName (string) --
        
        The display name for this phone number.
        
        displayPhoneNumber (string) --
        
        The phone number that appears in the recipients display.
        
        qualityRating (string) --
        
        The quality rating of the phone number.
        
        dataLocalizationRegion (string) --
        
        The geographic region where the WhatsApp phone number's data is stored and processed.
        
        wabaId (string) --
        
        The Amazon Resource Name (ARN) of the WhatsApp Business Account ID.
- statusCode (integer) --
  
  The status code for the response.
- linkedWhatsAppBusinessAccountId (string) --
  
  The ID of the WhatsApp Business Account that was linked to your Amazon Web Services account.

GetLinkedWhatsAppBusinessAccount (updated)

Link ¶
Changes (response)

{'account': {'marketingMessagesOnboardingStatus': 'string'}}

Get the details of your linked WhatsApp Business Account.

See also: AWS API Documentation

Request Syntax

client.get_linked_whatsapp_business_account(
    id='string'
)

type id:

string

param id:

[REQUIRED]

The unique identifier, from Amazon Web Services, of the linked WhatsApp Business Account. WABA identifiers are formatted as waba-01234567890123456789012345678901. Use ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.

rtype:

dict

returns:

Response Syntax

{
    'account': {
        'arn': 'string',
        'id': 'string',
        'wabaId': 'string',
        'registrationStatus': 'COMPLETE'|'INCOMPLETE',
        'linkDate': datetime(2015, 1, 1),
        'wabaName': 'string',
        'eventDestinations': [
            {
                'eventDestinationArn': 'string',
                'roleArn': 'string'
            },
        ],
        'marketingMessagesOnboardingStatus': 'string',
        'phoneNumbers': [
            {
                'arn': 'string',
                'phoneNumber': 'string',
                'phoneNumberId': 'string',
                'metaPhoneNumberId': 'string',
                'displayPhoneNumberName': 'string',
                'displayPhoneNumber': 'string',
                'qualityRating': 'string',
                'dataLocalizationRegion': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- account (dict) --
  
  The details of the linked WhatsApp Business Account.
  - arn (string) --
    
    The ARN of the linked WhatsApp Business Account.
  - id (string) --
    
    The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.
  - wabaId (string) --
    
    The WhatsApp Business Account ID from meta.
  - registrationStatus (string) --
    
    The registration status of the linked WhatsApp Business Account.
  - linkDate (datetime) --
    
    The date the WhatsApp Business Account was linked.
  - wabaName (string) --
    
    The name of the linked WhatsApp Business Account.
  - eventDestinations (list) --
    
    The event destinations for the linked WhatsApp Business Account.
    - (dict) --
      
      Contains information on the event destination.
      - eventDestinationArn (string) --
        
        The ARN of the event destination.
      - roleArn (string) --
        
        The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to import phone numbers and write events.
  - marketingMessagesOnboardingStatus (string) --
    
    The onboarding status for the Marketing Messages API. This value is fetched from Meta and indicates whether the WhatsApp Business Account is onboarded for Meta's Marketing Messages API.
  - phoneNumbers (list) --
    
    The phone numbers associated with the Linked WhatsApp Business Account.
    - (dict) --
      
      The details of a linked phone number.
      - arn (string) --
        
        The full Amazon Resource Name (ARN) for the phone number.
      - phoneNumber (string) --
        
        The phone number associated with the Linked WhatsApp Business Account.
      - phoneNumberId (string) --
        
        The phone number ID. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901.
      - metaPhoneNumberId (string) --
        
        The phone number ID from Meta.
      - displayPhoneNumberName (string) --
        
        The display name for this phone number.
      - displayPhoneNumber (string) --
        
        The phone number that appears in the recipients display.
      - qualityRating (string) --
        
        The quality rating of the phone number. This is from Meta.
      - dataLocalizationRegion (string) --
        
        The geographic region where the WhatsApp phone number's data is stored and processed.

GetWhatsAppMessageTemplate (updated)

Link ¶
Changes (request)

{'templateLanguageCode': 'string', 'templateName': 'string'}

Retrieves a specific WhatsApp message template.

See also: AWS API Documentation

Request Syntax

client.get_whats_app_message_template(
    metaTemplateId='string',
    id='string',
    templateName='string',
    templateLanguageCode='string'
)

type metaTemplateId:

string

param metaTemplateId:

The numeric ID of the template assigned by Meta.

type id:

string

param id:

[REQUIRED]

The ID of the WhatsApp Business Account associated with this template.

type templateName:

string

param templateName:

The name of the message template. Use together with templateLanguageCode as an alternative to metaTemplateId to identify a template.

type templateLanguageCode:

string

param templateLanguageCode:

The language code of the message template (for example, en or en_US). Use together with templateName as an alternative to metaTemplateId to identify a template.

rtype:

dict

returns:

Response Syntax

{
    'template': 'string'
}

Response Structure

(dict) --
- template (string) --
  
  The complete template definition as a JSON string (maximum 6000 characters).

ListLinkedWhatsAppBusinessAccounts (updated)

Link ¶
Changes (response)

{'linkedAccounts': {'marketingMessagesOnboardingStatus': 'string'}}

List all WhatsApp Business Accounts linked to your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.list_linked_whatsapp_business_accounts(
    nextToken='string',
    maxResults=123
)

type nextToken:

string

param nextToken:

The next token for pagination.

type maxResults:

integer

param maxResults:

The maximum number of results to return.

rtype:

dict

returns:

Response Syntax

{
    'linkedAccounts': [
        {
            'arn': 'string',
            'id': 'string',
            'wabaId': 'string',
            'registrationStatus': 'COMPLETE'|'INCOMPLETE',
            'linkDate': datetime(2015, 1, 1),
            'wabaName': 'string',
            'eventDestinations': [
                {
                    'eventDestinationArn': 'string',
                    'roleArn': 'string'
                },
            ],
            'marketingMessagesOnboardingStatus': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- linkedAccounts (list) --
  
  A list of WhatsApp Business Accounts linked to your Amazon Web Services account.
  - (dict) --
    
    The details of a linked WhatsApp Business Account.
    - arn (string) --
      
      The ARN of the linked WhatsApp Business Account.
    - id (string) --
      
      The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.
    - wabaId (string) --
      
      The WhatsApp Business Account ID provided by Meta.
    - registrationStatus (string) --
      
      The registration status of the linked WhatsApp Business Account.
    - linkDate (datetime) --
      
      The date the WhatsApp Business Account was linked.
    - wabaName (string) --
      
      The name of the linked WhatsApp Business Account.
    - eventDestinations (list) --
      
      The event destinations for the linked WhatsApp Business Account.
      - (dict) --
        
        Contains information on the event destination.
        
        eventDestinationArn (string) --
        
        The ARN of the event destination.
        
        roleArn (string) --
        
        The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to import phone numbers and write events.
    - marketingMessagesOnboardingStatus (string) --
      
      The onboarding status for the Marketing Messages API. This value is fetched from Meta and indicates whether the WhatsApp Business Account is onboarded for Meta's Marketing Messages API.
- nextToken (string) --
  
  The next token for pagination.

UpdateWhatsAppMessageTemplate (updated)

Link ¶
Changes (request)

{'templateLanguageCode': 'string', 'templateName': 'string'}

Updates an existing WhatsApp message template.

See also: AWS API Documentation

Request Syntax

client.update_whats_app_message_template(
    id='string',
    metaTemplateId='string',
    templateName='string',
    templateLanguageCode='string',
    parameterFormat='string',
    templateCategory='string',
    templateComponents=b'bytes',
    ctaUrlLinkTrackingOptedOut=True|False
)

type id:

string

param id:

[REQUIRED]

The ID of the WhatsApp Business Account associated with this template.

type metaTemplateId:

string

param metaTemplateId:

The numeric ID of the template assigned by Meta.

type templateName:

string

param templateName:

The name of the message template. Use together with templateLanguageCode as an alternative to metaTemplateId to identify a template.

type templateLanguageCode:

string

param templateLanguageCode:

The language code of the message template (for example, en or en_US). Use together with templateName as an alternative to metaTemplateId to identify a template.

type parameterFormat:

string

param parameterFormat:

The format specification for parameters in the template, this can be either 'named' or 'positional'.

type templateCategory:

string

param templateCategory:

The new category for the template (for example, UTILITY or MARKETING).

type templateComponents:

bytes

param templateComponents:

The updated components of the template as a JSON blob (maximum 3000 characters).

type ctaUrlLinkTrackingOptedOut:

boolean

param ctaUrlLinkTrackingOptedOut:

When true, disables click tracking for call-to-action URL buttons in the template.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --