> 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

# GetPlanGoalOptions

# Package: marketingPlan

# Namespace: MarketingSettingsService

# Method link: https://dev.wix.com/docs/api-reference/business-management/marketing/marketing-plan/marketing-settings-v1/get-plan-goal-options.md

## Permission Scopes:
Manage Marketing Plans: SCOPE.PROMOTE.MANAGE-MARKETING-PLAN

## Introduction

Retrieves the list of plan goal options a site can choose from when configuring marketing settings.

---

## REST API

### Schema

```
 Method: getPlanGoalOptions
 Description: Retrieves the list of plan goal options a site can choose from when configuring marketing settings.
 URL: https://www.wixapis.com/promote/marketing-plan-service/v1/marketing-settings/plan-goal-options
 Method: GET
 Return type: GetPlanGoalOptionsResponse
  - name: options | type: array<PlanGoalOption> | description: Selectable plan goal options, ordered for display.  | validation: minItems 0, maxItems 10
     - name: planGoalKey | type: PlanGoal | description: The enum value identifying this goal.  
         - enum:
         -     DRIVE_TRAFFIC: Increase visits to the site.
         -     BRAND_AWARENESS: Grow recognition and reach of the brand.
         -     BOOST_SALES: Promote products or services to increase purchases.
         -     COLLECT_LEADS: Capture contact information from potential customers.
     - name: displayName | type: string | description: Localized display name for this goal.  | validation: maxLength 100


```

### Examples

### Get plan goal options
Retrieve the predefined marketing plan goals available for selection.

```curl
curl -X GET \
'https://www.wixapis.com/promote/marketing-plan-service/v1/marketing-settings/plan-goal-options' \
-H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.promoteGrowthToolsMarketingPlan.marketingSettings.getPlanGoalOptions()
 Description: Retrieves the list of plan goal options a site can choose from when configuring marketing settings.
 Return type: PROMISE<GetPlanGoalOptionsResponse>
  - name: options | type: array<PlanGoalOption> | description: Selectable plan goal options, ordered for display.  | validation: minItems 0, maxItems 10
     - name: planGoalKey | type: PlanGoal | description: The enum value identifying this goal.  
         - enum:
         -     DRIVE_TRAFFIC: Increase visits to the site.
         -     BRAND_AWARENESS: Grow recognition and reach of the brand.
         -     BOOST_SALES: Promote products or services to increase purchases.
         -     COLLECT_LEADS: Capture contact information from potential customers.
     - name: displayName | type: string | description: Localized display name for this goal.  | validation: maxLength 100


```

### Examples

### Get plan goal options
```javascript
import { marketingSettings } from "@wix/promote-growth-tools-marketing-plan";

async function getPlanGoalOptions() {
  const response = await marketingSettings.getPlanGoalOptions();
}

/* Promise resolves to:
 * {
 *   "options": [
 *     {
 *       "planGoalKey": "DRIVE_TRAFFIC",
 *       "displayName": "Drive traffic to my site"
 *     },
 *     {
 *       "planGoalKey": "BRAND_AWARENESS",
 *       "displayName": "Build brand awareness"
 *     },
 *     {
 *       "planGoalKey": "BOOST_SALES",
 *       "displayName": "Boost sales"
 *     },
 *     {
 *       "planGoalKey": "COLLECT_LEADS",
 *       "displayName": "Collect leads"
 *     }
 *   ]
 * }
 */

```

### getPlanGoalOptions (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 { marketingSettings } from '@wix/promote-growth-tools-marketing-plan';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

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


async function getPlanGoalOptions() {
  const response = await myWixClient.marketingSettings.getPlanGoalOptions();
};
```

---