Skip to main content

Set client account comment

POST 
/v1/partnership/reports/clients/comment

Create or replace the partner comment associated with a client trading account and comment type. After an unknown write outcome, read the Client accounts report before retrying.

Required scopes:

  • write: partnership.all.

Runtime restrictions:

  • The partner_account and client_account pair must identify a client-account record visible to the partner associated with the API key. Otherwise, the operation returns NotFound.

Rules:

  • comment can contain up to 700 characters. An empty string replaces the current comment with an empty value.
  • comment_type must be CLIENT or SUBPARTNER; when omitted, it defaults to CLIENT.
  • A comment is unique for the partner_account, client_account, and comment_type combination. A subsequent request for the same combination replaces the existing comment.

Rate limits:

  • This operation counts toward the shared limit of 600 requests per 60 seconds per partner, across all of the partner's API keys and all Partnership API operations.

Consistency and recovery notes:

  • The current Partnership API does not provide idempotent-write semantics. After a timeout or connection failure, read the affected resource or list before deciding whether to retry.

Possible errors:

  • Throttled
  • ServiceTransportError
  • Error
  • AuthenticationFailed
  • PermissionDenied
  • ValidationError
  • NotFound

Request​

Responses​

Successful response.