Document Notes API permissions and endpoints

[promptless-for-oss]

Note: This PR replaces mautic/user-documentation#425. All commits from mautic/user-documentation#425 are preserved.

Open this suggestion in Promptless to view citations and reasoning process

Documents the new lead:notes permission set introduced in Mautic PR #16067. Adds comprehensive Notes API endpoint documentation and updates the List Contact Notes endpoint to specify the new permission requirements. Fresh branch from 7.2 as requested by reviewer.

---

Tip: Filter the Dashboard by labels or assignees to focus on what matters to you 🔎

[promptless-for-oss]

The List Contact Notes endpoint now requires lead:notes permissions instead of lead:leads permissions, as implemented in LeadBundle/Controller/Api/NoteApiController.php in PR #16067.

Source: mautic/mautic#16067

[adiati98]

@promptless-for-oss please address the suggestions

[promptless-for-oss]

Thanks for the review, @adiati98!

I've removed the redundant "Available permissions:" label as suggested. The table now follows directly after the introductory paragraph.

[adiati98]

@promptless-for-oss please address the suggestions

[promptless-for-oss]

Thanks for the review feedback @adiati98! I've addressed all your suggestions:

1. Professional text example — Changed from "Jim is super cool!" to "Discussed product demo requirements. Follow-up scheduled for next week."
2. Total count — Updated from 1 to 2 to better illustrate list responses
3. List continuation — Added // ... after the first object to indicate additional items

The changes have been pushed to this PR.

[adiati98]

/aside @escopecz, this PR replaces #425 that's closed due to issues with resolving conflicts. All commits and contents from that PR are preserved.

I have a question. Is "Note" introduced in version 7.2 or earlier version? If from earlier, can you advise from which version?

I need this info to know whether we need to backport this PR to other branches and add "Note" and "Notes" to the Mautic feature list in other branches than 7.2.

TIA! ✨

[escopecz]

Notes are there from the very beginning (version 1.0.0) I couldn't find any older PR regarding notes than this fix for note API: mautic/mautic#716 from Mautic 1.2.0. So the notes feature itself must have been there before that.

[promptless-for-oss]

Thanks for the historical context! You're right that Notes have been a core Mautic feature since version 1.0.0.

This documentation PR focuses specifically on the new lead:notes permission set introduced in PR #16067, which adds dedicated permissions for Notes management. The Notes API endpoints themselves have existed, but now they have their own permission controls separate from the general Contact permissions.

No changes needed to the documentation based on this feedback - just wanted to acknowledge the helpful context about the feature's history.