# Create a simple Entitlement

Endpoint: POST /v1/entitlement
Version: 1.0.0_Beta

## Request fields (application/json):

  - `entitlementId` (string)
    Entitlement ID of the entitlement. If you specify the entitlement ID, then it must be unique across all entitlements and line items. If you specify the entitlement ID here, then the autoGenerate flag must be set to false
    Example: "ent-id-1234"

  - `description` (string)
    Description of the entitlement
    Example: "Description for entitlement"

  - `allowPortalLogin` (boolean)
    Whether the customer can use the entitlement ID to log into the End-User Portal after the entitlement is deployed

  - `shipToEmail` (string)
    Email address of the ship-to contact
    Example: "Joe@example.com"

  - `shipToAddress` (string)
    Address of the ship-to contact
    Example: "Building-Street-City"

  - `accounts` (array)
    List of accounts associated with the entitlement. If account is not provided, the entitlement will be associated with UNKNOWN_ORG_UNIT(default account).

  - `accounts.accountId` (string, required)
    ID of the account
    Example: "SampleOrg12345"

  - `accounts.accountName` (string)

  - `accounts.accountType` (string, required)
    Type of the account. Valid types are PUBLISHER, CUSTOMER, CHANNEL_PARTNER, SELF_REGISTERED, UNKNOWN
    Example: "CUSTOMER"

  - `accounts.partnerTierName` (string, required)
    Partner tier of the account owning the entitlement. Valid values are END_CUSTOMER and PARTNER_TIER_ONE
    Example: "END_CUSTOMER/PARTNER_TIER_ONE"

  - `accounts.isCurrentOwner` (boolean)
    Whether this account is the current owner of the entitlement in the distribution chain

  - `accounts.contactEmail` (string)
    Email address of the Contact in the account
    Example: "Joe@example.com"

  - `lineItems` (array, required)
    List of line items contained in the entitlement

  - `lineItems.activationId` (string)
    Activation ID of the line item. If you specify the activation ID, then it must be unique across all entitlements and line items. If you specify the activation ID here, then the autoGenerate flag must be set to false
    Example: "act-id-1234"

  - `lineItems.product` (array, required)
    List of products entitled by this line item

  - `lineItems.product.productName` (string, required)
    Name of the product
    Example: "SampleProduct"

  - `lineItems.product.productVersion` (string, required)
    Version of the product
    Example: "SampleVersion-1.0"

  - `lineItems.product.licenseModel` (object)
    License model associated with the product

  - `lineItems.product.licenseModel.licenseModelName` (string, required)
    specify a name that uniquely identifies this license model
    Example: "LicenseModelName"

  - `lineItems.product.licenseModel.issuer` (string)
    specify who is issuing the license
    Example: "SampleLicenseIssuer"

  - `lineItems.product.licenseModel.serialNumber` (string)
    specify the serial number of the license
    Example: "SampleSerialno"

  - `lineItems.product.licenseModel.vendorString` (string)
    Unique value assigned by each publisher to each license
    Example: "uniqueVendorString"

  - `lineItems.product.licenseModel.notice` (string)
    This field is usually set at entitlement time and includes customer name and purchase order
    Example: "Premium Feature A"

  - `lineItems.quantity` (integer)
    Number of copies for the entitlement
    Example: 1

  - `lineItems.quantityPerCopy` (integer)

  - `lineItems.isActivatable` (boolean)
    Whether this line item is activatable

  - `lineItems.isPermanent` (boolean)
    Whether this line item is permanent. A permanent line item has no expiration date.

  - `lineItems.expiryDate` (string)
    End date of the line item in YYYY-MM-DD format
    Example: "2025-01-01"

  - `lineItems.startDate` (string, required)
    Start date of the line item in YYYY-MM-DD format
    Example: "2025-01-01"

  - `lineItems.attributes` (array)
    List of custom attributes related to the line item

  - `lineItems.attributes.name` (string)
    Name of the custom attribute
    Example: "REGION"

  - `lineItems.attributes.value` (object)
    Value assigned to the custom attribute. If the value is of type Date, then it should use yyyy/MM/dd format. Similarly, appropriate value corresponding to the type of custom attribute must be provided.
    Example: "EMEA"

  - `lineItems.autoGenerate` (boolean)
    Whether the activation ID should be auto-generated

  - `lineItems.autoDeploy` (boolean)
    Whether the Line item should be auto-deployed

  - `lineItems.orderType` (string)
    Type of order for the line item. The default is NEW_ORDER
    Enum: "new_order", "renewal_order", "upgrade_order", "upsell_order", "invalid_order"

  - `lineItems.lineItemStatus` (string)
    Enum: "draft", "deployed", "obsolete"

  - `autoDeploy` (boolean)
    Flag to indicate if the entitlement should be auto-deployed

  - `emailTemplateVariation` (string)
    Name of the email template to be used for entitlement related emails
    Example: "DEFAULT"

  - `attributes` (array)
    List of entitlement custom attributes. Note that mandatory custom attributes must be included in this list

  - `autoGenerate` (boolean)
    Whether the entitlement ID is to be auto-generated.

  - `status` (string)
    Enum: "draft", "deployed", "obsolete"

## Response 201 fields (application/json):

  - `status` (string)

## Response 400 fields (application/json):

  - `status` (string)

  - `message` (string)

## Response 500 fields (application/json):

  - `status` (string)

  - `message` (string)