> 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

# CreateProgramDefinition

# Package: benefitPrograms

# Namespace: ProgramDefinitionService

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/benefit-programs/program-definitions/create-program-definition.md

## Permission Scopes:
Manage benefit programs: SCOPE.BENEFIT_PROGRAMS.MANAGE

## Introduction

Creates a program definition.

---

## REST API

### Schema

```
 Method: createProgramDefinition
 Description: Creates a program definition.
 URL: https://www.wixapis.com/_api/benefit-programs/v1/program-definitions
 Method: POST
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  programDefinition, programDefinition.namespace, programDefinition.externalId
 Method parameters: 
   param name: programDefinition | type: ProgramDefinition   | required: true
        - name: displayName | type: string | description: Program definition name. 
        - name: namespace | type: string | description: Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created. | required: true
        - name: extendedFields | type: ExtendedFields | description: Custom field data for the program definition object.  [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. 
           - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 
        - name: externalId | type: string | description: GUID for the program definition defined by you. You can use `externalId` to filter queries. | required: true
 Return type: CreateProgramDefinitionResponse
  - name: programDefinition | type: ProgramDefinition | description: Created program definition. 
     - name: id | type: string | description: Program definition GUID. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the program definition is updated. To prevent conflicting changes, the current revision must be passed when updating the program definition.  Ignored when creating a program definition. 
     - name: createdDate | type: string | description: Date and time the program definition was created. 
     - name: updatedDate | type: string | description: Date and time the program definition was updated. 
     - name: displayName | type: string | description: Program definition name. 
     - name: namespace | type: string | description: Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created. 
     - name: extendedFields | type: ExtendedFields | description: Custom field data for the program definition object.  [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. 
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 
     - name: externalId | type: string | description: GUID for the program definition defined by you. You can use `externalId` to filter queries. 


```

### Examples

### CreateProgramDefinition
```curl
~~~cURL
curl --request POST \
  https://www.wixapis.com/benefit-programs/v1/program-definitions \
  -H 'Authorization: <AUTH>' \
  -H "Content-Type: application/json" \
  --data '{
    "program_definition": {
      "namespace": "benefit_programs_app",
      "external_id": "myProgramDefinition",
      "display_name": "My Gold plan"
    }
  }'
~~~
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.benefitPrograms.ProgramDefinitionService.createProgramDefinition(programDefinition)
 Description: Creates a program definition.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  programDefinition, programDefinition.namespace, programDefinition.externalId
 Method parameters: 
   param name: programDefinition | type: ProgramDefinition   | required: true
        - name: displayName | type: string | description: Program definition name. 
        - name: namespace | type: string | description: Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created. | required: true
        - name: extendedFields | type: ExtendedFields | description: Custom field data for the program definition object.  [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. 
           - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 
        - name: externalId | type: string | description: GUID for the program definition defined by you. You can use `externalId` to filter queries. | required: true
 Return type: PROMISE<ProgramDefinition>
  - name: _id | type: string | description: Program definition GUID. 
  - name: revision | type: string | description: Revision number, which increments by 1 each time the program definition is updated. To prevent conflicting changes, the current revision must be passed when updating the program definition.  Ignored when creating a program definition. 
  - name: _createdDate | type: Date | description: Date and time the program definition was created. 
  - name: _updatedDate | type: Date | description: Date and time the program definition was updated. 
  - name: displayName | type: string | description: Program definition name. 
  - name: namespace | type: string | description: Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created. 
  - name: extendedFields | type: ExtendedFields | description: Custom field data for the program definition object.  [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. 
     - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 
  - name: externalId | type: string | description: GUID for the program definition defined by you. You can use `externalId` to filter queries. 


```

### Examples

### createProgramDefinition
```javascript
import { programDefinitions } from '@wix/benefit-programs';

async function createProgramDefinition(programDefinition) {
  const response = await programDefinitions.createProgramDefinition(programDefinition);
};
```

### createProgramDefinition (with elevated permissions)
```javascript
import { programDefinitions } from '@wix/benefit-programs';
import { auth } from '@wix/essentials';

async function myCreateProgramDefinitionMethod(programDefinition) {
  const elevatedCreateProgramDefinition = auth.elevate(programDefinitions.createProgramDefinition);
  const response = await elevatedCreateProgramDefinition(programDefinition);
}
```

### createProgramDefinition (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 { programDefinitions } from '@wix/benefit-programs';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

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


async function createProgramDefinition(programDefinition) {
  const response = await myWixClient.programDefinitions.createProgramDefinition(programDefinition);
};
```

---