Change who a note is about or which app it's for

family.note.move

POST/api/v1/households/{household_id}/commands/family.note.move

Command
Rigel runs it
Applies offline

Moves a note without changing what it says, so noted_at stays. Send person_id or app as null to clear it; leave one out to keep it.

Parameters#

Change who a note is about or which app it's for: parameters
Field	Description
`household_id`pathstringrequired	The household's ID.
`Idempotency-Key`headerstringoptional	The command's ID. Reuse it when retrying the same command.

Request body#

JSON, as application/json.

Change who a note is about or which app it's for: request body fields
Field	Description
`note_id`stringrequired	A family note ID, such as fnt_01JC0000000000000000000000.
`person_id`string or nulloptional	A person ID, such as per_01JC0000000000000000000000.
`app`one of: meals, recipes, shopping, inventory, calendar, email, tasks, documents, chat, maintenance, null or nulloptional	An app: meals (meal planning), recipes, shopping, inventory, calendar, email, tasks, documents, chat, or maintenance (home maintenance).

Response#

200 The command was applied.

Change who a note is about or which app it's for: response fields
Field	Description
`result`objectrequired	What the command returned, such as the IDs it created.
`version`integerrequired	The household version after the command.

Errors#

Every error has the same envelope: error.code, error.message, error.details, error.recovery and error.request_id.

Change who a note is about or which app it's for: errors
Status	Code	When
`400`	`validation_failed`	A field is missing, misspelled or out of range. details.fields lists each problem.
`401`	`unauthenticated`	The request has no valid session.
`404`	`not_found`	The household doesn't exist, or you aren't a member of it.
`409`	`idempotency_key_reused`	The Idempotency-Key was already used for a different command.

Examples#

These are real. Each scenario is one of the command's test cases, run on a household when this site was built, and the response is what the API returned.

Moving a note to the household keeps when it was noted

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/family.note.move' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "note_id": "fnt_01JC000000000000000000000C",
  "person_id": null
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/family.note.move", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    note_id: "fnt_01JC000000000000000000000C",
    person_id: null,
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/family.note.move HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA

{
  "note_id": "fnt_01JC000000000000000000000C",
  "person_id": null
}

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9D9S2R06NKKZ600KX439WAJ

{
  "result": {},
  "version": 1
}

Make a note apply to every app

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/family.note.move' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01M6V9CS7QY4Z8ZXYFM55D64RP' \
  -d '{
  "note_id": "fnt_01M6V9CS7KC15H3QT502N0J25K",
  "app": null
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/family.note.move", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01M6V9CS7QY4Z8ZXYFM55D64RP",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    note_id: "fnt_01M6V9CS7KC15H3QT502N0J25K",
    app: null,
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/family.note.move HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01M6V9CS7QY4Z8ZXYFM55D64RP

{
  "note_id": "fnt_01M6V9CS7KC15H3QT502N0J25K",
  "app": null
}

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01M6V9CS7Q37P9E3BAE05YPMA1

{
  "result": {},
  "version": 11
}

For Rigel#

Rigel's tool for this command is family_note_move. Rigel runs this on its own, then says what it did. The agent guide has the rest.