alpha

Update advisor actions (v2)

Change an Advisor action as the caller (the member, the operator viewing as them, or the API key, recorded on each event): its status (open, in progress, completed or dismissed; dismissing needs a reason), a note, or its whole content as a new revision (naming the revision it was edited from; changed since is stale; keeping the subject and expected effect keeps the action's value, changing either unprices it). A status or content revision makes the action the caller's: autotracking stops changing its status, and reviews stop revising, retiring or merging it, until automation is restored; a note alone changes neither. Answers the action now, every event it recorded in order (the status change, a note the change could not carry, the change of control) and its content revision; a retried Idempotency-Key writes nothing and answers the same.

post/api/v1/alpha/advisor-actions/update-v2

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/alpha/advisor-actions/update-v2
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

actionIdstring uuid required
state'acknowledged' | 'in_progress' | 'done' | 'dismissed'

acknowledged is Open; done is Completed

dismissalReasonstring
notestring
expectedRevisioninteger

With content: the actionRevision it was edited from; a change since refuses as STALE_WRITE

Response

Success.

eventIdsstring[] required

Every event recorded, in order: the status change, a note it could not carry, and the change of control when a person or key took the action from automation; empty when it changed nothing

revisionIdstring uuid nullable required

The content revision written; null without content

Changes

No recorded changes to this operation across all 1 revision of this API.