Put Actions Id Notes Note Id

PUT

https://app.hindsiteind.com/api/v2/actions/:id/notes/:note_id

PUT

/api/v2/actions/:id/notes/:note_id

curl -X PUT https://app.hindsiteind.com/api/v2/actions/id/notes/note_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "content": "string"
}'

{
  "id": "string",
  "content": "string",
  "plain_text_content": "string",
  "user": {
    "id": "string",
    "email": "string",
    "name": "string",
    "is_admin": true,
    "location_manager": true,
    "last_active_at": 1,
    "archived": true,
    "organisation_id": "string",
    "created_at": 1,
    "updated_at": 1
  },
  "noteable_type": "string",
  "noteable_id": "string",
  "attachments": [
    {
      "blob_url": "string",
      "signed_id": "string",
      "filename": "string",
      "byte_size": 1,
      "content_type": "string",
      "preview_url": "string",
      "key": "string",
      "direct_upload": {
        "url": "string",
        "headers": {}
      }
    }
  ],
  "created_at": 1,
  "updated_at": 1
}

Replaces the content of one of the caller’s own notes on an action in the caller’s organisation (public users get 403); a note written by anyone else returns 404, even for admins.

Authentication

AuthorizationBearer

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

Request API credentials from HINDSITE support to receive your client_id and client_secret
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

The response will contain your access token:

{
  "access_token": "your_access_token_here",
  "token_type": "Bearer",
  "expires_in": 7200,
  "created_at": 1234567890
}

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

403

Forbidden Error

404

Not Found Error