> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# GenerateUnsubscribeLink

# Package: communication

# Namespace: EmailSubscriptionsService

# Method link: https://dev.wix.com/docs/api-reference/crm/communication/email-subscriptions/generate-unsubscribe-link.md

## Permission Scopes:
Manage Email Subscriptions: SCOPE.DC-MANAGE.EMAIL-SUBSCRIPTIONS

## Introduction

Creates an unsubscribe link to be shared with the relevant recipient.

If someone clicks the **Unsubscribe** button on the confirmation page,
the recipient's `subscriptionStatus` is changed to `UNSUBSCRIBED`.

---

## REST API

### Schema

```
 Method: generateUnsubscribeLink
 Description: Creates an unsubscribe link to be shared with the relevant recipient.  If someone clicks the **Unsubscribe** button on the confirmation page, the recipient's `subscriptionStatus` is changed to `UNSUBSCRIBED`.
 URL: https://www.wixapis.com/email-marketing/v1/email-subscriptions/unsubscribe-link
 Method: POST
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  emailAddress
 Method parameters: 
   param name: emailAddress | type: emailAddress | description: Email address the unsubscribe link is for. | required: true
   param name: language | type: language | description: Language for displaying unsubscribe confirmation page.  2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.  Default: `EN` 
   param name: metadata | type: metadata | description: Arbitrary parameters for closing-the-loop. 
        - name: key | type: string | description: none 
        - name: value | type: string | description: none 
 Return type: GenerateUnsubscribeLinkResponse
  - name: link | type: string | description: The unsubscribe link. 


```

### Examples

### Generate Unsubscribe Link
```curl
curl -X POST \
  'https://www.wixapis.com/email-marketing/v1/email-subscriptions/query' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: <AUTH>' \
  --data-binary '{
    "emailAddress": "unsubscribed-contact@company.com"
  }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.communication.EmailSubscriptionsService.generateUnsubscribeLink(emailAddress, options)
 Description: Creates an unsubscribe link to be shared with the relevant recipient.  If someone clicks the **Unsubscribe** button on the confirmation page, the recipient's `subscriptionStatus` is changed to `UNSUBSCRIBED`.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  emailAddress
 Method parameters: 
   param name: emailAddress | type: string | description: Email address the unsubscribe link is for. | required: true
   param name: options | type: GenerateUnsubscribeLinkOptions  none 
        - name: metadata | type: object | description: Arbitrary parameters for closing-the-loop. 
        - name: language | type: string | description: Language for displaying unsubscribe confirmation page.  2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.  Default: `EN` 
 Return type: PROMISE<GenerateUnsubscribeLinkResponse>
  - name: link | type: string | description: The unsubscribe link. 


```

### Examples

### generateUnsubscribeLink
```javascript
import { emailSubscriptions } from '@wix/email-subscriptions';

async function generateUnsubscribeLink(emailAddress,options) {
  const response = await emailSubscriptions.generateUnsubscribeLink(emailAddress,options);
};
```

### generateUnsubscribeLink (with elevated permissions)
```javascript
import { emailSubscriptions } from '@wix/email-subscriptions';
import { auth } from '@wix/essentials';

async function myGenerateUnsubscribeLinkMethod(emailAddress,options) {
  const elevatedGenerateUnsubscribeLink = auth.elevate(emailSubscriptions.generateUnsubscribeLink);
  const response = await elevatedGenerateUnsubscribeLink(emailAddress,options);
}
```

### generateUnsubscribeLink (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { emailSubscriptions } from '@wix/email-subscriptions';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { emailSubscriptions },
  // Include the auth strategy and host as relevant
});


async function generateUnsubscribeLink(emailAddress,options) {
  const response = await myWixClient.emailSubscriptions.generateUnsubscribeLink(emailAddress,options);
};
```

---