> ## 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.

# Upload a Brand Message image

> Upload an image for a Kakao Brand Message template or a free-form message.

> [!NOTE]
>
> Upload the image to Kakao BizMessage before using it in a Brand Message template or a free-form message. Put the returned `data.images[].url` value in the image field of the create-template or send request.

> [!WARNING]
>
> Use the dimensions and width-to-height ratios for the image type.
>
> | `type` | Use | Size and aspect ratio |
> | - | - | - |
> | `image` | Image and commerce messages | 800 × 400 px recommended. Minimum width 500 px. Ratio 3:4 to 2:1. |
> | `wide-image` | Wide image messages | 800 × 600 px recommended. Minimum width 500 px. Ratio 1:1 to 2:1. |
> | `wide-itemlist-first-image` | Main wide item list image | Minimum width 500 px. Ratio 2:1. |
> | `wide-itemlist-image` | Secondary wide item list image | Minimum width 500 px. Ratio 1:1. |
> | `carousel-image` | Carousel feed | 800 × 600 px or 800 × 400 px recommended. Minimum width 500 px. Ratio 3:4 to 2:1. |
> | `carousel-commerce-image` | Carousel commerce | 800 × 600 px or 800 × 400 px recommended. Minimum width 500 px. Ratio 3:4 to 2:1. Use the same ratio for every image. |
>
> Upload JPG or PNG files of up to 5 MB each.


## OpenAPI

````yaml /en/api-reference/openapi.yaml post /v1/projects/{projectId}/messages/kakao-brand-message/images
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:
  /v1/projects/{projectId}/messages/kakao-brand-message/images:
    post:
      summary: upload-kakao-brand-message-image
      operationId: uploadKakaoBrandMessageImage
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: Project ID.
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/KakaoBrandMessageImageUploadRequest'
            encoding:
              file:
                contentType: image/jpeg, image/png
              images:
                contentType: image/jpeg, image/png
      responses:
        '200':
          description: The image was uploaded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KakaoBrandMessageImageUploadResponse'
              example:
                data:
                  images:
                    - url: https://mud-kage.kakao.com/example/img_l.jpg
                error: null
        '400':
          description: >-
            The request is invalid, or the image did not pass Kakao's
            validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotiflyV1ErrorResponse'
        '401':
          description: Authentication failed because the token is invalid or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotiflyV1ErrorResponse'
        '403':
          description: Access to the project is denied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotiflyV1ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    KakaoBrandMessageImageUploadRequest:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - image
            - wide-image
            - wide-itemlist-first-image
            - wide-itemlist-image
            - carousel-image
            - carousel-commerce-image
          description: >-
            Purpose of the uploaded image. Use `file` for single-image types and
            `images` for multi-image types that require repeated multipart
            fields.
        file:
          type: string
          format: binary
          description: >-
            Single image file for the `image`, `wide-image`, and
            `wide-itemlist-first-image` types.
        images:
          type: array
          description: >-
            Repeated image file field for the `wide-itemlist-image`,
            `carousel-image`, and `carousel-commerce-image` types.
          items:
            type: string
            format: binary
    KakaoBrandMessageImageUploadResponse:
      type: object
      properties:
        data:
          type: object
          required:
            - images
          properties:
            images:
              type: array
              items:
                $ref: '#/components/schemas/KakaoBrandMessageUploadedImage'
        error:
          type: string
          nullable: true
          description: null on success.
    NotiflyV1ErrorResponse:
      type: object
      properties:
        data:
          type: object
          nullable: true
          description: null on failure.
        error:
          oneOf:
            - type: string
            - $ref: '#/components/schemas/NotiflyV1ErrorObject'
          description: >-
            Error returned by the v1 API. Authentication and authorization
            errors may be returned as an object with code and message fields.
            Request validation errors may be returned as a string.
      example:
        data: null
        error:
          code: UNAUTHORIZED
          message: Invalid Authorization Token
    KakaoBrandMessageUploadedImage:
      type: object
      required:
        - url
      properties:
        url:
          type: string
          format: uri
          description: >-
            Uploaded image URL to use in a template creation request or a
            free-form send request.
    NotiflyV1ErrorObject:
      type: object
      properties:
        code:
          type: string
          description: Error code.
        message:
          type: string
          description: 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.