Delete key-value pairs from a data extension

Request

Deletes the key-value pairs you provide in the name query parameter from a data extension for a guest.

For example, if your data extension contains the vipMember and loyaltyMember keys, you can delete both keys and their values by making the following request:

{baseURL}/v2.1/guests/{guestRef}/extensions/{dataExtensionName}/fields?name=vipMember|loyaltyMember

If you don't provide the query parameter, this operation will empty the data extension: the data extension itself will not be deleted, but all the key-value pairs in it will.

Security

BasicAuth

Path

guestRefstringrequired

The guest reference. This is a unique identifier of the guest record. If you don't know the guest reference, first retrieve guests.

Example:f7aabbca-1c1b-4fc2-be72-3e16294a4f03

dataExtensionNamestringrequired

The name of the data extension. If you don't know this value, first retrieve the guest's collection of data extensions.

Enum:"ext""ext1""ext2""ext3""ext4""ext5"

Example:ext1

Query

nameArray of strings

The fields in the data extension object that you want to delete.

Default:""

Example:name=vipMember|loyaltyTier

curl -i -X DELETE \
  -u '<username>:<password>' \
  'https://api-engage-ap.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03/extensions/ext1/fields?name=vipMember%7CloyaltyTier'

Responses

Successful operation

Bodyapplication/json

createdAtstring, (date-time)

The date and time when the resource was created in Sitecore CDP.

Example:"2024-01-01T16:17:16.000Z"

guestobject(GuestHref)

hrefstring

The URL of the guest extension.

Example:"https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03/ext1"

keystring

You must set this to default.

Example:"default"

modifiedAtstring, (date-time)

The date and time when the resource was last updated in Sitecore CDP.

Example:"2024-01-01T16:17:16.000Z"

namestring

The name of the data extension. You can only use a name once in a collection.

Example:"ext"

refstring

Guest extension reference.

Example:"6a5cb3c2-1a4a-56d8-8a01-1ede232b9db2"

{exampleKey1}string or boolean or integer or number

A key-value pair in the data extension. Example: "vipMember": true

Example:"{exampleValue1}"

{exampleKey2}string or boolean or integer or number

A key-value pair in the data extension. Example: "loyaltyTier": "level2"

Example:"{exampleValue2}"

Response

{
  "createdAt": "2024-01-01T16:17:16.000Z",
  "guest": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03"
  },
  "href": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03/ext1",
  "key": "default",
  "modifiedAt": "2024-01-01T16:17:16.000Z",
  "name": "ext",
  "ref": "6a5cb3c2-1a4a-56d8-8a01-1ede232b9db2",
  "{exampleKey1}": "{exampleValue1}",
  "{exampleKey2}": "{exampleValue2}"
}