Delete an Annotation

Remove a specific annotation from a specific conversation.

Endpoint

Method: DELETE

URL: /annotation/{conversationId}

Path Parameter

Parameter Name	Data Type	Description	Required/Optional
`conversationId`	String	The ID of the conversation with the annotation to remove.	Required.

Request Parameter

The following parameters must match those of the annotation that you would like to delete, use the search captured conversations request to find a list of annotations associated with a specific conversation (you'll need to use groupFilter to specify the conversation ID), each annotation should have the following parameters that you can use to fill out the delete annotation request body.

Parameter Name	Data Type	Description	Required/Optional
`annotationId`	String	Set to the `annotationId` of the annotation to delete.	Required
`header`	String	Set to the `header` of the annotation to delete.	Required
`text`	String	Set to the `text` of the annotation to delete.	Required
`offsetInSeconds`	Number	Set to the `offsetInSeconds` of the annotation to delete.	Required
`timestamp`	String	Set to the `timestamp` of the annotation to delete.	Required
`participantId`	String	Set to the `participantId` of the annotation to delete.	Required
`productType`	String	Set to the `productType` of the annotation to delete.	Required

Sample Request

{
  "annotationId": "dca23ffc-af12-4074-8c27-8c85a66585ad",
  "header": "Exmaple Header 2",
  "text": "New annotation text",
  "offsetInSeconds": "0",
  "timestamp": "2024-07-01T09:17:25.790125456Z",
  "participantId": "auth0|932gd3e6dfr32e7cfc2076359",
  "productType": "PRODUCT_TYPE_U_CAPTURE"
}

Response and Error Code

Response Code	Condition
204	No Content

The above "204 No Content" response means that the annotation has been deleted, you can always use the search captured conversations request and review the list of annotations associated with the specific conversation and confirm that the annotation has been deleted (you'll need to use groupFilter to specify the conversation ID).

In this section:

Uniphore Customer Portal