Skip to navigation

Set Account Notes

View as Markdown

Set the notes on an account’s risk status on Demo.

Available to: Organization administrators (accounts in their organization)

Environments: Demo

Rate Limit: No endpoint-specific limit

Set or clear the notes on an account’s risk status. Pass the accountId, the notes text (up to 8,192 characters), and an optional notesExpiration timestamp. Omit notes to clear them.

The response returns ok: true as soon as the request is accepted. The notes are written afterward, so a successful response doesn’t confirm the write.

Common Failure Scenarios

  • The request is sent to Live. This returns HTTP 401 with "Access is denied", not HTTP 501.
  • The caller isn’t an organization administrator. This returns HTTP 401 with "mustBeOrganizationAdmin".
  • No account matches accountId, or the caller can’t access it. Both return HTTP 404 with an empty body.
  • The caller’s user type, or the API key’s permissions, don’t include full access to the Risks resource. This returns HTTP 401 with "Access is denied".
  • accountId isn’t greater than 0, or notes is longer than 8,192 characters. These return HTTP 400.

Error Messages

MessageResponseTrigger
"Account Id should be greater than 0"400accountId isn’t greater than 0.
"Notes should be no longer than 8192"400notes is longer than 8,192 characters.
"Access is denied"401The caller’s user type, or the API key’s permissions, don’t include full access to the Risks resource.
"Access is denied"401Called on the Live environment.
"mustBeOrganizationAdmin"401Called on Demo by a caller who isn’t an organization administrator.
(no message text)404No account matches accountId, or the caller can’t see it.

Related Endpoints

  • Use resetAutoLiqStatus to reset an account’s risk status. A reset also clears its notes.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
accountIdlongRequired

Response

SimpleResponse
okboolean
errorTextstringOptional<=8192 characters

Non-empty if the request failed