Delete a placement

Last update: 2023-10-18
  • Created for:
  • Experienced

It may occasionally be necessary to remove (DELETE) a placement. This is done by performing a DELETE request to the Offer Library API using the id of the placement you wish to delete.

API format

Parameter Description Example
{ENDPOINT_PATH} The endpoint path for persistence APIs.
{ID} The instance id of the placement you wish to update. offerPlacement1234


curl -X DELETE '' \
-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}'


A successful response returns HTTP status 200 and a blank body.

You can confirm the deletion by attempting a lookup (GET) request to the placement and should receive an HTTP status 404 (Not Found) because the placement has been removed.

On this page