You can modify or update a personalized offer by making a PATCH request to the Offer Library API
For more information on JSON Patch, including available operations, see the official JSON Patch documentation.
The following table shows the valid values which comprise the Content-Type field in the request header:
Header name | Value |
---|---|
Content-Type | application/json |
API format
PATCH /{ENDPOINT_PATH}/offers/{ID}?offer-type=personalized
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. | personalizedOffer1234 |
Request
curl -X PATCH 'https://platform.adobe.io/data/core/dps/offers/personalizedOffer1234?offer-type=personalized' \
-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 '[
{
"op": "replace",
"path": "/name",
"value": "Updated personalized offer"
},
{
"op": "replace",
"path": "/description",
"value": "Updated personalized offer description"
}
]'
Parameter | Description |
---|---|
op |
The operation call used to define the action needed to update the connection. Operations include: add , replace , remove , copy and test . |
path |
The path of the parameter to be updated. |
value |
The new value you want to update your parameter with. |
Response
A successful response returns the updated details of the placement, including placement 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}"
}