Skip to main content
POST
/
v1
/
plans
Create plan
curl --request POST \
  --url https://demo1-api.payrollintegrationsdemo.com/v1/plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "tpes": [
    {
      "tpeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planIdentifier": "<string>"
    }
  ]
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "displayName": "Example 401(k) Plan",
  "createdAt": "2024-01-15T10:30:00Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
displayName
string
required

Display name of the plan

Required string length: 1 - 200
tpes
object[]
required

Array of TPEs associated with the plan

Response

Plan created successfully