---
updatedAt: 2026-07-14T10:25:06.000Z
agentTools:
  projectIndex: https://partner-docs.gupshup.io/llms.txt
---

# Image

Use this API to send messages with an Image template.

## Request Parameters

<Table align={["left","left","left","left","left","left"]}>
  <thead>
    <tr>
      <th>
        Key
      </th>

      <th>
        Description
      </th>

      <th>
        Value
      </th>

      <th>
        Data type
      </th>

      <th>
        Required/Optional
      </th>

      <th>
        Constraints
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        Authorization
      </td>

      <td>
        Access Token for the application
      </td>

      <td>
        `{{PARTNER_APP_TOKEN}}`
      </td>

      <td>
        String
      </td>

      <td>
        Required
      </td>

      <td>
        Should be a valid Partner App Access Token
      </td>
    </tr>

    <tr>
      <td>
        source
      </td>

      <td>
        Source Phone Number
      </td>

      <td>
        `{{SOURCE}}`
      </td>

      <td>
        Integer
      </td>

      <td>
        Required
      </td>

      <td>

      </td>
    </tr>

    <tr>
      <td>
        sandbox
      </td>

      <td>
        Boolean value
      </td>

      <td>
        `{SANDBOX}`
      </td>

      <td>
        Boolean
      </td>

      <td>
        Optional
      </td>

      <td>

      </td>
    </tr>

    <tr>
      <td>
        destination
      </td>

      <td>
        Destination Phone Number
      </td>

      <td>
        `{{DESTINATION}}`
      </td>

      <td>
        Integer
      </td>

      <td>
        Required
      </td>

      <td>

      </td>
    </tr>

    <tr>
      <td>
        template
      </td>

      <td>
        Json containing template details
      </td>

      <td>
        `{ "id":"{{TEMPLAYE_ID}}", "params":[{{TEMPLATE_PARAMS_LIST}}] }`
      </td>

      <td>
        String
      </td>

      <td>
        Required
      </td>

      <td>
        Must include valid template id
      </td>
    </tr>

    <tr>
      <td>
        message
      </td>

      <td>
        Message Message format
      </td>

      <td>
        `{{MESSAGE}}`
      </td>

      <td>
        String
      </td>

      <td>
        Required
      </td>

      <td>
        `{ "type": "image", "image": { "link": "<image_url>", "id": "<image_id>" } }`
      </td>
    </tr>

    <tr>
      <td>
        src.name
      </td>

      <td>
        App Name
      </td>

      <td>
        `{{APP_NAME}}`
      </td>

      <td>
        String
      </td>

      <td>
        Required
      </td>

      <td>

      </td>
    </tr>

    <tr>
      <td>
        APP\_ID
      </td>

      <td>
        App ID to fetch the access token
      </td>

      <td>
        `{{APP_ID}}`
      </td>

      <td>
        String
      </td>

      <td>
        Required
      </td>

      <td>
        - The ID should be a valid app ID of Gupshup - The App must be associated with the account that owns the PARTNER\_APP\_TOKEN being used
      </td>
    </tr>

    <tr>
      <td>
        userId
      </td>

      <td>
        BSUID
      </td>

      <td>
        {{userId}}
      </td>

      <td>

      </td>

      <td>

      </td>

      <td>

      </td>
    </tr>
  </tbody>
</Table>

## Sample Request

```curl
curl --request POST \
     --url https://partner.gupshup.io/partner/app/947d28b8-459b-4dfe-9d4c-0ac8c6c245c9/template/msg \
     --header 'accept: application/json' \
     --header 'content-type: application/x-www-form-urlencoded' \
     --header 'token: sk_711916ad1d5d4f21a9520fdef20516a1' \
     --data source=919643874844 \
     --data destination=918886912227 \
     --data src.name=august18 \
     --data 'template={"id": "9ff51097-48c9-47c7-a4e4-a9bb5801d8ea", "params": []}' \
--data 'userId={{BSUID}}' \
     --data 'message={
  "type": "image",
  "image": {
    "id": "820953082747249"
  }
}
```

## Sample Response

```json
{
  "status": "submitted",
  "messageId": "28e59926-60d5-41ed-beee-931ef168a966"
}
```

## Status Codes

| Status Code | Response                                                                                                                                           | Comments               |
| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------- |
| **Success** |                                                                                                                                                    |                        |
| 200         | `{ "status": "submitted", "messageId": "28e59926-60d5-41ed-beee-931ef168a966" }`                                                                   |                        |
| **Error**   |                                                                                                                                                    |                        |
| 429         | `{ "status": "error", "message": "Too Many Requests" }`                                                                                            | 10 Requests per Minute |
| 500         | `{ "status": "error", "message": "Internal server error. Please try again later. If the issue still persists, then contact Gupshup Dev Support" }` | For any Internal Error |

<br />

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Send Message With Image Template",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://partner.gupshup.io"
    }
  ],
  "paths": {
    "/partner/app/{appId}/template/msg": {
      "post": {
        "tags": [
          "default"
        ],
        "summary": "Image",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "required": [
                  "source",
                  "destination",
                  "src.name",
                  "template",
                  "message"
                ],
                "properties": {
                  "source": {
                    "type": "integer",
                    "description": "Source Phone Number",
                    "example": "918929874278"
                  },
                  "destination": {
                    "type": "integer",
                    "description": "Destination Phone Number",
                    "example": "918805162043"
                  },
                  "src.name": {
                    "type": "string",
                    "description": "App Name",
                    "example": "august18"
                  },
                  "template": {
                    "type": "string",
                    "description": "Json containing template details",
                    "example": "{\"id\": \"9ff51097-48c9-47c7-a4e4-a9bb5801d8ea\", \"params\": []}"
                  },
                  "message": {
                    "type": "string",
                    "description": "Message Format",
                    "example": "{\n  \"type\": \"image\",\n  \"image\": {\n    \"id\": \"820953082747249\"\n  }\n}"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "header",
            "schema": {
              "type": "string"
            },
            "description": "Your app token, please refer [**Get access token api**](https://docs.gupshup.io/reference/get_partner-app-appid-token) to get the token from partner documentation.",
            "example": "sk_61b3021c97214370b341f8baaae0xxxx",
            "required": true
          },
          {
            "name": "appId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true,
            "description": "Unique identifier of the app.",
            "example": "9e97650d-xxxx-xxxx-xxxx-4cdf47c3fa68"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "submitted"
                    },
                    "messageId": {
                      "type": "string",
                      "example": "183dc8f1-7ecc-4419-895f-04fd0b1bfe07"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Too Many Requests"
                    },
                    "status": {
                      "type": "string",
                      "example": "error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Internal server error"
                    },
                    "status": {
                      "type": "string",
                      "example": "error"
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Use this API to send messages with an Image template."
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```