Documentation Journey Optimizer Journey Optimizer Guide

Create an eligibility rule

Last update: March 10, 2025

CREATED FOR:

Experienced
Developer

You can create an eligibility rule by making a POST request to the Offer Library API.

API format

POST /{ENDPOINT_PATH}/eligibility-rules

Parameter	Description	Example
`{ENDPOINT_PATH}`	The endpoint path for persistence APIs.	`https://platform.adobe.io/data/core/dps`

Request

curl -X POST 'https://platform.adobe.io/data/core/dps/offer-rules' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
    "name": "test dule",
    "description": "xxxxxx",
    "exdRule": true,
    "condition": {
        "type": "PQL",
        "format": "pql/text",
        "value": "inSegment(\"849807b6-0a76-4895-96d9-89996477f23b\") and billingAddress.city.equals(\"san jose\", false)"
    }
}'

Response

A successful response returns the details of the newly created eligibility rule including the ID. You can use the id in later steps to update or delete your eligibility rule.

{
    "etag": 1,
    "createdBy": "{CREATED_BY}",
    "lastModifiedBy": "{MODIFIED_BY}",
    "id": "{ID}",
    "sandboxId": "{SANDBOX_ID}",
    "createdDate": "2023-05-31T15:09:11.771Z",
    "lastModifiedDate": "2023-05-31T15:09:11.771Z",
    "createdByClientId": "{CREATED_CLIENT_ID}",
    "lastModifiedByClientId": "{MODIFIED_CLIENT_ID}"
}

recommendation-more-help