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

ListWhatsAppTemplateLibrary

Lists templates available in Meta's template library for WhatsApp messaging.

Request Syntax


POST /v1/whatsapp/template/library?id=id HTTP/1.1
Content-type: application/json

{
   "filters": { 
      "string" : "string" 
   },
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

id

The ID of the WhatsApp Business Account to list library templates for.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

filters

Map of filters to apply (searchKey, topic, usecase, industry, language).

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 10 items.

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

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

Required: No

maxResults

The maximum number of results to return per page (1-100).

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

The token for the next page of results.

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "metaLibraryTemplates": [ 
      { 
         "templateBody": "string",
         "templateButtons": [ 
            { 
               "otpType": "string",
               "phoneNumber": "string",
               "supportedApps": [ 
                  { 
                     "string" : "string" 
                  }
               ],
               "text": "string",
               "type": "string",
               "url": "string",
               "zeroTapTermsAccepted": boolean
            }
         ],
         "templateCategory": "string",
         "templateHeader": "string",
         "templateId": "string",
         "templateIndustry": [ "string" ],
         "templateLanguage": "string",
         "templateName": "string",
         "templateTopic": "string",
         "templateUseCase": "string"
      }
   ],
   "nextToken": "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.

metaLibraryTemplates

A list of templates from Meta's library.

Type: Array of MetaLibraryTemplateDefinition objects

nextToken

The token to retrieve the next page of results, if any.

Type: String

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

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