Update note — Brigg developers

Access & visibility

Allow customers.UpdateNote on your API key. Resource read permissions: core:Note. Resource write permissions: core:Note.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

idstringRequired

ID of a visible core:Note record. Find it with customers.ListNotes. Use the record's top-level id, not a business field or account ID.

dataNoteOptional

The fields to set.

Note

Note2 fields

bodystringOptional

Customer activity note content, which may contain Markdown. Preserve the text and render it safely; this is not HTML.

occurred_atstringOptional

Date of the activity described by the note, in YYYY-MM-DD format. Creation time is recorded separately.

Related record and author3 fields

parent_typestringOptional

CRM parent type: core:Company, core:Person or core:Deal. Pair with parent_id. These resource identifiers differ from public operation namespaces.

parent_idstringOptional

Record ID within parent_type. The type and ID must identify the same parent.

author_refstringOptional

Person record representing the note's author, not the author's account ID. Brigg supplies the acting member's Person reference on creation when omitted.

unsetarray of stringOptional

Keys of data to remove.

Each item: "body", "occurred_at", "parent_type", "parent_id", "author_ref".

expectedobjectOptional

Prior business-field values that must still match before the write. Use fields from this record’s data object, without the data. prefix. Use {"$absent":true} as a value to require an absent field. A mismatch returns 409 conflict. See the conditional example for this resource.

Nested fields

bodystring or objectOptional

Commit only if the previous body value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

occurred_atstring or objectOptional

Commit only if the previous occurred_at value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

parent_typestring or objectOptional

Commit only if the previous parent_type value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

parent_idstring or objectOptional

Commit only if the previous parent_id value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

author_refstring or objectOptional

Commit only if the previous author_ref value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

Update without losing changes

Send only the business fields you want to change in data; omitted fields stay unchanged. Use unset to remove an optional field. Setting a field to null is a different action and is allowed only when its schema permits null.

Use expected for a conditional update: supply the values you last read for the fields whose concurrent changes would matter. {"$absent": true} expects a missing field. A conflict means you must read the record again and decide how to reconcile the change. Keep the same idempotency key when retrying the original action; use a new key for a revised action.

Response

Returns 200 OK with a JSON body.

Record metadata sits outside data. Timestamps created_at and updated_at are Unix milliseconds. Optional business fields may be absent; absence does not mean false or zero. A field accepts null only when its type includes null.

itemNoteRecordRequired

The requested record, including its metadata and data fields.

NoteRecord

idstringRequired

Stable core:Note record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited.

created_atnumberRequired

Time the record was created, in Unix milliseconds.

updated_atnumberRequired

Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads.

created_bystring or nullRequired

Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID.

privatebooleanRequired

True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules.

dataNoteRequired

The record's fields.

Note

Note2 fields

bodystringRequired

Customer activity note content, which may contain Markdown. Preserve the text and render it safely; this is not HTML.

occurred_atstringOptional

Date of the activity described by the note, in YYYY-MM-DD format. Creation time is recorded separately.

Related record and author3 fields

parent_typestringOptional

CRM parent type: core:Company, core:Person or core:Deal. Pair with parent_id. These resource identifiers differ from public operation namespaces.

parent_idstringOptional

Record ID within parent_type. The type and ID must identify the same parent.

author_refstringOptional

Person record representing the note's author, not the author's account ID. Brigg supplies the acting member's Person reference on creation when omitted.

Errors & retries

Set BRIGG_REQUEST_ID once for each logical action. The samples send it as Idempotency-Key. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying. Reuse the original Idempotency-Key.
409	`conflict`	A supplied expected value no longer matches. Read the record again before deciding whether to retry.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of a visible `core:Note` record. Find it with [customers.ListNotes](/developers/reference/customers/ListNotes). Use the record's top-level `id`, not a business field or account ID."
    },
    "data": {
      "type": "object",
      "properties": {
        "body": {
          "type": "string",
          "description": "Customer activity note content, which may contain Markdown. Preserve the text and render it safely; this is not HTML."
        },
        "occurred_at": {
          "type": "string",
          "description": "Date of the activity described by the note, in YYYY-MM-DD format. Creation time is recorded separately."
        },
        "parent_type": {
          "type": "string",
          "description": "CRM parent type: core:Company, core:Person or core:Deal. Pair with parent_id. These resource identifiers differ from public operation namespaces."
        },
        "parent_id": {
          "type": "string",
          "description": "Record ID within parent_type. The type and ID must identify the same parent."
        },
        "author_ref": {
          "type": "string",
          "description": "Person record representing the note's author, not the author's account ID. Brigg supplies the acting member's Person reference on creation when omitted."
        }
      },
      "required": [],
      "additionalProperties": false,
      "description": "The fields to set.",
      "title": "Note"
    },
    "unset": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "body",
          "occurred_at",
          "parent_type",
          "parent_id",
          "author_ref"
        ]
      },
      "description": "Keys of `data` to remove."
    },
    "expected": {
      "type": "object",
      "description": "Prior business-field values that must still match before the write. Use fields from this record’s data object, without the data. prefix. Use {\"$absent\":true} as a value to require an absent field. A mismatch returns 409 conflict. See the conditional example for this resource.",
      "additionalProperties": false,
      "properties": {
        "body": {
          "description": "Commit only if the previous body value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Customer activity note content, which may contain Markdown. Preserve the text and render it safely; this is not HTML."
            },
            {
              "type": "object",
              "properties": {
                "$absent": {
                  "type": "boolean",
                  "const": true,
                  "description": "Require the field to be missing, rather than present with a null value."
                }
              },
              "required": [
                "$absent"
              ],
              "additionalProperties": false
            }
          ]
        },
        "occurred_at": {
          "description": "Commit only if the previous occurred_at value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Date of the activity described by the note, in YYYY-MM-DD format. Creation time is recorded separately."
            },
            {
              "type": "object",
              "properties": {
                "$absent": {
                  "type": "boolean",
                  "const": true,
                  "description": "Require the field to be missing, rather than present with a null value."
                }
              },
              "required": [
                "$absent"
              ],
              "additionalProperties": false
            }
          ]
        },
        "parent_type": {
          "description": "Commit only if the previous parent_type value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "CRM parent type: core:Company, core:Person or core:Deal. Pair with parent_id. These resource identifiers differ from public operation namespaces."
            },
            {
              "type": "object",
              "properties": {
                "$absent": {
                  "type": "boolean",
                  "const": true,
                  "description": "Require the field to be missing, rather than present with a null value."
                }
              },
              "required": [
                "$absent"
              ],
              "additionalProperties": false
            }
          ]
        },
        "parent_id": {
          "description": "Commit only if the previous parent_id value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Record ID within parent_type. The type and ID must identify the same parent."
            },
            {
              "type": "object",
              "properties": {
                "$absent": {
                  "type": "boolean",
                  "const": true,
                  "description": "Require the field to be missing, rather than present with a null value."
                }
              },
              "required": [
                "$absent"
              ],
              "additionalProperties": false
            }
          ]
        },
        "author_ref": {
          "description": "Commit only if the previous author_ref value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Person record representing the note's author, not the author's account ID. Brigg supplies the acting member's Person reference on creation when omitted."
            },
            {
              "type": "object",
              "properties": {
                "$absent": {
                  "type": "boolean",
                  "const": true,
                  "description": "Require the field to be missing, rather than present with a null value."
                }
              },
              "required": [
                "$absent"
              ],
              "additionalProperties": false
            }
          ]
        }
      }
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "id": "e_note_example",
      "data": {
        "body": "Alex confirmed the pilot date and delivery checklist."
      }
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "item": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Stable core:Note record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited."
        },
        "created_at": {
          "type": "number",
          "description": "Time the record was created, in Unix milliseconds."
        },
        "updated_at": {
          "type": "number",
          "description": "Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads."
        },
        "created_by": {
          "type": [
            "string",
            "null"
          ],
          "description": "Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID."
        },
        "private": {
          "type": "boolean",
          "description": "True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules."
        },
        "data": {
          "type": "object",
          "properties": {
            "body": {
              "type": "string",
              "description": "Customer activity note content, which may contain Markdown. Preserve the text and render it safely; this is not HTML."
            },
            "occurred_at": {
              "type": "string",
              "description": "Date of the activity described by the note, in YYYY-MM-DD format. Creation time is recorded separately."
            },
            "parent_type": {
              "type": "string",
              "description": "CRM parent type: core:Company, core:Person or core:Deal. Pair with parent_id. These resource identifiers differ from public operation namespaces."
            },
            "parent_id": {
              "type": "string",
              "description": "Record ID within parent_type. The type and ID must identify the same parent."
            },
            "author_ref": {
              "type": "string",
              "description": "Person record representing the note's author, not the author's account ID. Brigg supplies the acting member's Person reference on creation when omitted."
            }
          },
          "required": [
            "body"
          ],
          "additionalProperties": false,
          "description": "The record's fields.",
          "title": "Note"
        }
      },
      "required": [
        "id",
        "created_at",
        "updated_at",
        "created_by",
        "private",
        "data"
      ],
      "additionalProperties": false,
      "description": "The requested record, including its metadata and data fields.",
      "title": "NoteRecord"
    }
  },
  "required": [
    "item"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "item": {
        "id": "e_note_example",
        "created_at": 1791276900000,
        "updated_at": 1791280800000,
        "created_by": "a_jamie",
        "private": false,
        "data": {
          "body": "Alex confirmed the pilot date and delivery checklist.",
          "occurred_at": "2026-10-06",
          "parent_type": "core:Company",
          "parent_id": "e_company_northstar"
        }
      }
    }
  ]
}

Try the request

Use your API key in a server environment.

Example scenarioAct as a memberRequires administrator-approved delegation.

Fictional values. Replace IDs and business details with values from your workspace.

Request

cURL

curl 'https://api.brigg.app/v1/operations/customers.UpdateNote' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "e_note_example",
  "data": {
    "body": "Alex confirmed the pilot date and delivery checklist."
  }
}'

TypeScript

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/customers.UpdateNote", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "id": "e_note_example",
    "data": {
      "body": "Alex confirmed the pilot date and delivery checklist."
    }
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "id": "e_note_example",
  "data": {
    "body": "Alex confirmed the pilot date and delivery checklist."
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.UpdateNote",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/customers.UpdateNote' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "e_note_example",
  "data": {
    "body": "Alex confirmed the pilot date and delivery checklist."
  }
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/customers.UpdateNote", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "id": "e_note_example",
    "data": {
      "body": "Alex confirmed the pilot date and delivery checklist."
    }
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "id": "e_note_example",
  "data": {
    "body": "Alex confirmed the pilot date and delivery checklist."
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.UpdateNote",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "item": {
    "id": "e_note_example",
    "created_at": 1791276900000,
    "updated_at": 1791280800000,
    "created_by": "a_jamie",
    "private": false,
    "data": {
      "body": "Alex confirmed the pilot date and delivery checklist.",
      "occurred_at": "2026-10-06",
      "parent_type": "core:Company",
      "parent_id": "e_company_northstar"
    }
  }
}

Illustrative values, not a live response.

Use a value you actually read. A concurrent change refuses the write with 409 conflict.

Request

cURL

curl 'https://api.brigg.app/v1/operations/customers.UpdateNote' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "e_note_example",
  "data": {
    "body": "Alex confirmed the pilot date and delivery checklist."
  },
  "expected": {
    "body": "Alex confirmed that the pilot will start on 19 October."
  }
}'

TypeScript

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/customers.UpdateNote", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "id": "e_note_example",
    "data": {
      "body": "Alex confirmed the pilot date and delivery checklist."
    },
    "expected": {
      "body": "Alex confirmed that the pilot will start on 19 October."
    }
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "id": "e_note_example",
  "data": {
    "body": "Alex confirmed the pilot date and delivery checklist."
  },
  "expected": {
    "body": "Alex confirmed that the pilot will start on 19 October."
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.UpdateNote",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/customers.UpdateNote' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "e_note_example",
  "data": {
    "body": "Alex confirmed the pilot date and delivery checklist."
  },
  "expected": {
    "body": "Alex confirmed that the pilot will start on 19 October."
  }
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/customers.UpdateNote", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "id": "e_note_example",
    "data": {
      "body": "Alex confirmed the pilot date and delivery checklist."
    },
    "expected": {
      "body": "Alex confirmed that the pilot will start on 19 October."
    }
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "id": "e_note_example",
  "data": {
    "body": "Alex confirmed the pilot date and delivery checklist."
  },
  "expected": {
    "body": "Alex confirmed that the pilot will start on 19 October."
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.UpdateNote",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "item": {
    "id": "e_note_example",
    "created_at": 1791276900000,
    "updated_at": 1791280800000,
    "created_by": "a_jamie",
    "private": false,
    "data": {
      "body": "Alex confirmed the pilot date and delivery checklist.",
      "occurred_at": "2026-10-06",
      "parent_type": "core:Company",
      "parent_id": "e_company_northstar"
    }
  }
}

Illustrative values, not a live response.