> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.ordergroove.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.ordergroove.com/_mcp/server.

# Create

POST https://restapi.ordergroove.com/retention_incentives/eligibility_rule/
Content-Type: application/json

Creates a retention incentive eligibility rule with their incentive templates.

Reference: https://docs.ordergroove.com/reference/rest-rpc-api/retention-incentives/create

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: ordergroove-restrpc
  version: 1.0.0
paths:
  /retention_incentives/eligibility_rule/:
    post:
      operationId: eligibility-rules-create
      summary: Create
      description: >-
        Creates a retention incentive eligibility rule with their incentive
        templates.
      tags:
        - retentionIncentives
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Retention
                  Incentives_eligibility-rules-create_Response_200
        '400':
          description: '400'
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Eligibility-rules-createRequestBadRequestError
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Anything to help identify this rule
                live:
                  type: boolean
                  description: Active / inactive state for this rule
                min_days_since_last_claim:
                  type: integer
                  description: >-
                    Minimum number of days since the last retention incentive
                    has been claimed for a given customer
                min_subscriber_orders_since_last_claim:
                  type: integer
                  description: >-
                    Minimum number of orders that had to be placed since the
                    last retention incentive was claimed for a given customer
                incentive_templates:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/RetentionIncentivesEligibilityRulePostRequestBodyContentApplicationJsonSchemaIncentiveTemplatesItems
              required:
                - name
                - live
servers:
  - url: https://restapi.ordergroove.com
    description: https://restapi.ordergroove.com
components:
  schemas:
    RetentionIncentivesEligibilityRulePostRequestBodyContentApplicationJsonSchemaIncentiveTemplatesItems:
      type: object
      properties:
        type:
          type: string
          description: 'Type of incentive: "Discount" or "Gift"'
        name:
          type: string
          description: Name of the incentive
        target:
          type: string
          description: 'Target for application: "order" or "item"'
        discount_type:
          type: string
          description: 'Type of discount operation: "Discount Percent" or "Discount Amount"'
        field:
          type: string
          description: >-
            Field where to apply the discount, "shipping_total" or "sub_total"
            for orders and "total_price" for items
        value:
          type: string
          description: Value of the incentive
      required:
        - type
        - target
        - discount_type
        - field
        - value
      title: >-
        RetentionIncentivesEligibilityRulePostRequestBodyContentApplicationJsonSchemaIncentiveTemplatesItems
    RetentionIncentivesEligibilityRulePostResponsesContentApplicationJsonSchemaIncentiveTemplatesItems:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
        field:
          type: string
        discount_type:
          type: string
        value:
          type: string
        target:
          type: string
      title: >-
        RetentionIncentivesEligibilityRulePostResponsesContentApplicationJsonSchemaIncentiveTemplatesItems
    Retention Incentives_eligibility-rules-create_Response_200:
      type: object
      properties:
        public_id:
          type: string
        name:
          type: string
        merchant:
          type: string
        live:
          type: boolean
          default: true
        min_days_since_last_claim:
          type: integer
          default: 0
        min_subscriber_orders_since_last_claim:
          description: Any type
        incentive_templates:
          type: array
          items:
            $ref: >-
              #/components/schemas/RetentionIncentivesEligibilityRulePostResponsesContentApplicationJsonSchemaIncentiveTemplatesItems
      title: Retention Incentives_eligibility-rules-create_Response_200
    Eligibility-rules-createRequestBadRequestError:
      type: object
      properties:
        name:
          type: array
          items:
            type: string
      title: Eligibility-rules-createRequestBadRequestError
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key

```

## Examples

### Result



**Request**

```json
undefined
```

**Response**

```json
{}
```

**SDK Code**

```python Result
import requests

url = "https://restapi.ordergroove.com/retention_incentives/eligibility_rule/"

headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript Result
const url = 'https://restapi.ordergroove.com/retention_incentives/eligibility_rule/';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: undefined
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Result
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://restapi.ordergroove.com/retention_incentives/eligibility_rule/"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Result
require 'uri'
require 'net/http'

url = URI("https://restapi.ordergroove.com/retention_incentives/eligibility_rule/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'

response = http.request(request)
puts response.read_body
```

```java Result
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://restapi.ordergroove.com/retention_incentives/eligibility_rule/")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .asString();
```

```php Result
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://restapi.ordergroove.com/retention_incentives/eligibility_rule/', [
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Result
using RestSharp;

var client = new RestClient("https://restapi.ordergroove.com/retention_incentives/eligibility_rule/");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
IRestResponse response = client.Execute(request);
```

```swift Result
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://restapi.ordergroove.com/retention_incentives/eligibility_rule/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Simple rule with template



**Request**

```json
{
  "name": "Retention discount 1",
  "live": true,
  "min_days_since_last_claim": 40,
  "incentive_templates": [
    {
      "type": "Discount",
      "target": "item",
      "discount_type": "Discount Percent",
      "field": "total_price",
      "value": "20.00",
      "name": "Incentive template discount"
    }
  ]
}
```

**Response**

```json
{}
```

**SDK Code**

```python Simple rule with template
import requests

url = "https://restapi.ordergroove.com/retention_incentives/eligibility_rule/"

payload = {
    "name": "Retention discount 1",
    "live": True,
    "min_days_since_last_claim": 40,
    "incentive_templates": [
        {
            "type": "Discount",
            "target": "item",
            "discount_type": "Discount Percent",
            "field": "total_price",
            "value": "20.00",
            "name": "Incentive template discount"
        }
    ]
}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Simple rule with template
const url = 'https://restapi.ordergroove.com/retention_incentives/eligibility_rule/';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"name":"Retention discount 1","live":true,"min_days_since_last_claim":40,"incentive_templates":[{"type":"Discount","target":"item","discount_type":"Discount Percent","field":"total_price","value":"20.00","name":"Incentive template discount"}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Simple rule with template
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://restapi.ordergroove.com/retention_incentives/eligibility_rule/"

	payload := strings.NewReader("{\n  \"name\": \"Retention discount 1\",\n  \"live\": true,\n  \"min_days_since_last_claim\": 40,\n  \"incentive_templates\": [\n    {\n      \"type\": \"Discount\",\n      \"target\": \"item\",\n      \"discount_type\": \"Discount Percent\",\n      \"field\": \"total_price\",\n      \"value\": \"20.00\",\n      \"name\": \"Incentive template discount\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Simple rule with template
require 'uri'
require 'net/http'

url = URI("https://restapi.ordergroove.com/retention_incentives/eligibility_rule/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Retention discount 1\",\n  \"live\": true,\n  \"min_days_since_last_claim\": 40,\n  \"incentive_templates\": [\n    {\n      \"type\": \"Discount\",\n      \"target\": \"item\",\n      \"discount_type\": \"Discount Percent\",\n      \"field\": \"total_price\",\n      \"value\": \"20.00\",\n      \"name\": \"Incentive template discount\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java Simple rule with template
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://restapi.ordergroove.com/retention_incentives/eligibility_rule/")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Retention discount 1\",\n  \"live\": true,\n  \"min_days_since_last_claim\": 40,\n  \"incentive_templates\": [\n    {\n      \"type\": \"Discount\",\n      \"target\": \"item\",\n      \"discount_type\": \"Discount Percent\",\n      \"field\": \"total_price\",\n      \"value\": \"20.00\",\n      \"name\": \"Incentive template discount\"\n    }\n  ]\n}")
  .asString();
```

```php Simple rule with template
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://restapi.ordergroove.com/retention_incentives/eligibility_rule/', [
  'body' => '{
  "name": "Retention discount 1",
  "live": true,
  "min_days_since_last_claim": 40,
  "incentive_templates": [
    {
      "type": "Discount",
      "target": "item",
      "discount_type": "Discount Percent",
      "field": "total_price",
      "value": "20.00",
      "name": "Incentive template discount"
    }
  ]
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Simple rule with template
using RestSharp;

var client = new RestClient("https://restapi.ordergroove.com/retention_incentives/eligibility_rule/");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Retention discount 1\",\n  \"live\": true,\n  \"min_days_since_last_claim\": 40,\n  \"incentive_templates\": [\n    {\n      \"type\": \"Discount\",\n      \"target\": \"item\",\n      \"discount_type\": \"Discount Percent\",\n      \"field\": \"total_price\",\n      \"value\": \"20.00\",\n      \"name\": \"Incentive template discount\"\n    }\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Simple rule with template
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "Retention discount 1",
  "live": true,
  "min_days_since_last_claim": 40,
  "incentive_templates": [
    [
      "type": "Discount",
      "target": "item",
      "discount_type": "Discount Percent",
      "field": "total_price",
      "value": "20.00",
      "name": "Incentive template discount"
    ]
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://restapi.ordergroove.com/retention_incentives/eligibility_rule/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```