Skip to navigation

Put Assets Id Notes Note Id

View as Markdown

Replaces the content of one of the caller’s own notes on an asset the caller can see; a note written by anyone else returns 404, even for admins.

Authentication

AuthorizationBearer

OAuth 2.0 Client Credentials Flow. To obtain an access token:

  1. Request API credentials from HINDSITE support to receive your client_id and client_secret

  2. Make a POST request to obtain an access token:

POST https://app.hindsiteind.com/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET
  1. The response will contain your access token:
{
  "access_token": "your_access_token_here",
  "token_type": "Bearer",
  "expires_in": 7200,
  "created_at": 1234567890
}
  1. Include the token in subsequent API requests:
Authorization: Bearer your_access_token_here

Path parameters

idstringRequired
note_idstringRequired

Request

This endpoint expects an object.
contentstringRequired

The note body as rich-text HTML. Replaces the whole body; there is no partial update.

Response

updated Note
idstringOptional
ULID
contentstringOptional
Sanitized HTML content
plain_text_contentstringOptional
userobjectOptional
noteable_typestringOptional
noteable_idstringOptional
ULID
attachmentslist of objectsOptional
created_atlongOptional

Unix timestamp (seconds since epoch) when the record was created

updated_atlongOptional

Unix timestamp (seconds since epoch) when the record was last updated

Errors

404
Not Found Error