Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateWhatsAppMessageTemplateMedia

Uploads media for use in a WhatsApp message template.

Request Syntax


POST /v1/whatsapp/template/media HTTP/1.1
Content-type: application/json

{
   "id": "string",
   "sourceS3File": { 
      "bucketName": "string",
      "key": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

id

The ID of the WhatsApp Business Account associated with this media upload.

Type: String

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

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

Required: Yes

sourceS3File

Contains information for the S3 bucket that contains media files.

Type: S3File object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "metaHeaderHandle": "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.

metaHeaderHandle

The handle assigned to the uploaded media by Meta, used to reference the media in templates.

Type: String

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

DependencyException

Thrown when performing an action because a dependency would be broken.

HTTP Status Code: 502

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

ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404

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