Make an action plan

Request

Make a new action plan with its steps. Send an Idempotency-Key so a retry makes one plan, not two. Use this when someone asks to plan the work for an account or a pursuit. Answers 201 with the plan; the same Idempotency-Key and body again answers 200 with the same id.

Security

bearerKey

Idempotency-Keystring, [ 1 .. 128 ] characters

1 to 128 characters. A retry with the same key and body returns the first result; the same key with another body is 409.

Bodyapplication/jsonrequired

titlestring, [ 1 .. 200 ] charactersrequired

objectivestring, [ 1 .. 2000 ] charactersrequired

purposestring

Default:"general"

Enum:"general""pursuit"

stepsArray of objects, <= 100 items

Default:[]

curl -i -X POST \
  https://docs.hrcledger.com/_mock/docs/openapi/api/v1/actions/plans \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Win Inova",
    "objective": "Win the Inova imaging contract",
    "purpose": "pursuit",
    "steps": [
      {
        "title": "Call the CFO",
        "dueDate": "2026-10-21",
        "assigneeUserId": 7
      },
      {
        "title": "Send the security review"
      }
    ]
  }'

Responses

A retry: the same Idempotency-Key and body as a 201 before it; the same id.

Bodyapplication/json

okanyrequired

Value:true

dataobject(PublicPlan)required

Response

{
  "ok": true,
  "data": {
    "id": "Pln5tH8jKw2qR6mX9vBz",
    "url": "https://hrcledger.com/actions/items/Pln5tH8jKw2qR6mX9vBz",
    "title": "Win Inova",
    "objective": "Win the Inova imaging contract",
    "archived": false,
    "steps": [ … ],
    "revisionNo": 3,
    "updatedAt": "2026-10-16T14:02:11.000Z"
  }
}