Skip to main content
POST
/
tpa
/
plan
/
create
Create TPA Plan
curl --request POST \
  --url https://api.stax.ai/tpa/plan/create \
  --header 'Content-Type: application/json' \
  --cookie authToken= \
  --data '
{
  "planName": "<string>",
  "planType": "<string>",
  "internalPlanId": "<string>",
  "pensionProId": 123,
  "endMm": 123,
  "endDd": 123,
  "active": true,
  "directory": "<string>"
}
'
{
  "success": true,
  "plan": {
    "_id": "<string>",
    "team": "<string>",
    "pensionProId": 123,
    "internalPlanId": "<string>",
    "planName": "<string>",
    "planType": "<string>",
    "endMm": 123,
    "endDd": 123,
    "active": true,
    "directory": "<string>",
    "ppLock": true,
    "search": [
      "<string>"
    ],
    "notes": [
      {
        "author": "<string>",
        "timestamp": "2023-11-07T05:31:56Z",
        "content": "<string>"
      }
    ],
    "lastModified": "2023-11-07T05:31:56Z",
    "assignees": [
      "<string>"
    ],
    "status": {}
  }
}

Authorizations

authToken
string
cookie
required

Cookie-based authentication using userId and authToken cookies

Body

application/json
planName
string
required
planType
string
internalPlanId
string
pensionProId
number
endMm
number
endDd
number
active
boolean
directory
string

Response

200 - application/json

Plan created

success
boolean
plan
object