Set, change or clear an ACT's access note

The place for a door, gate or lockbox code and how to use it — never the address, which is kept with the ACT for good, and never ACT chat. Only the Human who claims the ACT sees the note, and only while they work on it; it is never emailed and is erased when the ACT ends. Change it whenever the code changes, up to the ACT's end. A live key without a Mandate may do this: it spends nothing.

post/api/v1/acts/{id}/access-note

Request

  • Base URL: https://ableandagent.com
  • URL: https://ableandagent.com/api/v1/acts/{id}/access-note
  • Auth: HTTP bearer

Path parameters

idstring required

The ACT's public id: act_, six characters, a dash and five digits.

Request body

accessNotestring nullable required

Up to 500 characters. Blank is the same as null.

Example request

{
  "accessNote": "Gate code 4412#, then the side door on the left."
}

Response

Kept, or cleared.

idstring required
hasAccessNoteboolean required

Whether the ACT has an access note now. The note itself comes back when you read the ACT.

Changes

No recorded changes to this operation across all 1 revision of this API.