Skip to main content
POST
/
api
/
purge-items
Create PurgeItem
curl --request POST \
  --url https://platform.kodexa.ai/api/purge-items \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "ref": "<string>",
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "ref": "<string>",
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Body

application/json

A purge item marks content for scheduled cleanup and deletion.

​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
id
string
​
ref
string
​
type
string
​
updatedOn
string<date-time>
​
uuid
string

Response

Created PurgeItem

A purge item marks content for scheduled cleanup and deletion.

​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
id
string
​
ref
string
​
type
string
​
updatedOn
string<date-time>
​
uuid
string