---
updatedAt: 2025-11-20T07:09:23.000Z
agentTools:
  projectIndex: https://partner-docs.gupshup.io/llms.txt
---

# Link App with Partner

This API endpoint lets authenticated partners link a Gupshup application to their account using an API key and app name. 

<Callout icon="📘" theme="info">
  Additional Check: Partner must have MFA (Multi-Factor Authentication) enabled
</Callout>

### Parameters

| Parameters    | Value                | Description                         |
| :------------ | :------------------- | :---------------------------------- |
| Authorization | \{\{PARTNER\_TOKEN}} | JWT Token issued post Partner login |
| apiKey        | \{\{API\_KEY}}       | API key for the app                 |
| appName       | \{\{APP\_NAME}}      | Unique Identifier for Gupshup App   |

### Sample Request

```curl
curl --location --request POST 'https://partner.gupshup.io/partner/account/api/appLink' \
--header 'Authorization: {{PARTNER_TOKEN}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'apiKey={{API_KEY}}' \
--data-urlencode 'appName={{APP_NAME}}'
```

### Sample Response

```json
{
        "partnerApps": {
            "createdOn": 1609829592910,
            "healthy": false,
            "id": "fa*b***e-d2**-****-be38-0****d*9a**b",
            "live": false,
            "modifiedOn": 1614162854108,
            "name": "assistant0092",
            "partnerId": 1,
            "phone": "91**********",
            "stopped": false,
            "walletId": "1**"
        }
    }
```

<br />

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Partner Portal Public APIs",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://partner.gupshup.io"
    }
  ],
  "tags": [
    {
      "name": "Partner"
    }
  ],
  "paths": {
    "/partner/account/api/appLink": {
      "post": {
        "tags": [
          "Partner"
        ],
        "summary": "link app using apiKey",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "properties": {
                  "apiKey": {
                    "type": "string",
                    "example": "7e411e0332704866c83b94df2eaa2054"
                  },
                  "appName": {
                    "type": "string",
                    "example": "assistant0092"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "schema": {
              "type": "string"
            },
            "example": "{{PARTNER_TOKEN}}"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {}
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {}
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {}
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```