Delete List of Interactions by URIs
Learn how to use the Delete Interactions API.
Important: This functionality is only available in tenants provisioned for Customer 360 Data Products.
The Delete Interactions API deletes the interactions by Uniform Resource Identifier (URI) as specified in the body of the request.
The maximum number of URI in one batch is 150.
Request
POST {TenantId}/interactions/_deleteByUris
For more information, see Delete list of interactions by URIs.
| Parameter Type | Parameter Name | Required | Details |
|---|---|---|---|
| Headers | Authorization | Yes | Provides information about authentication access token in Bearer <accessToken> format. For more information, see Authentication API. |
| Query | mode | No | Use this parameter to specify a type of delete operations. It can be set to hard or soft. The default value is |
| Body | - | Yes | This parameter is a JSON array of interaction URIs. The maximum number of interaction URI is 150. |
Response
A JSON object that represents the result of operation.
| Name | Details | Type |
|---|---|---|
| status | Possible values:
| String |
| details | Optional: If the status displays an | JSON Array of Strings |
The following examples explain the JSON object representing the operation result.
ExamplesExample: Success
{
"status": "success"
}Example: Error
{
"status": "error",
"details": [
"Code: INTERNAL_SERVER_ERROR; Unable to read the object:
[interactions/Reltio+888458313626]"
]
}
Request Example
POST {TenantURL}/interactions/_deleteByUris
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512
[
"interactions/Reltio+888458313626",
"interactions/Reltio+896502267803",
"interactions/Reltio+896502759323"
]Response Example
{
"status": "success"
}