---
updatedAt: 2025-02-14T21:23:47.000Z
agentTools:
  projectIndex: https://partner-docs.gupshup.io/llms.txt
---

# Generate Embed Signed Link

Use this endpoint to generate the embed signed link.

> 📘 Note
>
> 1. The signed link is valid for 5 days only.

### Parameters

| Key            | Description                                              | Constraints                                          |
| :------------- | :------------------------------------------------------- | :--------------------------------------------------- |
| PARTNER\_TOKEN | JWT Token issues post Partner login                      | Should be a valid Partner JWT Token.                 |
| appId          | AppId of the app for which embed link needs to generate. | Should be a valid appId associated with the account. |
| regenerate     | Boolean value specifying regeneration of the embed link. | Default value if false.                              |
| user           | User name                                                | Should be a valid username                           |
| lang           | Language                                                 | Should be a valid language supported.                |

### Sample Request

```curl
curl --location --request GET '{{partner_portal_base_url}}/partner/app/:appId/onboarding/embed/link?regenerate=<BOOLEAN_VALUE>&user=<USER_NAME>&lang=<LANGUAGE>' \
--header 'token: {{PARTNER_TOKEN}}'
```

### Sample Response

```
{
    "status": "success",
    "link" : "<embed_link>"
}
```

### Status Codes

| Status Code   | Response                                                                                                                                                      | Comment                                                                               |
| :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------ |
| ***Success*** |                                                                                                                                                               |                                                                                       |
| 200           | `{       "status": "success",       "link" : "<embed_link>"   }`                                                                                              | Successfully generated embed link.                                                    |
| ***Error***   |                                                                                                                                                               |                                                                                       |
| 400           | `{       "status": "error",       "message": "Query Params cannot be empty"   }`                                                                              | Either user or lang in the query parameter is empty.                                  |
| 400           | `{       "status": "error",       "message": "Max Links Already sent,  please contact support at [devsupport@gupshup.io](mailto:devsupport@gupshup.io) "   }` | Exceeds the number of times embed links can be generated.                             |
| 400           | `{       "status": "error",       "message": "Link has expired, please regenerate link"   }`                                                                  | Existing Embed token is expired.                                                      |
| 401           | `{       "status": "error",       "message": "Authentication Failed"   }`                                                                                     | Either appId or partner\_token is incorrect.                                          |
| 429           | `{     "status": "error",     "message": "Too Many Requests"   }`                                                                                             | When the request rate limit exceeds.                                                  |
| 500           | `{       "status": "error",       "message": "Unable to create link"   }`                                                                                     | Error while trying to create an Embed Link.                                           |
| 500           | `{       "status": "error",       "message": "Unable to get link"   }`                                                                                        | Error while getting embed link for the app. Try it after some time.                   |
| 500           | `{       "status": "error",       "message": "Max link already sent"   }`                                                                                     | Can only be regenerated at max 40 times or new links can be generated at max 5 times. |

# 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": "App > OnBoarding Api's"
    }
  ],
  "paths": {
    "/partner/app/{appId}/onboarding/embed/link": {
      "get": {
        "tags": [
          "App > OnBoarding Api's"
        ],
        "summary": "APP | Generate embed signed link",
        "parameters": [
          {
            "name": "token",
            "in": "header",
            "schema": {
              "type": "string"
            },
            "example": "{{PARTNER_TOKEN}}"
          },
          {
            "name": "regenerate",
            "in": "query",
            "schema": {
              "type": "boolean"
            },
            "example": "true"
          },
          {
            "name": "user",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "example": "user name"
          },
          {
            "name": "lang",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "example": "English"
          },
          {
            "name": "appId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true,
            "example": "0ee06d0b-3816-4a44-9594-2eb970f175db"
          }
        ],
        "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
  }
}
```