API v2: Account Notes

Account notes related endpoints enable managing messages displayed to users in the User Portal (Access Gateway).


Data Structures

AccountNoteModel
Attribute Type Required Description
id string   Unique, read-only, protected account note identifier.
account_id string yes Immutable. ID of the account to which the note is assigned.
note string   Note content.
created_at datetime   Read-only. Timestamp of creation.
modified_at datetime   Read-only. Timestamp of modification.
removed boolean   Read-only.

Request for Retrieving Available Attributes of the AccountNoteModel

Method 
GET
Path 
/api/v2/objspec/account_note

Note

To check allowed methods, available URL parameters and possible responses please refer to the API Overview section.

The next chapter describes procedures for creating separate requests.


Retrieving a Note From Account

Request

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

Example Request

Sending GET https://10.0.0.0/api/v2/account/9124292845052624908/note

curl -s -k -X GET -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' https://10.0.214.98/api/v2/account/9124292845052624908/note

Response

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

Assign Note to an Account

Request

Method 
POST
Path 
/api/v2/account/<account_id>/note
Headers 
Content-Type: Application/HTML
Body 
AccountNoteModel

Example Request

Sending POST https://10.0.0.0/api/v2/account/9124292845052624908/note

curl -s -k -X POST -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' 'https://10.0.214.98/api/v2/account/9124292845052624908/note' -H 'Content-Type: application/HTML' -d'{"note":"Note content."}'

Response

{
    "result": "success"
}

Modifying a Note

Request

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

Example Request

Sending PATCH https://10.0.0.0/api/v2/account/9124292845052624908/note

curl -s -k -X PATCH -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' 'https://10.0.214.98/api/v2/account/9124292845052624908/note' -H 'Content-Type: application/HTML' -d'{"note":"Note modified content."}'

Response

{
    "result": "success"
}

Deleting a Note

Request

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

Example Request

Sending DELETE https://10.0.0.0/api/v2/account/9124292845052624908/note

curl -s -k -X DELETE -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' 'https://10.0.214.98/api/v2/account/9124292845052624908/note'

Response

{
    "result": "success"
}