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

# Register an AlimTalk template (legacy)

> Register a new Kakao AlimTalk template.

> [!WARNING]
>
> * If the template message type is `EX` or `MI`, include `templateExtra`.
> * If the template emphasis type is `TEXT`, include `templateTitle` and `templateSubtitle`.
> * If the template emphasis type is `IMAGE`, include `templateImageName` and `templateImageUrl`.
> * A template item list can contain 2 to 10 items.
> * Each button type has its own required fields.


## OpenAPI

````yaml /en/api-reference/openapi.yaml post /projects/{projectId}/messages/kakao-alimtalk/templates
openapi: 3.0.3
info:
  title: Notifly API
  version: 1.0.0
  contact:
    email: contact@notifly.tech
servers:
  - url: https://api.notifly.tech
    description: Notifly API server
security: []
tags:
  - name: catalog
    x-group: Catalogs
paths:
  /projects/{projectId}/messages/kakao-alimtalk/templates:
    post:
      summary: create-kakao-alimtalk-template
      operationId: createKakaoAlimtalkTemplate
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: Project ID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KakaoTemplateInput'
      responses:
        '200':
          description: The template was registered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KakaoTemplateResponse'
        '400':
          description: The request body format is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleErrorResponse'
        '401':
          description: Authentication failed because the token is invalid or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleErrorResponse'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    KakaoTemplateInput:
      type: object
      required:
        - templateCode
        - templateName
        - templateContent
      properties:
        channelId:
          type: string
          description: The AlimTalk channel ID.
        templateCode:
          type: string
          description: The template code. Must be unique, with a maximum of 20 characters.
        templateName:
          type: string
          description: The template name. Maximum 150 characters.
        templateContent:
          type: string
          description: The template body. Maximum 1000 characters.
        templateMessageType:
          type: string
          enum:
            - BA
            - EX
            - AD
            - MI
          description: >-
            The template message type. `BA` is basic, `EX` includes additional
            information, `AD` adds the channel, and `MI` combines types.
        templateEmphasizeType:
          type: string
          enum:
            - NONE
            - TEXT
            - IMAGE
            - ITEM_LIST
          description: The template emphasis type.
        templateExtra:
          type: string
          description: Additional template information. Required for `EX` or `MI`.
        templateTitle:
          type: string
          description: The template title. Maximum 50 characters.
        templateSubtitle:
          type: string
          description: The template subtitle. Maximum 50 characters.
        templateHeader:
          type: string
          description: The template header. Maximum 16 characters.
        templateItem:
          type: object
          description: Item information.
          properties:
            list:
              type: array
              items:
                type: object
                required:
                  - title
                  - description
                properties:
                  title:
                    type: string
                    description: The item title. Maximum 6 characters.
                  description:
                    type: string
                    description: The item description. Maximum 23 characters.
              description: The item list. Minimum 2 items, maximum 10 items.
            summary:
              type: object
              required:
                - title
                - description
              properties:
                title:
                  type: string
                  description: The summary title. Maximum 6 characters.
                description:
                  type: string
                  description: >-
                    The summary description. Only variables, currency units,
                    numbers, commas, and periods are allowed. Maximum 14
                    characters.
              description: Item summary information.
        templateItemHighlight:
          type: object
          description: The item highlight.
          properties:
            title:
              type: string
              description: >-
                The highlight title. Maximum 30 characters, or 21 characters
                with a thumbnail image.
            description:
              type: string
              description: >-
                The highlight description. Maximum 19 characters, or 13
                characters with a thumbnail image.
            imageUrl:
              type: string
              description: The thumbnail image URL.
        templateRepresentLink:
          type: object
          description: The main link.
          properties:
            linkMo:
              type: string
              description: The mobile web link. Maximum 500 characters.
            linkPc:
              type: string
              description: The desktop web link. Maximum 500 characters.
            schemeIos:
              type: string
              description: The iOS app link. Maximum 500 characters.
            schemeAndroid:
              type: string
              description: The Android app link. Maximum 500 characters.
        templateImageName:
          type: string
          description: The image name.
        templateImageUrl:
          type: string
          description: The image URL.
        securityFlag:
          type: boolean
          description: Whether this is a secure template.
        categoryCode:
          type: string
          description: The template category code. Defaults to `999999`.
        buttons:
          type: array
          items:
            type: object
            required:
              - ordering
              - type
              - name
            properties:
              ordering:
                type: integer
                description: The button order, from 1 to 5.
              type:
                type: string
                enum:
                  - WL
                  - AL
                  - DS
                  - BK
                  - MD
                  - BC
                  - BT
                  - AC
                  - BF
                  - P1
                  - P2
                  - P3
                description: >-
                  The button type. `WL` is a web link, `AL` is an app link, `DS`
                  tracks delivery, `BK` is a bot keyword, `MD` forwards a
                  message, `BC` switches to a consultation chat, `BT` switches
                  to a bot, `AC` adds the channel, `BF` is a business form, and
                  `P1`, `P2`, and `P3` are plugins.
              name:
                type: string
                description: The button name. Maximum 14 characters.
              linkMo:
                type: string
                description: >-
                  The mobile web link. Required for `WL`. Maximum 500
                  characters.
              linkPc:
                type: string
                description: >-
                  The desktop web link. Optional for `WL`. Maximum 500
                  characters.
              schemeIos:
                type: string
                description: The iOS app link. Required for `AL`. Maximum 500 characters.
              schemeAndroid:
                type: string
                description: >-
                  The Android app link. Required for `AL`. Maximum 500
                  characters.
              bizFormId:
                type: integer
                description: The business form ID. Required for `BF`.
              pluginId:
                type: string
                description: The plugin ID. Maximum 24 characters.
          description: The list of buttons. Maximum 5 buttons.
        quickReplies:
          type: array
          items:
            type: object
            required:
              - ordering
              - type
              - name
            properties:
              ordering:
                type: integer
                description: The quick reply order.
              type:
                type: string
                enum:
                  - WL
                  - AL
                  - BK
                  - BC
                  - BT
                  - BF
                description: >-
                  The quick reply type. `WL` is a web link, `AL` is an app link,
                  `BK` is a bot keyword, `BC` switches to a consultation chat,
                  `BT` switches to a bot, and `BF` is a business form.
              name:
                type: string
                description: The quick reply name. Maximum 14 characters.
              linkMo:
                type: string
                description: >-
                  The mobile web link. Required for `WL`. Maximum 500
                  characters.
              linkPc:
                type: string
                description: >-
                  The desktop web link. Optional for `WL`. Maximum 500
                  characters.
              schemeIos:
                type: string
                description: The iOS app link. Required for `AL`. Maximum 500 characters.
              schemeAndroid:
                type: string
                description: >-
                  The Android app link. Required for `AL`. Maximum 500
                  characters.
              bizFormId:
                type: integer
                description: The business form ID. Required for `BF`.
          description: The list of quick replies. Maximum 5 quick replies.
    KakaoTemplateResponse:
      type: object
      properties:
        resultCode:
          type: integer
          description: Result code.
        resultMessage:
          type: string
          description: Result message.
      example:
        resultCode: 0
        resultMessage: Success
    SimpleErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
      example:
        error: some-error-message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Pass the token issued by `POST /authenticate` as a bearer token.

````

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