Set Account Notes
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 401with"Access is denied", notHTTP 501. - The caller isn’t an organization administrator. This returns
HTTP 401with"mustBeOrganizationAdmin". - No account matches
accountId, or the caller can’t access it. Both returnHTTP 404with an empty body. - The caller’s user type, or the API key’s permissions, don’t include full access to the
Risksresource. This returnsHTTP 401with"Access is denied". accountIdisn’t greater than 0, ornotesis longer than 8,192 characters. These returnHTTP 400.
Error Messages
Related Endpoints
- Use
resetAutoLiqStatusto 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.
accountId
Response
SimpleResponse
ok
errorText
Non-empty if the request failed