API Documentation

API MENU

Update Methods » EditAnnotation

Edit basic information for an existing annotation

Required paramaters: standard, AnnotationId

Optional paramaters: standard, Note, Highlight, Spoiler, Privacy, CoordinateX, CoordinateY

For master account Key/Signature pair, the paramater UserId is also required.

Example Response (XML)

<Success>
	<Code>OK</Code>
	<Description>Annotation updated successfully</Description>
</Success>

Required Parameters Explained

Parameter AnnotationId is the only required field and must be our system's unique identifier for the annotation you wish to edit.

Optional Parameters Explained

Spoiler, Privacy and Highlight: These fields are available for use in 3^rd party application integrations. These features are currently not settable via our system interface. Depending on your needs, you can ingnore these parameters.

Parameter Privacy can be one of these values: private, public, friends

Parameter Spoiler can be either true or false

Important

Only the optional parameters listed can be edited. Any other changes will require you to first delete the annotation, and then create a new one.

For every optional parameter, if it is passed in, the value entered will be updated. If you do not put a parameter in your request, that field will not be updated.

Next Method »