> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automatebusiness.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Fetch Payload Skeleton

> Retrieves the ready-to-use sample payload skeleton for a specific template. You can copy the response's `data` object, modify the field values, and send it directly to the Send Template Message endpoint.



## OpenAPI

````yaml GET /api/templates/{templateId}/payload-skeleton
openapi: 3.1.0
info:
  title: Automate Chats API
  description: >-
    API for managing WhatsApp template messages, contacts, custom fields, tags,
    and external integrations.
  version: 1.0.0
servers:
  - url: https://api.automatechats.com
security:
  - apiKeyAuth: []
paths:
  /api/templates/{templateId}/payload-skeleton:
    get:
      summary: Fetch Payload Skeleton
      description: >-
        Retrieves the ready-to-use sample payload skeleton for a specific
        template. You can copy the response's `data` object, modify the field
        values, and send it directly to the Send Template Message endpoint.
      parameters:
        - name: templateId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ready-to-use payload skeleton for the template
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  code:
                    type: integer
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      templateId:
                        type: string
                        format: uuid
                      name:
                        type: string
                      language:
                        type: string
                      samplePayload:
                        type: object
                        properties:
                          templateId:
                            type: string
                            format: uuid
                          recipientPhoneNumber:
                            type: string
                          countryCode:
                            type: string
                          variableMapping:
                            type: object
                  timestamp:
                    type: string
                    format: date-time
              examples:
                standardTemplate:
                  summary: Standard Template Skeleton
                  value:
                    status: success
                    code: 200
                    message: Payload schema skeleton generated successfully
                    data:
                      templateId: b340b1b3-bf45-4a61-be71-853a31830dc5
                      name: travel_reminder
                      language: en
                      samplePayload:
                        templateId: b340b1b3-bf45-4a61-be71-853a31830dc5
                        recipientPhoneNumber: PHONE_NUMBER_IN_E164
                        countryCode: COUNTRY_CODE_IF_V1
                        variableMapping:
                          body:
                            '1': BODY_VARIABLE_1_VALUE
                            '2': BODY_VARIABLE_2_VALUE
                            '3': BODY_VARIABLE_3_VALUE
                            '4': BODY_VARIABLE_4_VALUE
                            '5': BODY_VARIABLE_5_VALUE
                            '6': BODY_VARIABLE_6_VALUE
                    timestamp: '2026-06-12T05:42:30.350Z'
                carouselTemplate:
                  summary: Carousel Template Skeleton
                  value:
                    status: success
                    code: 200
                    message: Payload schema skeleton generated successfully
                    data:
                      templateId: ffbf13d9-6cba-4288-9a38-bb4d9fee0ba5
                      name: carousel_msg
                      language: en_US
                      samplePayload:
                        templateId: ffbf13d9-6cba-4288-9a38-bb4d9fee0ba5
                        recipientPhoneNumber: PHONE_NUMBER_IN_E164
                        countryCode: COUNTRY_CODE_IF_V1
                        variableMapping:
                          body:
                            '1': BODY_VARIABLE_1_VALUE
                          carousel:
                            - header:
                                link: HEADER_CARD_0_IMAGE_URL
                              body:
                                '1': BODY_CARD_0_VARIABLE_1_VALUE
                            - header:
                                link: HEADER_CARD_1_IMAGE_URL
                              body:
                                '1': BODY_CARD_1_VARIABLE_1_VALUE
                    timestamp: '2026-06-12T05:43:57.123Z'
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````