Responding

Usage Instructions

Add, remove, or set classifications and metadata on comments in the responding system.

Actions

Add Classifications

Append classifications to a comment, deduplicating existing values.

Input

ParameterTypeRequiredDescription
commentIdstringYesID of the comment to update
classificationsarrayYesClassification labels to add

Output

ParameterTypeDescription
classificationsarrayUpdated classifications array

Remove Classifications

Remove specific classifications from a comment.

Input

ParameterTypeRequiredDescription
commentIdstringYesID of the comment to update
classificationsarrayYesClassification labels to remove

Output

ParameterTypeDescription
classificationsarrayUpdated classifications array

Set Classifications

Overwrite all classifications on a comment.

Input

ParameterTypeRequiredDescription
commentIdstringYesID of the comment to update
classificationsarrayYesClassification labels to set

Output

ParameterTypeDescription
classificationsarrayUpdated classifications array

Set Metadata

Overwrite the metadata object on a comment.

Input

ParameterTypeRequiredDescription
commentIdstringYesID of the comment to update
metadatajsonYesMetadata object to set

Output

ParameterTypeDescription
metadatajsonUpdated metadata object

Add Metadata

Add new fields into the existing metadata object on a comment.

Input

ParameterTypeRequiredDescription
commentIdstringYesID of the comment to update
metadatajsonYesMetadata fields to add

Output

ParameterTypeDescription
metadatajsonUpdated metadata object

Delete Metadata

Remove all metadata from a comment by setting it to null.

Input

ParameterTypeRequiredDescription
commentIdstringYesID of the comment to delete metadata from

Output

ParameterTypeDescription
metadatajsonMetadata value after deletion (null)