Skip to content

Keep notes on a deal ​

Notes are your team's log of what happened around a deal: a phone call with the supplier, a promise made by email, why a date moved. They stay inside your workspace. Notes belong to B2B deals; a Platform mode marketplace deal has none and answers 404 NOT_FOUND.

NotesRoom messages
Who readsYour workspace, and RekberPay only when you share a note with itBoth workspaces and RekberPay
Shown to the counterparty or in the preview linkNeverYes, in the room
Can be deletedYes, by the author or an adminNo, append only
Length1 to 2,000 characters1 to 2,000 characters

Add a note ​

In the dashboard, open the deal and find the Notes card ("Calls, emails and promises on this deal"). Write the note, tick Share with RekberPay if RekberPay should read it too, and choose Add note.

With the API (operator role or higher):

bash
curl -X POST "https://api.rekberpay.com/v1/enterprise/deals/$DEAL_ID/notes" \
  -H "Authorization: Bearer $REKBERPAY_KEY" \
  -H "Idempotency-Key: $(uuidgen | tr 'A-Z' 'a-z')" \
  -H "Content-Type: application/json" \
  -d '{ "body": "Supplier asked to move installation one week. Finance agreed by phone." }'
js
const res = await fetch(`https://api.rekberpay.com/v1/enterprise/deals/${dealId}/notes`, {
    method: 'POST',
    headers: {
        Authorization: `Bearer ${process.env.REKBERPAY_KEY}`,
        'Idempotency-Key': crypto.randomUUID(),
        'Content-Type': 'application/json',
    },
    body: JSON.stringify({ body: 'Supplier asked to move installation one week. Finance agreed by phone.' }),
});
const { data: note } = await res.json();
json
{
    "success": true,
    "data": {
        "id": "33af2df6-dcf2-4821-8eea-5f924245cd25",
        "deal_id": "00451547-c621-48ca-b7cb-7726e6cd2ced",
        "milestone_id": null,
        "milestone_title": null,
        "author": {
            "id": "1861cccd-891e-49de-ac67-f457ca094b42",
            "name": "Quickstart Owner"
        },
        "body": "Supplier asked to move installation one week. Finance agreed by phone.",
        "visibility": "account",
        "created_at": "2026-10-28T14:38:58.154Z"
    }
}

The answer is 201 Created with the note. Add "milestone_id" to tie the note to one milestone of the deal (a milestone of another deal answers 404 NOT_FOUND), and "visibility": "rekberpay" to share it with RekberPay. With the default account, only your workspace reads it. A note written with a workspace key is signed with the name of the admin who created the key.

Read the notes ​

GET /v1/enterprise/deals/:id/notes returns the newest 20 first. Every member can read, viewers included. Pass limit (up to 50) and, for the next older page, before with the next_before of the page you have. next_before is null once there is nothing older. before also takes an ISO 8601 time, to read the notes written before that moment:

json
{
    "success": true,
    "data": {
        "items": [
            {
                "id": "33af2df6-dcf2-4821-8eea-5f924245cd25",
                "deal_id": "00451547-c621-48ca-b7cb-7726e6cd2ced",
                "milestone_id": null,
                "milestone_title": null,
                "author": {
                    "id": "1861cccd-891e-49de-ac67-f457ca094b42",
                    "name": "Quickstart Owner"
                },
                "body": "Supplier asked to move installation one week. Finance agreed by phone.",
                "visibility": "account",
                "created_at": "2026-10-28T14:38:58.154Z"
            }
        ],
        "next_before": null
    }
}

author is null once the author's account was removed.

Delete a note ​

The author can delete their own note, and an admin or owner can delete any note: Delete note in the dashboard, or DELETE /v1/enterprise/deals/:id/notes/:nid. Anyone else gets 403 FORBIDDEN. The answer is { "id": "<note id>", "deleted": true }. The text is gone for good. The activity feed keeps note.added and note.deleted events with who and when, never the text.

Limits ​

  • 60 note writes a minute per user, plus the shared 300 requests a minute.
  • Writes take an optional Idempotency-Key; send one so a retry never adds the note twice.
  • A note belongs to the deal's mode: a Sandbox deal's notes are only read in Sandbox.

The full field list and errors are in Documents and notes.

Escrow, payment services and B2B deals for Indonesian businesses.