LinkedWhatsAppBusinessAccount
The details of your linked WhatsApp Business Account.
Contents
- arn
-
The ARN of the linked WhatsApp Business Account.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
arn:.*:waba/[0-9a-zA-Z]+Required: Yes
- eventDestinations
-
The event destinations for the linked WhatsApp Business Account.
Type: Array of WhatsAppBusinessAccountEventDestination objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Required: Yes
- id
-
The ID of the linked WhatsApp Business Account, formatted as
waba-01234567890123456789012345678901.Type: String
Length Constraints: Minimum length of 1. Maximum length of 115.
Pattern:
.*(^waba-.*$)|(^arn:.*:waba/[0-9a-zA-Z]+$).*Required: Yes
- linkDate
-
The date the WhatsApp Business Account was linked.
Type: Timestamp
Required: Yes
- phoneNumbers
-
The phone numbers associated with the Linked WhatsApp Business Account.
Type: Array of WhatsAppPhoneNumberSummary objects
Required: Yes
- registrationStatus
-
The registration status of the linked WhatsApp Business Account.
Type: String
Valid Values:
COMPLETE | INCOMPLETERequired: Yes
- wabaId
-
The WhatsApp Business Account ID from meta.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- wabaName
-
The name of the linked WhatsApp Business Account.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 200.
Required: Yes
- datasetId
-
The Meta Conversions API dataset ID associated with this WhatsApp Business Account. This value is a numeric string of 10 to 20 digits. This field is not present when no dataset has been created for this account.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 20.
Pattern:
[0-9]+Required: No
- marketingMessagesOnboardingStatus
-
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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 100.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
