BIbigchange
Notes

Create a new flag for a note

Create a new flag for a note (required scope notes:write)

post/v1/notes/{noteId}/flags

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/notes/{noteId}/flags
  • Auth
    HTTP bearer

Path parameters

noteIdinteger required

The note identifier

Headers

Customer-Idinteger required

The customer identifier

Request body

flagIdinteger required

The unique identifier of the flag to apply

ownerstring

User email or ID who owns the flag

commentsstring nullable

Additional context for the flag

Example request

{
  "flagId": 12345,
  "owner": "john.doe@example.com",
  "comments": "Requires special attention"
}

Response

Created

idinteger

Identifier of the newly created record

Changes

No recorded changes to this operation across all 13 revisions of this API.