Update an Annotation

Update an existing annotation. 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).

Endpoint

Method: PUT

URL: /annotation/{conversationId}

Path Parameter

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

Request Parameter

Parameter Name	Data Type	Description	Required/Optional
`annotationId`	String	The ID of the annotation to update. Use use the search captured conversations request to find a list of `annotations` associated with a specific conversation, each with a unique `annotationId` (you'll need to use `groupFilter` to specify the conversation ID).	Required
`header`	String	The annotation header to use for the annotation, this can be updated as part of this request, use the Get Annotation Headers request for a list of valid headers in your system.	Required
`text`	String	The new annotation text for the specified annotation, this will replace the existing annotation text so make sure to include everything you need.	Required
`offsetInSeconds`	Number	How far along in the conversation to move the annotation to (in seconds). For Example, `0` would be at the start of the call and `120` would be two minutes into the call.	Required
`timestamp`	Number	When (date and time) the annotation was created, you can enter a new value to update this parameter if needed. This parameter will not automatically be updated with the time of the request but will be updated to the specified value in the request.	Required
`participantId`	String	The ID of the user that created the annotation, you can enter a new value to update this parameter if needed. This parameter will not be updated to the ID that updated the annotation but will be updated to the specified value in the request.	Required
`productType`	String	Set to `PRODUCT_TYPE_U_CAPTURE`. This is the product that the annotation feature belongs to (U-Capture).	Required

For an example, see Sample Request.

Response and Error Code

Response Code	Condition
200	OK

Response Parameter

Parameter Name	Data Type	Description
`annotationId`	String	The ID of the updated annotation.
`header`	String	The annotation header used by the annotation.
`text`	String	The annotation text for the specified annotation, this has replaced the previous annotation text.
`offsetInSeconds`	Number	How far along in the conversation the annotation is placed (in seconds). For example, `0` would be at the start of the call and `120` would be two minutes into the call.
`timestamp`	Number	The date and time specified in the request. Originally the `timestamp` would equal when the annotation was created, however this will have been updated to the specified `timestamp` in the request.
`participantId`	String	This ID specified in the request. Originally the `participantId` would be the ID of the user that created the annotation, however this will have been updated to the specified `participantId` in the request.
`productType`	String	This is the product that the annotation feature belongs to (U-Capture)

For an example, see Sample Response.

Sample Request

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

Sample Response

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

In this section:

Uniphore Customer Portal