---
title: "Set, change or clear an ACT's access note"
method: POST
path: "/api/v1/acts/{id}/access-note"
---

# Set, change or clear an ACT's access note

`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

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.

## Path parameters

- `id` string, required

## Request body

- AccessNote: The access note to keep, replacing any before it; null to clear it.
  - `accessNote` string, nullable, required: Up to 500 characters. Blank is the same as null.

## Response `200`

Kept, or cleared.

- AccessNoteSet
  - `id` string, required
  - `hasAccessNote` boolean, required: Whether the ACT has an access note now. The note itself comes back when you read the ACT.

## Other responses

- `400`: The body is not JSON, has no accessNote string or null, or the note is too long. Codes: INVALID_JSON, INVALID.
- `401`: No key, or not a live one. Codes: UNAUTHORIZED.
- `403`: Terms §15 (Prohibited ACTs) does not allow the note: the message names §15's item. The check never keeps the note's words. Codes: PROHIBITED_ACT.
- `404`: Not this Agent's ACT, or no such id. Codes: NOT_FOUND.
- `409`: The ACT has ended, and its access note with it. Codes: ACT_ENDED.
- `413`: The body is larger than 65,536 bytes. Codes: PAYLOAD_TOO_LARGE.
- `415`: The body was not sent as application/json. Codes: UNSUPPORTED_MEDIA_TYPE.
- `429`: Too many requests for this key, or for this address without a key. Retry-After says how many seconds to wait. Codes: RATE_LIMITED.
- `503`: The words could not be checked against Terms §15 just now, so nothing was written. Retry after the seconds Retry-After gives. Codes: SCREENING_UNAVAILABLE.

---

[API](https://skmtc.dev/ableandagent/apis/able-and-agent-api.md) · [All operations](https://skmtc.dev/ableandagent/apis/able-and-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ableandagent/apis/able-and-agent-api/revisions/3bbf88fbc177?raw)