org-annotations

Update an annotation

Changed on

Update an annotation (author or org admin/owner only).

Use this annotation operation for private workspace context attached to entries or sources. Annotations help teams decide what to do next but are not public evidence.

put/api/orgs/{org_id}/annotations/{annotation_id}

Request

  • Base URL: https://atlas.rebuildingus.org
  • URL: https://atlas.rebuildingus.org/api/orgs/{org_id}/annotations/{annotation_id}
  • Auth: none declared

Path parameters

org_idstring required
annotation_idstring required

Headers

x-api-keystring nullable

Request body

contentstring required

Updated annotation content

Response

Successful Response

author_idstring required

Author user ID

contentstring required

Annotation content

created_atstring required

Creation timestamp

entry_idstring nullable

Annotated entry ID

idstring required

Annotation ID

org_idstring required

Owning organization ID

source_idstring nullable

Annotated source ID

target_idstring required

Annotated entry or source ID

target_typestring required

entry | source

updated_atstring required

Last update timestamp

Changes

  • 6ea72ce93d40Revision changes
    • warning

      deleted the header request parameter x-atlas-actor-email

    • warning

      deleted the header request parameter x-atlas-actor-id

    • warning

      deleted the header request parameter x-atlas-internal-secret

    • warning

      deleted the header request parameter x-atlas-organization-id