Skip to main content
POST
/
v1
/
plans
/
{plan}
/
invites
Create plan invite
curl --request POST \
  --url https://demo1-api.payrollintegrationsdemo.com/v1/plans/{plan}/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactEmail": "[email protected]",
  "redirectUrl": "<string>",
  "onboardingNotes": "<string>",
  "additionalEmails": [
    "[email protected]"
  ]
}
'
{
  "id": "770e8400-e29b-41d4-a716-446655440002",
  "planId": "550e8400-e29b-41d4-a716-446655440000",
  "email": "[email protected]",
  "status": "pending",
  "createdAt": "2024-01-15T10:30:00Z",
  "expiresAt": "2024-01-22T10:30:00Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
plan
string<uuid>
required

Body

application/json
​
contactEmail
string<email>
required

Primary email address of the plan sponsor

​
redirectUrl
string<uri>

URL to redirect after onboarding

​
onboardingNotes
string

Internal notes about the plan

​
additionalEmails
string<email>[]

Additional email addresses

Response

Plan invite created successfully

​
id
string<uuid>
required