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

# Submit a template for approval

**Required scope:** `whatsapp.edit`


## OpenAPI

````yaml /api-reference/openapi.json post /whatsapp/templates/{id}/submit
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /whatsapp/templates/{id}/submit:
    post:
      summary: Submit a template for approval
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  template:
                    type: object
                    properties:
                      id:
                        type: string
                      purpose:
                        type: string
                      providerName:
                        type: string
                      languageCode:
                        type: string
                      category:
                        type: string
                        enum:
                          - MARKETING
                          - UTILITY
                          - AUTHENTICATION
                      providerCategory:
                        type: string
                        nullable: true
                        enum:
                          - MARKETING
                          - UTILITY
                          - AUTHENTICATION
                      headerKind:
                        type: string
                        enum:
                          - NONE
                          - TEXT
                          - IMAGE
                          - DOCUMENT
                          - VIDEO
                      headerBindings:
                        type: array
                        items:
                          nullable: true
                      bodyBindings:
                        type: array
                        items:
                          nullable: true
                      buttonBindings:
                        type: object
                        additionalProperties:
                          nullable: true
                      bodyPreview:
                        type: string
                        nullable: true
                      status:
                        type: string
                        enum:
                          - DRAFT
                          - PENDING
                          - APPROVED
                          - REJECTED
                          - DISABLED
                      senderId:
                        type: string
                        nullable: true
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                      components:
                        type: array
                        items:
                          nullable: true
                      sampleValues:
                        type: object
                        additionalProperties:
                          nullable: true
                      rejectionReason:
                        type: string
                        nullable: true
                      providerCheckedAt:
                        type: string
                        nullable: true
                      submissionIsAutomatic:
                        type: boolean
                      requiresRuntimeContext:
                        type: boolean
                      headerMediaFileName:
                        type: string
                        nullable: true
                      headerMediaAttached:
                        type: boolean
                      clicks:
                        type: number
                      trackedLinks:
                        type: number
                    required:
                      - id
                      - purpose
                      - providerName
                      - languageCode
                      - category
                      - headerKind
                      - headerBindings
                      - bodyBindings
                      - buttonBindings
                      - bodyPreview
                      - status
                      - senderId
                      - createdAt
                      - updatedAt
                      - components
                      - sampleValues
                      - rejectionReason
                      - providerCheckedAt
                      - submissionIsAutomatic
                      - requiresRuntimeContext
                      - headerMediaFileName
                      - headerMediaAttached
                      - clicks
                      - trackedLinks
                  automatic:
                    type: boolean
                  instructions:
                    type: object
                    nullable: true
                    properties:
                      payload:
                        nullable: true
                      steps:
                        type: array
                        items:
                          type: string
                    required:
                      - steps
                required:
                  - template
                  - automatic
                  - instructions
        '400':
          description: >-
            - `invalid_credentials`: The credentials for the connected service
            (CRM, integration or messaging account) were rejected. `message` has
            details.

            - `invalid_request`: The input was rejected.

            - `template_already_approved`: Template is already approved.

            - `template_invalid`: Template components fail validation (issues
            included).

            - `template_media_missing`: Media-header template has no uploaded
            attachment.

            - `template_media_review_failed`: The attachment was saved but could
            not be prepared for review.
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: >-
            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.

            - `template_not_found`: Template id not in this workspace (400 in
            order-notification rules).
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '502':
          description: >-
            - `upstream_unavailable`: A connected service (messaging or speech)
            is unavailable.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.