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		Read-only; protected. Account note identifier.
account_id	string	yes	Immutable. ID of the account to which the note is assigned. Requires rights to perform operations on the account object: read for GET, modify for POST, PATCH, and DELETE.
note	string	yes	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

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

Get a Note From Account

Request

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

Example Request

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

curl -s -k -X GET \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  '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/json
Body	AccountNoteModel

Example Request

POST /api/v2/account/<id>/note

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

Response

{
    "result": "success"
}

Modify a Note

Request

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

Example Request

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

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

Response

{
    "result": "success"
}

Deleting a Note

Request

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

Example Request

DELETE /api/v2/account/<id>/note

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

Response

{
    "result": "success"
}