DocumentationJourney OptimizerJourney Optimizer Guide

Update an eligibility rule update-eligibility-rule

Last update: Thu Dec 11 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Applies to:
  • Journey Orchestration

CREATED FOR:

  • Experienced
  • Developer

You can modify or update a rule by making a PUT request to the Offer Library API.

For more information on JSON PUT, including available operations, see the official JSON PUT documentation.

Accept and Content-Type headers

The following table shows the valid values which comprise the Content-Type fields in the request header:

Header name
Value
Content-Type
application/json

API format

PUT /{ENDPOINT_PATH}/offer-rules/{ID}
Parameter
Description
Example
{ENDPOINT_PATH}
The endpoint path for persistence APIs.
https://platform.adobe.io/data/core/dps
{ID}
The id of the entity you wish to update.
rule1234

Request

curl -X PATCH 'https://platform.adobe.io/data/core/dps/offer-rules/rule1234' \
-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": "[UPDATED] Test Offer Rule DPS",
    "description": "Offer Rule description",
    "exdRule": true,
    "condition": {
        "type": "PQL",
        "format": "pql/text",
        "value": "homeAddress.stateProvince.equals(\"CA\", false) and (select var1 from xEvent where var1.eventType.equals(\"purchase\", true) and (var1.commerce.order.priceTotal = 1000.0 and var1.commerce.order.currencyCode.equals(\"USD\", false)))"
    },
    "definedOn": {
        "": {
            "schema": {
                "altId": "_xdm.context.profile",
                "version": "1"
            },
            "referencePaths": [
                "homeAddress.stateProvince"
            ]
        },
        "xEvent": {
            "schema": {
                "altId": "_xdm.context.experienceevent",
                "version": "1"
            },
            "referencePaths": [
                "eventType",
                "commerce.order.priceTotal",
                "commerce.order.currencyCode"
            ]
        }
    }
}'
Parameter
Description
value
The new value you want to update your parameter with.
path
The path of the parameter to be updated.
op
The operation call used to define the action needed to update the connection. Operations include: add, replace, remove, copy and test.

Response

A successful response returns the updated details of the eligibility rule, including the ID.

{
    "etag": 2,
    "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
b22c9c5d-9208-48f4-b874-1cefb8df4d76