# List all templates for a specific name

Returns a paginated list of templates for the specified project and name. If no page token is supplied then the first 50 templates are returned in alphabetical order.

Endpoint: GET /v1/projects/{projectId}/whatsapp/templates/{templateName}
Version: 1.2.91
Security: BasicAuth, BearerAuth, OAuth2Production

## Path parameters:

  - `projectId` (string, required)
    The unique ID of the project. You can find this on the Sinch Dashboard.

  - `templateName` (string, required)
    The unique name of the template.

## Query parameters:

  - `pageToken` (string)
    The page token if retrieving the next page from a previous query.

  - `pageSize` (number)
    The page size requested.

  - `fieldMask` (array)
    Field masks are a way for API callers to list the fields that a request should return.
    Enum: "whatsappId", "state", "name", "language", "category", "rejectionCode", "qualityScore", "changes", "changes.status", "changes.allowCategoryChange", "changes.details", "changes.details.components", "changes.details.components.0.type", "changes.details.components.0.format", "changes.details.components.0.text", "changes.details.components.0.example", "changes.details.components.0.example.url", "changes.details.components.0.examples", "changes.details.components.0.addSecurityRecommendation", "changes.details.components.0.codeExpirationMinutes", "changes.details.components.0.buttons", "changes.details.components.0.buttons.0.type", "changes.details.components.0.buttons.0.text", "changes.details.components.0.buttons.0.phoneNumber", "changes.details.components.0.buttons.0.url", "changes.details.components.0.buttons.0.example", "changes.details.components.0.buttons.0.otpType", "changes.details.components.0.buttons.0.autofillText", "changes.details.components.0.buttons.0.packageName", "changes.details.components.0.buttons.0.signatureHash", "changes.details.components.0.buttons.0.supportedApps", "changes.details.components.0.buttons.0.supportedApps.0.packageName", "changes.details.components.0.buttons.0.supportedApps.0.signatureHash", "changes.details.components.0.buttons.0.zeroTapTermsAccepted", "changes.details.components.0.buttons.0.flowId", "changes.details.components.0.buttons.0.flowAction", "changes.details.components.0.buttons.0.navigateScreen", "changes.details.messageSendTtlSeconds", "details", "details.components", "details.components.0.type", "details.components.0.format", "details.components.0.text", "details.components.0.example", "details.components.0.example.url", "details.components.0.examples", "details.components.0.addSecurityRecommendation", "details.components.0.codeExpirationMinutes", "details.components.0.buttons", "details.components.0.buttons.0.type", "details.components.0.buttons.0.text", "details.components.0.buttons.0.phoneNumber", "details.components.0.buttons.0.url", "details.components.0.buttons.0.example", "details.components.0.buttons.0.otpType", "details.components.0.buttons.0.autofillText", "details.components.0.buttons.0.packageName", "details.components.0.buttons.0.signatureHash", "details.components.0.buttons.0.supportedApps", "details.components.0.buttons.0.supportedApps.0.packageName", "details.components.0.buttons.0.supportedApps.0.signatureHash", "details.components.0.buttons.0.zeroTapTermsAccepted", "details.components.0.buttons.0.flowId", "details.components.0.buttons.0.flowAction", "details.components.0.buttons.0.navigateScreen", "details.messageSendTtlSeconds", "analytics", "analytics.0.sent", "analytics.0.delivered", "analytics.0.read", "analytics.0.start", "analytics.0.end", "analytics.0.buttons", "analytics.0.buttons.0.type", "analytics.0.buttons.0.content", "analytics.0.buttons.0.clicks", "isMetaGenerated"

  - `templateAnalyticsDateRange` (string)
    The date range to retrieve template analytics for. Fallback to DAY if none is set.
    Enum: "DAY", "MONTH", "QUARTER", "WEEK"

## Response 200 fields (application/json):

  - `body` (WhatsappTemplateListDto (object) or WhatsappPartialTemplateListDto (object)) — one of:
    - WhatsappTemplateListDto:
      - `totalSize` (number, required)
        Total size of the entries matching the search query.
      - `pageSize` (number, required)
        Requested size of the page.
      - `templates` (array, required)
      - `templates.name` (string, required)
      - `templates.language` (string, required)
        Enum: "AF", "AR", "AZ", "BG", "BN", "CA", "CS", "DA", "DE", "EL", "EN", "EN_GB", "EN_US", "ES", "ES_AR", "ES_ES", "ES_MX", "ES_UY", "ET", "FA", "FI", "FIL", "FR", "GA", "GU", "HA", "HE", "HI", "HR", "HU", "ID", "IT", "JA", "KA", "KK", "KN", "KO", "KY_KG", "LO", "LT", "LV", "MK", "ML", "MR", "MS", "NB", "NL", "PA", "PL", "PT_BR", "PT_PT", "RO", "RU", "RW_RW", "SK", "SL", "SQ", "SR", "SV", "SW", "TA", "TE", "TH", "TR", "UK", "UR", "UZ", "VI", "ZH_CN", "ZH_HK", "ZH_TW", "ZU", "UNRECOGNIZED"
      - `templates.category` (string, required)
        Enum: "AUTHENTICATION", "MARKETING", "UTILITY", "UNRECOGNIZED"
      - `templates.analytics` (array, required)
        Template analytics.
      - `templates.analytics.sent` (number, required)
        Number of times template has been sent.
      - `templates.analytics.delivered` (number, required)
        Number of times template has been delivered.
      - `templates.analytics.read` (number, required)
        Number of times template has been read.
      - `templates.analytics.start` (string, required)
        The UTC Date Time in ISO 8601 for start of date range.
      - `templates.analytics.end` (string, required)
        The UTC Date Time in ISO 8601 for end of date range.
      - `templates.analytics.buttons` (array, required)
        Number of times buttons in the template has been clicked.
      - `templates.analytics.buttons.type` (string, required)
        Type of button.
        Enum: "QUICK_REPLY", "UNIQUE_URL", "URL", "UNRECOGNIZED"
      - `templates.analytics.buttons.content` (string, required)
        Content of the button.
      - `templates.analytics.buttons.clicks` (number, required)
        Number of times the button has been clicked.
      - `templates.isMetaGenerated` (boolean, required)
        Indicates if the template was auto-generated by Meta.
      - `templates.whatsappId` (string)
      - `templates.state` (string)
        Enum: "APPROVED", "DISABLED", "PAUSED", "REJECTED"
      - `templates.rejectionCode` (string)
        Rejection code if template is in status 'REJECTED'
        Enum: "ABUSIVE_CONTENT", "INCORRECT_CATEGORY", "INVALID_FORMAT", "NONE", "SCAM", "UNRECOGNIZED"
      - `templates.qualityScore` (string)
        Quality score of the HSM.
        Enum: "QUALITY_SCORE_GREEN", "QUALITY_SCORE_RED", "QUALITY_SCORE_YELLOW", "QUALITY_SCORE_UNKNOWN", "UNRECOGNIZED"
      - `templates.changes` (object)
        Object containing changes on the template. If empty the changes has been approved and applied to the template.
      - `templates.changes.status` (string, required)
        The current status of the changes.
    
    DRAFT: The changes has not been submitted.
    IN_PROGRESS: The changes has been submitted.
        Enum: "DRAFT", "IN_PROGRESS", "REJECTED"
      - `templates.changes.allowCategoryChange` (boolean)
        True if Meta should be allowed to change the category if they determine the category is wrong. If false, Meta might reject the template if they determine the category is wrong based on the template contents. Defaults to false.
      - `templates.changes.details` (array) — one of:
        Template details and information.
        - WhatsappTemplateDetailsDto:
          - `components` (array, required) — one of:
            List of components in the template. Must contain a BODY component and can only have one entry of each type.
            - WhatsappTextHeaderComponentDto:
              - `type` (string, required)
                Enum: "HEADER"
              - `format` (string, required)
                Enum: "TEXT"
              - `text` (string)
                Text to show in the header
              - `example` (string)
                Example for the header variable.
            - WhatsappMediaHeaderComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
              - `format` (string, required)
                Enum: "DOCUMENT", "IMAGE", "VIDEO"
              - `example` (object)
              - `example.url` (string)
            - WhatsappBodyComponentDto:
              - `type` (string, required)
                Enum: "BODY"
              - `text` (string)
              - `examples` (array)
                Examples for the body variables.
              - `addSecurityRecommendation` (boolean)
            - WhatsappFooterComponentDto:
              - `type` (string, required)
                Enum: "FOOTER"
              - `text` (string)
              - `codeExpirationMinutes` (number)
            - WhatsappButtonsComponentDto:
              - `type` (string, required)
                Enum: "BUTTONS"
              - `buttons` (array, required) — one of:
                - WhatsappPhoneNumberButtonDto:
                  - `type` (string, required)
                    Enum: "PHONE_NUMBER"
                  - `text` (string)
                  - `phoneNumber` (string)
                - WhatsappUrlButtonDto:
                  - `type` (string, required)
                    Enum: "URL"
                  - `text` (string)
                  - `url` (string)
                  - `example` (string)
                - WhatsappQuickReplyButtonDto:
                  - `type` (string, required)
                    Enum: "QUICK_REPLY"
                  - `text` (string)
                - WhatsappOtpButtonDto:
                  - `type` (string, required)
                    Enum: "OTP"
                  - `otpType` (string, required)
                    Enum: "COPY_CODE", "ONE_TAP", "ZERO_TAP", "UNRECOGNIZED"
                  - `text` (string)
                  - `autofillText` (string)
                  - `supportedApps` (array)
                  - `zeroTapTermsAccepted` (boolean)
                  - `packageName` (string)
                  - `signatureHash` (string)
                - WhatsappFlowButtonDto:
                  - `type` (string, required)
                    Enum: "FLOW"
                  - `text` (string)
                    Text to display on the Flow button
                  - `flowId` (string)
                    Flow ID to launch when button is pressed
                  - `flowAction` (string)
                    Flow action
                    Enum: "DATA_EXCHANGE", "NAVIGATE", "UNKNOWN", "UNRECOGNIZED"
                  - `navigateScreen` (string)
                    The unique ID of the first screen. Required for Navigate action.
                - WhatsappRequestContactInfoButtonDto:
                  - `type` (string, required)
                    Enum: "REQUEST_CONTACT_INFO"
                  - `text` (string)
            - WhatsappLocationHeaderComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
              - `format` (string, required)
                Enum: "LOCATION"
            - WhatsappCarouselComponentDto:
              - `type` (string, required)
                Enum: "CAROUSEL"
              - `cards` (array, required)
                Media cards.
              - `cards.components` (array, required)
                List of components in the cards.
          - `messageSendTtlSeconds` (number)
            Template message delivery retry time-to-live (TTL) override value. If unable to deliver the template message, it will be periodically retry for this period of time. If it is unable to deliver the message for this period of time, the message will be dropped.

|  | AUTHENTICATION | MARKETING | UTILITY |
| -- | -- | -- | -- |
| Default | 10 minutes | 30 days | 30 days |
| Customizable range | 10 seconds to 15 minutes | 12 hours to 30 days | 30 seconds to 12 hours |
| Valid values | 10 to 900 seconds | 43200 to 2592000 seconds | 30 to 43200 seconds |

  Please note that authentication templates created before October 23, 2024, have a default TTL of 30 days.
        - WhatsappTemplateChangesDetailsDto:
          - `components` (array) — one of:
            The current status of the changes.
    
    DRAFT: The changes has not been submitted.
    IN_PROGRESS: The changes has been submitted.
            - WhatsappTextHeaderComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
              - `format` (string, required)
                Enum: same as `format` in "WhatsappTextHeaderComponentDto" (1 values)
              - `text` (string)
                Text to show in the header
              - `example` (string)
                Example for the header variable.
            - WhatsappMediaHeaderComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
              - `format` (string, required)
                Enum: same as `format` in "WhatsappMediaHeaderComponentDto" (3 values)
              - `example` (object)
              - `example.url` (string)
            - WhatsappLocationHeaderComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
              - `format` (string, required)
                Enum: same as `format` in "WhatsappLocationHeaderComponentDto" (1 values)
            - WhatsappBodyComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappBodyComponentDto" (1 values)
              - `text` (string)
              - `examples` (array)
                Examples for the body variables.
              - `addSecurityRecommendation` (boolean)
            - WhatsappFooterComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappFooterComponentDto" (1 values)
              - `text` (string)
              - `codeExpirationMinutes` (number)
            - WhatsappButtonsComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappButtonsComponentDto" (1 values)
              - `buttons` (array, required) — one of:
                - WhatsappPhoneNumberButtonDto:
                  - `type` (string, required)
                    Enum: same as `type` in "WhatsappPhoneNumberButtonDto" (1 values)
                  - `text` (string)
                  - `phoneNumber` (string)
                - WhatsappUrlButtonDto:
                  - `type` (string, required)
                    Enum: same as `type` in "WhatsappUrlButtonDto" (1 values)
                  - `text` (string)
                  - `url` (string)
                  - `example` (string)
                - WhatsappQuickReplyButtonDto:
                  - `type` (string, required)
                    Enum: same as `type` in "WhatsappQuickReplyButtonDto" (1 values)
                  - `text` (string)
                - WhatsappOtpButtonDto:
                  - `type` (string, required)
                    Enum: same as `type` in "WhatsappOtpButtonDto" (1 values)
                  - `otpType` (string, required)
                    Enum: same as `otpType` in "WhatsappOtpButtonDto" (4 values)
                  - `text` (string)
                  - `autofillText` (string)
                  - `supportedApps` (array)
                  - `zeroTapTermsAccepted` (boolean)
                  - `packageName` (string)
                  - `signatureHash` (string)
                - WhatsappFlowButtonDto:
                  - `type` (string, required)
                    Enum: same as `type` in "WhatsappFlowButtonDto" (1 values)
                  - `text` (string)
                    Text to display on the Flow button
                  - `flowId` (string)
                    Flow ID to launch when button is pressed
                  - `flowAction` (string)
                    Flow action
                    Enum: same as `flowAction` in "WhatsappFlowButtonDto" (4 values)
                  - `navigateScreen` (string)
                    The unique ID of the first screen. Required for Navigate action.
                - WhatsappRequestContactInfoButtonDto:
                  - `type` (string, required)
                    Enum: same as `type` in "WhatsappRequestContactInfoButtonDto" (1 values)
                  - `text` (string)
            - WhatsappCarouselComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappCarouselComponentDto" (1 values)
              - `cards` (array, required)
                Media cards.
              - `cards.components` (array, required)
                List of components in the cards.
          - `messageSendTtlSeconds` (number)
            Template message delivery retry time-to-live (TTL) override value. If unable to deliver the template message, it will be periodically retry for this period of time. If it is unable to deliver the message for this period of time, the message will be dropped.

|  | AUTHENTICATION | MARKETING | UTILITY |
| -- | -- | -- | -- |
| Default | 10 minutes | 30 days | 30 days |
| Customizable range | 10 seconds to 15 minutes | 12 hours to 30 days | 30 seconds to 12 hours |
| Valid values | 10 to 900 seconds | 43200 to 2592000 seconds | 30 to 43200 seconds |

  Please note that authentication templates created before October 23, 2024, have a default TTL of 30 days.
      - `templates.details` (object)
        Template details and information.
      - `templates.details.components` (array, required) — one of:
        List of components in the template. Must contain a BODY component and can only have one entry of each type.
        - WhatsappTextHeaderComponentDto:
          - `type` (string, required)
            Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
          - `format` (string, required)
            Enum: same as `format` in "WhatsappTextHeaderComponentDto" (1 values)
          - `text` (string)
            Text to show in the header
          - `example` (string)
            Example for the header variable.
        - WhatsappMediaHeaderComponentDto:
          - `type` (string, required)
            Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
          - `format` (string, required)
            Enum: same as `format` in "WhatsappMediaHeaderComponentDto" (3 values)
          - `example` (object)
          - `example.url` (string)
        - WhatsappBodyComponentDto:
          - `type` (string, required)
            Enum: same as `type` in "WhatsappBodyComponentDto" (1 values)
          - `text` (string)
          - `examples` (array)
            Examples for the body variables.
          - `addSecurityRecommendation` (boolean)
        - WhatsappFooterComponentDto:
          - `type` (string, required)
            Enum: same as `type` in "WhatsappFooterComponentDto" (1 values)
          - `text` (string)
          - `codeExpirationMinutes` (number)
        - WhatsappButtonsComponentDto:
          - `type` (string, required)
            Enum: same as `type` in "WhatsappButtonsComponentDto" (1 values)
          - `buttons` (array, required) — one of:
            - WhatsappPhoneNumberButtonDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappPhoneNumberButtonDto" (1 values)
              - `text` (string)
              - `phoneNumber` (string)
            - WhatsappUrlButtonDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappUrlButtonDto" (1 values)
              - `text` (string)
              - `url` (string)
              - `example` (string)
            - WhatsappQuickReplyButtonDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappQuickReplyButtonDto" (1 values)
              - `text` (string)
            - WhatsappOtpButtonDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappOtpButtonDto" (1 values)
              - `otpType` (string, required)
                Enum: same as `otpType` in "WhatsappOtpButtonDto" (4 values)
              - `text` (string)
              - `autofillText` (string)
              - `supportedApps` (array)
              - `supportedApps.packageName` (string, required)
              - `supportedApps.signatureHash` (string, required)
              - `zeroTapTermsAccepted` (boolean)
              - `packageName` (string)
              - `signatureHash` (string)
            - WhatsappFlowButtonDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappFlowButtonDto" (1 values)
              - `text` (string)
                Text to display on the Flow button
              - `flowId` (string)
                Flow ID to launch when button is pressed
              - `flowAction` (string)
                Flow action
                Enum: same as `flowAction` in "WhatsappFlowButtonDto" (4 values)
              - `navigateScreen` (string)
                The unique ID of the first screen. Required for Navigate action.
            - WhatsappRequestContactInfoButtonDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappRequestContactInfoButtonDto" (1 values)
              - `text` (string)
        - WhatsappLocationHeaderComponentDto:
          - `type` (string, required)
            Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
          - `format` (string, required)
            Enum: same as `format` in "WhatsappLocationHeaderComponentDto" (1 values)
        - WhatsappCarouselComponentDto:
          - `type` (string, required)
            Enum: same as `type` in "WhatsappCarouselComponentDto" (1 values)
          - `cards` (array, required)
            Media cards.
          - `cards.components` (array, required) — one of:
            List of components in the cards.
            - WhatsappCardHeaderComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
              - `format` (string, required)
                Card header format.
                Enum: "IMAGE", "VIDEO"
              - `example` (object)
                Uploaded media asset handle.
            - WhatsappCardBodyComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappBodyComponentDto" (1 values)
              - `examples` (array)
                Examples for the body variables.
              - `text` (string)
                Card body text.
            - WhatsappCardButtonsComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappButtonsComponentDto" (1 values)
              - `buttons` (array, required)
                Card buttons.
      - `templates.details.messageSendTtlSeconds` (number)
        Template message delivery retry time-to-live (TTL) override value. If unable to deliver the template message, it will be periodically retry for this period of time. If it is unable to deliver the message for this period of time, the message will be dropped.

|  | AUTHENTICATION | MARKETING | UTILITY |
| -- | -- | -- | -- |
| Default | 10 minutes | 30 days | 30 days |
| Customizable range | 10 seconds to 15 minutes | 12 hours to 30 days | 30 seconds to 12 hours |
| Valid values | 10 to 900 seconds | 43200 to 2592000 seconds | 30 to 43200 seconds |

  Please note that authentication templates created before October 23, 2024, have a default TTL of 30 days.
      - `previousPageToken` (string)
        Encoded token to use in list request to fetch previous batch of entries.
      - `nextPageToken` (string)
        Encoded token to use in list request to fetch next batch of entries.
    - WhatsappPartialTemplateListDto:
      - `totalSize` (number, required)
        Total size of the entries matching the search query.
      - `pageSize` (number, required)
        Requested size of the page.
      - `templates` (array, required)
      - `templates.whatsappId` (string)
      - `templates.state` (string)
        Enum: same as `templates.state` in "WhatsappTemplateListDto" (4 values)
      - `templates.name` (string)
      - `templates.language` (string)
        Enum: same as `templates.language` in "WhatsappTemplateListDto" (73 values)
      - `templates.category` (string)
        Enum: same as `templates.category` in "WhatsappTemplateListDto" (4 values)
      - `templates.rejectionCode` (string)
        Rejection code if template is in status 'REJECTED'
        Enum: same as `templates.rejectionCode` in "WhatsappTemplateListDto" (6 values)
      - `templates.qualityScore` (string)
        Quality score of the HSM.
        Enum: same as `templates.qualityScore` in "WhatsappTemplateListDto" (5 values)
      - `templates.isMetaGenerated` (boolean)
        Indicates if the template was auto-generated by Meta.
      - `templates.changes` (object)
        Object containing changes on the template. If empty the changes has been approved and applied to the template.
      - `templates.changes.status` (string)
        The current status of the changes.
    
    DRAFT: The changes has not been submitted.
    IN_PROGRESS: The changes has been submitted.
        Enum: same as `templates.changes.status` in "WhatsappTemplateListDto" (3 values)
      - `templates.changes.allowCategoryChange` (boolean)
        True if Meta should be allowed to change the category if they determine the category is wrong. If false, Meta might reject the template if they determine the category is wrong based on the template contents. Defaults to false.
      - `templates.changes.details` (array) — one of:
        Template details and information.
        - WhatsappPartialTemplateDetailsDto:
          - `messageSendTtlSeconds` (number)
            Template message delivery retry time-to-live (TTL) override value. If unable to deliver the template message, it will be periodically retry for this period of time. If it is unable to deliver the message for this period of time, the message will be dropped.

|  | AUTHENTICATION | MARKETING | UTILITY |
| -- | -- | -- | -- |
| Default | 10 minutes | 30 days | 30 days |
| Customizable range | 10 seconds to 15 minutes | 12 hours to 30 days | 30 seconds to 12 hours |
| Valid values | 10 to 900 seconds | 43200 to 2592000 seconds | 30 to 43200 seconds |

  Please note that authentication templates created before October 23, 2024, have a default TTL of 30 days.
          - `components` (array) — one of:
            List of components in the template. Must contain a BODY component and can only have one entry of each type.
            - WhatsappPartialTextHeaderComponentDto:
              - `type` (string)
                Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
              - `format` (string)
                Enum: same as `format` in "WhatsappTextHeaderComponentDto" (1 values)
              - `text` (string)
                Text to show in the header
              - `example` (string)
                Example for the header variable.
            - WhatsappPartialMediaHeaderComponentDto:
              - `type` (string)
                Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
              - `format` (string)
                Enum: same as `format` in "WhatsappMediaHeaderComponentDto" (3 values)
              - `example` (object)
              - `example.url` (string)
            - WhatsappPartialBodyComponentDto:
              - `type` (string)
                Enum: same as `type` in "WhatsappBodyComponentDto" (1 values)
              - `text` (string)
              - `examples` (array)
                Examples for the body variables.
              - `addSecurityRecommendation` (boolean)
            - WhatsappPartialFooterComponentDto:
              - `type` (string)
                Enum: same as `type` in "WhatsappFooterComponentDto" (1 values)
              - `text` (string)
              - `codeExpirationMinutes` (number)
            - WhatsappPartialButtonsComponentDto:
              - `type` (string)
                Enum: same as `type` in "WhatsappButtonsComponentDto" (1 values)
              - `buttons` (array) — one of:
                - WhatsappPartialPhoneNumberButtonDto:
                  - `type` (string)
                    Enum: same as `type` in "WhatsappPhoneNumberButtonDto" (1 values)
                  - `text` (string)
                  - `phoneNumber` (string)
                - WhatsappPartialUrlButtonDto:
                  - `type` (string)
                    Enum: same as `type` in "WhatsappUrlButtonDto" (1 values)
                  - `text` (string)
                  - `url` (string)
                  - `example` (string)
                - WhatsappPartialQuickReplyButtonDto:
                  - `type` (string)
                    Enum: same as `type` in "WhatsappQuickReplyButtonDto" (1 values)
                  - `text` (string)
                - WhatsappPartialOtpButtonDto:
                  - `type` (string)
                    Enum: same as `type` in "WhatsappOtpButtonDto" (1 values)
                  - `otpType` (string)
                    Enum: same as `otpType` in "WhatsappOtpButtonDto" (4 values)
                  - `text` (string)
                  - `autofillText` (string)
                  - `supportedApps` (array)
                  - `zeroTapTermsAccepted` (boolean)
                  - `packageName` (string)
                  - `signatureHash` (string)
                - WhatsappPartialFlowButtonDto:
                  - `type` (string)
                    Enum: same as `type` in "WhatsappFlowButtonDto" (1 values)
                  - `text` (string)
                    Text to display on the Flow button
                  - `flowId` (string)
                    Flow ID to launch when button is pressed
                  - `flowAction` (string)
                    Flow action
                    Enum: same as `flowAction` in "WhatsappFlowButtonDto" (4 values)
                  - `navigateScreen` (string)
                    The unique ID of the first screen. Required for Navigate action.
            - WhatsappPartialLocationHeaderComponentDto:
              - `type` (string)
                Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
              - `format` (string)
                Enum: same as `format` in "WhatsappLocationHeaderComponentDto" (1 values)
            - WhatsappPartialCarouselComponentDto:
              - `type` (string)
                Enum: same as `type` in "WhatsappCarouselComponentDto" (1 values)
              - `cards` (array)
                Media cards.
              - `cards.components` (array)
                List of components in the cards.
        - WhatsappTemplateChangesDetailsDto:
          - `components` (array) — one of:
            The current status of the changes.
    
    DRAFT: The changes has not been submitted.
    IN_PROGRESS: The changes has been submitted.
            - WhatsappTextHeaderComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
              - `format` (string, required)
                Enum: same as `format` in "WhatsappTextHeaderComponentDto" (1 values)
              - `text` (string)
                Text to show in the header
              - `example` (string)
                Example for the header variable.
            - WhatsappMediaHeaderComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
              - `format` (string, required)
                Enum: same as `format` in "WhatsappMediaHeaderComponentDto" (3 values)
              - `example` (object)
              - `example.url` (string)
            - WhatsappLocationHeaderComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
              - `format` (string, required)
                Enum: same as `format` in "WhatsappLocationHeaderComponentDto" (1 values)
            - WhatsappBodyComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappBodyComponentDto" (1 values)
              - `text` (string)
              - `examples` (array)
                Examples for the body variables.
              - `addSecurityRecommendation` (boolean)
            - WhatsappFooterComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappFooterComponentDto" (1 values)
              - `text` (string)
              - `codeExpirationMinutes` (number)
            - WhatsappButtonsComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappButtonsComponentDto" (1 values)
              - `buttons` (array, required) — one of:
                - WhatsappPhoneNumberButtonDto:
                  - `type` (string, required)
                    Enum: same as `type` in "WhatsappPhoneNumberButtonDto" (1 values)
                  - `text` (string)
                  - `phoneNumber` (string)
                - WhatsappUrlButtonDto:
                  - `type` (string, required)
                    Enum: same as `type` in "WhatsappUrlButtonDto" (1 values)
                  - `text` (string)
                  - `url` (string)
                  - `example` (string)
                - WhatsappQuickReplyButtonDto:
                  - `type` (string, required)
                    Enum: same as `type` in "WhatsappQuickReplyButtonDto" (1 values)
                  - `text` (string)
                - WhatsappOtpButtonDto:
                  - `type` (string, required)
                    Enum: same as `type` in "WhatsappOtpButtonDto" (1 values)
                  - `otpType` (string, required)
                    Enum: same as `otpType` in "WhatsappOtpButtonDto" (4 values)
                  - `text` (string)
                  - `autofillText` (string)
                  - `supportedApps` (array)
                  - `zeroTapTermsAccepted` (boolean)
                  - `packageName` (string)
                  - `signatureHash` (string)
                - WhatsappFlowButtonDto:
                  - `type` (string, required)
                    Enum: same as `type` in "WhatsappFlowButtonDto" (1 values)
                  - `text` (string)
                    Text to display on the Flow button
                  - `flowId` (string)
                    Flow ID to launch when button is pressed
                  - `flowAction` (string)
                    Flow action
                    Enum: same as `flowAction` in "WhatsappFlowButtonDto" (4 values)
                  - `navigateScreen` (string)
                    The unique ID of the first screen. Required for Navigate action.
                - WhatsappRequestContactInfoButtonDto:
                  - `type` (string, required)
                    Enum: same as `type` in "WhatsappRequestContactInfoButtonDto" (1 values)
                  - `text` (string)
            - WhatsappCarouselComponentDto:
              - `type` (string, required)
                Enum: same as `type` in "WhatsappCarouselComponentDto" (1 values)
              - `cards` (array, required)
                Media cards.
              - `cards.components` (array, required)
                List of components in the cards.
          - `messageSendTtlSeconds` (number)
            Template message delivery retry time-to-live (TTL) override value. If unable to deliver the template message, it will be periodically retry for this period of time. If it is unable to deliver the message for this period of time, the message will be dropped.

|  | AUTHENTICATION | MARKETING | UTILITY |
| -- | -- | -- | -- |
| Default | 10 minutes | 30 days | 30 days |
| Customizable range | 10 seconds to 15 minutes | 12 hours to 30 days | 30 seconds to 12 hours |
| Valid values | 10 to 900 seconds | 43200 to 2592000 seconds | 30 to 43200 seconds |

  Please note that authentication templates created before October 23, 2024, have a default TTL of 30 days.
      - `templates.details` (object)
        Template details and information.
      - `templates.details.messageSendTtlSeconds` (number)
        Template message delivery retry time-to-live (TTL) override value. If unable to deliver the template message, it will be periodically retry for this period of time. If it is unable to deliver the message for this period of time, the message will be dropped.

|  | AUTHENTICATION | MARKETING | UTILITY |
| -- | -- | -- | -- |
| Default | 10 minutes | 30 days | 30 days |
| Customizable range | 10 seconds to 15 minutes | 12 hours to 30 days | 30 seconds to 12 hours |
| Valid values | 10 to 900 seconds | 43200 to 2592000 seconds | 30 to 43200 seconds |

  Please note that authentication templates created before October 23, 2024, have a default TTL of 30 days.
      - `templates.details.components` (array) — one of:
        List of components in the template. Must contain a BODY component and can only have one entry of each type.
        - WhatsappPartialTextHeaderComponentDto:
          - `type` (string)
            Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
          - `format` (string)
            Enum: same as `format` in "WhatsappTextHeaderComponentDto" (1 values)
          - `text` (string)
            Text to show in the header
          - `example` (string)
            Example for the header variable.
        - WhatsappPartialMediaHeaderComponentDto:
          - `type` (string)
            Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
          - `format` (string)
            Enum: same as `format` in "WhatsappMediaHeaderComponentDto" (3 values)
          - `example` (object)
          - `example.url` (string)
        - WhatsappPartialBodyComponentDto:
          - `type` (string)
            Enum: same as `type` in "WhatsappBodyComponentDto" (1 values)
          - `text` (string)
          - `examples` (array)
            Examples for the body variables.
          - `addSecurityRecommendation` (boolean)
        - WhatsappPartialFooterComponentDto:
          - `type` (string)
            Enum: same as `type` in "WhatsappFooterComponentDto" (1 values)
          - `text` (string)
          - `codeExpirationMinutes` (number)
        - WhatsappPartialButtonsComponentDto:
          - `type` (string)
            Enum: same as `type` in "WhatsappButtonsComponentDto" (1 values)
          - `buttons` (array) — one of:
            - WhatsappPartialPhoneNumberButtonDto:
              - `type` (string)
                Enum: same as `type` in "WhatsappPhoneNumberButtonDto" (1 values)
              - `text` (string)
              - `phoneNumber` (string)
            - WhatsappPartialUrlButtonDto:
              - `type` (string)
                Enum: same as `type` in "WhatsappUrlButtonDto" (1 values)
              - `text` (string)
              - `url` (string)
              - `example` (string)
            - WhatsappPartialQuickReplyButtonDto:
              - `type` (string)
                Enum: same as `type` in "WhatsappQuickReplyButtonDto" (1 values)
              - `text` (string)
            - WhatsappPartialOtpButtonDto:
              - `type` (string)
                Enum: same as `type` in "WhatsappOtpButtonDto" (1 values)
              - `otpType` (string)
                Enum: same as `otpType` in "WhatsappOtpButtonDto" (4 values)
              - `text` (string)
              - `autofillText` (string)
              - `supportedApps` (array)
              - `supportedApps.packageName` (string, required)
              - `supportedApps.signatureHash` (string, required)
              - `zeroTapTermsAccepted` (boolean)
              - `packageName` (string)
              - `signatureHash` (string)
            - WhatsappPartialFlowButtonDto:
              - `type` (string)
                Enum: same as `type` in "WhatsappFlowButtonDto" (1 values)
              - `text` (string)
                Text to display on the Flow button
              - `flowId` (string)
                Flow ID to launch when button is pressed
              - `flowAction` (string)
                Flow action
                Enum: same as `flowAction` in "WhatsappFlowButtonDto" (4 values)
              - `navigateScreen` (string)
                The unique ID of the first screen. Required for Navigate action.
        - WhatsappPartialLocationHeaderComponentDto:
          - `type` (string)
            Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
          - `format` (string)
            Enum: same as `format` in "WhatsappLocationHeaderComponentDto" (1 values)
        - WhatsappPartialCarouselComponentDto:
          - `type` (string)
            Enum: same as `type` in "WhatsappCarouselComponentDto" (1 values)
          - `cards` (array)
            Media cards.
          - `cards.components` (array) — one of:
            List of components in the cards.
            - WhatsappPartialCardHeaderComponentDto:
              - `type` (string)
                Enum: same as `type` in "WhatsappTextHeaderComponentDto" (1 values)
              - `format` (string)
                Card header format.
                Enum: same as `format` in "WhatsappCardHeaderComponentDto" (2 values)
              - `example` (object)
                Uploaded media asset handle.
            - WhatsappPartialCardBodyComponentDto:
              - `type` (string)
                Enum: same as `type` in "WhatsappBodyComponentDto" (1 values)
              - `examples` (array)
                Examples for the body variables.
              - `text` (string)
                Card body text.
            - WhatsappPartialCardButtonsComponentDto:
              - `type` (string)
                Enum: same as `type` in "WhatsappButtonsComponentDto" (1 values)
              - `buttons` (array)
                Card buttons.
      - `templates.analytics` (array)
        Template analytics.
      - `templates.analytics.sent` (number)
        Number of times template has been sent.
      - `templates.analytics.delivered` (number)
        Number of times template has been delivered.
      - `templates.analytics.read` (number)
        Number of times template has been read.
      - `templates.analytics.start` (string)
        The UTC Date Time in ISO 8601 for start of date range.
      - `templates.analytics.end` (string)
        The UTC Date Time in ISO 8601 for end of date range.
      - `templates.analytics.buttons` (array)
        Number of times buttons in the template has been clicked.
      - `templates.analytics.buttons.type` (string)
        Type of button.
        Enum: same as `templates.analytics.buttons.type` in "WhatsappTemplateListDto" (4 values)
      - `templates.analytics.buttons.content` (string)
        Content of the button.
      - `templates.analytics.buttons.clicks` (number)
        Number of times the button has been clicked.
      - `previousPageToken` (string)
        Encoded token to use in list request to fetch previous batch of entries.
      - `nextPageToken` (string)
        Encoded token to use in list request to fetch next batch of entries.

## Response 400 fields (application/json):

  - `body` (ProjectNotInitializedErrorTitle (object) or InvalidPageSizeErrorTitle (object) or InvalidPageTokenErrorTitle (object) or InvalidFieldsErrorTitle (object)) — one of:
    - ProjectNotInitializedErrorTitle:
      - `errorCode` (string)
        Error code allows to programmatically handle errors.
        Example: "project_not_initialized"
      - `message` (string)
        Human readable message.
        Example: "Project not initialized for WhatsApp."
      - `resolution` (string)
        Human readable message with an explanation of how to solve the error.
        Example: "Verify that the project ID is correct and that it has been onboarded for WhatsApp."
    - InvalidPageSizeErrorTitle:
      - `errorCode` (string)
        Error code allows to programmatically handle errors.
        Example: "invalid_page_size"
      - `message` (string)
        Human readable message.
        Example: "Page size must be numeric."
      - `resolution` (string)
        Human readable message with an explanation of how to solve the error.
        Example: "Use a integer value for pageSize parameter."
    - InvalidPageTokenErrorTitle:
      - `errorCode` (string)
        Error code allows to programmatically handle errors.
        Example: "invalid_page_token"
      - `message` (string)
        Human readable message.
        Example: "Invalid page token."
      - `resolution` (string)
        Human readable message with an explanation of how to solve the error.
        Example: "The page token to use is provided in the previous query response, for new queries simply leave this field undefined."
    - InvalidFieldsErrorTitle:
      - `errorCode` (string)
        Error code allows to programmatically handle errors.
        Example: "invalid_fields"
      - `message` (string)
        Human readable message.
        Example: "Invalid fields."
      - `resolution` (string)
        Human readable message with an explanation of how to solve the error.
        Example: "Verify that the fields used are supported by the Provisioning API."
      - `additionalInformation` (object)
        Additional information for error.
        Example: {"supportedCodes":"whatsappId, state, name, language, category, rejectionCode, qualityScore, changes, changes.status, changes.allowCategoryChange, changes.details, changes.details.components, changes.details.components.0.type, changes.details.components.0.format, changes.details.components.0.text, changes.details.components.0.example, changes.details.components.0.example.url, changes.details.components.0.examples, changes.details.components.0.addSecurityRecommendation, changes.details.components.0.codeExpirationMinutes, changes.details.components.0.buttons, changes.details.components.0.buttons.0.type, changes.details.components.0.buttons.0.text, changes.details.components.0.buttons.0.phoneNumber, changes.details.components.0.buttons.0.url, changes.details.components.0.buttons.0.example, changes.details.components.0.buttons.0.otpType, changes.details.components.0.buttons.0.autofillText, changes.details.components.0.buttons.0.packageName, changes.details.components.0.buttons.0.signatureHash, changes.details.components.0.buttons.0.supportedApps, changes.details.components.0.buttons.0.supportedApps.0.packageName, changes.details.components.0.buttons.0.supportedApps.0.signatureHash, changes.details.components.0.buttons.0.zeroTapTermsAccepted, changes.details.components.0.buttons.0.flowId, changes.details.components.0.buttons.0.flowAction, changes.details.components.0.buttons.0.navigateScreen, changes.details.messageSendTtlSeconds, details, details.components, details.components.0.type, details.components.0.format, details.components.0.text, details.components.0.example, details.components.0.example.url, details.components.0.examples, details.components.0.addSecurityRecommendation, details.components.0.codeExpirationMinutes, details.components.0.buttons, details.components.0.buttons.0.type, details.components.0.buttons.0.text, details.components.0.buttons.0.phoneNumber, details.components.0.buttons.0.url, details.components.0.buttons.0.example, details.components.0.buttons.0.otpType, details.components.0.buttons.0.autofillText, details.components.0.buttons.0.packageName, details.components.0.buttons.0.signatureHash, details.components.0.buttons.0.supportedApps, details.components.0.buttons.0.supportedApps.0.packageName, details.components.0.buttons.0.supportedApps.0.signatureHash, details.components.0.buttons.0.zeroTapTermsAccepted, details.components.0.buttons.0.flowId, details.components.0.buttons.0.flowAction, details.components.0.buttons.0.navigateScreen, details.messageSendTtlSeconds, analytics, analytics.0.sent, analytics.0.delivered, analytics.0.read, analytics.0.start, analytics.0.end, analytics.0.buttons, analytics.0.buttons.0.type, analytics.0.buttons.0.content, analytics.0.buttons.0.clicks, isMetaGenerated"}

## Response 401 fields (application/json):

  - `errorCode` (string)
    Error code allows to programmatically handle errors.
    Example: "unauthorized_error"

  - `message` (string)
    Human readable message.
    Example: "Unauthorized error."

  - `resolution` (string)
    Human readable message with an explanation of how to solve the error.
    Example: "Verify that projectId is correct."

## Response 404 fields (application/json):

  - `errorCode` (string)
    Error code allows to programmatically handle errors.
    Example: "template_not_found"

  - `message` (string)
    Human readable message.
    Example: "Template not found."

  - `resolution` (string)
    Human readable message with an explanation of how to solve the error.
    Example: "Verify that the parameters are correct."

## Response 500 fields (application/json):

  - `errorCode` (string)
    Error code allows to programmatically handle errors.
    Example: "internal_error"

  - `message` (string)
    Human readable message.
    Example: "Internal server error."

  - `resolution` (string)
    Human readable message with an explanation of how to solve the error.
    Example: "Please wait and try again, if the error persist please contact support."