PutWhatsAppBusinessAccountEventDestinations - AWS End User Messaging Social

PutWhatsAppBusinessAccountEventDestinations

Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA). A WABA can only have one event destination at a time. All resources associated with the WABA use the same event destination.

Request Syntax

PUT /v1/whatsapp/waba/eventdestinations HTTP/1.1 Content-type: application/json { "eventDestinations": [ { "eventDestinationArn": "string", "roleArn": "string" } ], "id": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

eventDestinations

An array of WhatsAppBusinessAccountEventDestination event destinations.

Type: Array of WhatsAppBusinessAccountEventDestination objects

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Required: Yes

id

The unique identifier of your WhatsApp Business Account. WABA identifiers are formatted as waba-01234567890123456789012345678901. Use ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: .*(^waba-.*$)|(^arn:.*:waba/[0-9a-zA-Z]+$).*

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServiceException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

InvalidParametersException

One or more parameters provided to the action are not valid.

HTTP Status Code: 400

ThrottledRequestException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request contains an invalid parameter value.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: