Relationship Intelligence

Confirm plan

Changed on

Confirm plan records that the other person confirmed the shared plan. The owner's records stay unchanged.

post/v1/public/mutual-action-plan/responses

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/public/mutual-action-plan/responses
  • Auth: none declared. Required headers: X-Oppulence-Plan-Token

Headers

X-Oppulence-Plan-Tokenstring required

Scoped plan response token. Never put this token in a URL or query parameter.

Request body

commentstring

Counterparty comment.

itemIdstring

Plan item id when applicable.

kind'confirm' | 'correct' | 'blocked' | 'completed' | 'comment' required

Response kind.

proposedValuestring

Proposed correction.

responseIdstring uuid required

Counterparty-generated idempotency key.

Example request

{
  "comment": "Waiting on legal.",
  "itemId": "item:8b8dfa9b-a7b2-46ea-982c-622a914c00e5",
  "kind": "confirm",
  "proposedValue": "Move due date to Friday.",
  "responseId": "db8dfa9b-a7b2-46ea-982c-622a914c00e5"
}

Response

The confirmation is recorded.

recordedboolean required

The confirmation is stored for the plan owner.

responseIdstring uuid required

The response that was recorded.

Example response

{
  "recorded": true,
  "responseId": "db8dfa9b-a7b2-46ea-982c-622a914c00e5"
}

Changes

  • d39ed3e21b7aRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 3a2247461042Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status