UAG - Account Notes

Note

The note_access_level attribute indicates the user’s access to account-related notes:

• none – no access,

• read – read-only access,

• write – full access (read and modify).

This value is defined by the note_access setting on the associated Safe.

To change it via API, use the following request:

curl -s -k -X PATCH \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  -H 'Content-Type: application/json' \
  https://<host>/api/v2/safe/<safe_id> \
  -d '{"note_access": "read"}'

For full details, refer to the section Safes.

Data Structures

AccountNoteModel

Attribute	Type	Required	Description
id	string		Read-only. Account Note ID.
account_id	string	yes	Immutable. Account ID.
note	string	yes	Text of the note.
created_at	datetime		Read-only. Timestamp of creation.
modified_at	datetime		Read-only. Timestamp of modification.
removed	boolean		Read-only.

Retrieve Available Attributes of the AccountNoteModel

Request

Method	GET
Path	/api/v2/objspec/account_note

GET /api/v2/objspec/account_note

Example Request

curl -s -k -X GET \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  'https://10.0.214.98/api/v2/objspec/account_note'

Get Account Notes

Request

Method	GET
Path	/api/v2/account/<account_id>/note

GET /api/v2/account/<account_id>/note

Example Request

curl -s -k -X GET \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  https://10.0.0.1/api/v2/account/8169529724050079749/note

Response

{
    "note": "Note content.",
    "result": "success"
}

Update Account Note

Request

Method	PATCH
Path	/api/v2/account/<account_id>/note
Headers	Content-Type: application/json
Body	AccountNoteModel

PATCH /api/v2/account/<account_id>/note

Example Request

curl -s -k -X PATCH \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  -H 'Content-Type: application/json' \
  https://10.0.0.1/api/v2/account/8169529724050079749/note \
  -d '{"note": "Updated note."}'

Response

{
    "note": "Updated note.",
    "result": "success"
}