Upsert Onboarding Status

put https://dc1demogwext.paylocity.com/apiHub/security/v1/companies/b6001/companyOnboardingStatuses

🚧
Beta Phase
This resource is in closed beta. Paylocity Technology Partners interested may contact the marketplace team to explore early adopter opportunities at marketplaceapisupport@paylocity.com

Summary Description

The new Partner Onboarding API is designed to enable our partners to onboard customers through our Paylocity Marketplace-initiated workflow. Approved partners will utilize the API to provision a client onto a specific integration. This API provides an endpoint that allows partners to upsert the status of the integration, using the Paylocity companyId specified in the request body. Partners can update the companyOnboardingStatus to one of four options: InProgress, Approved, Rejected or Suspended. If approved the partner will be able to sync the requested client data through the API.

Responses

204

No Content - Resource has been updated.

Language


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://dc1demogwext.paylocity.com/apiHub/security/v1/companies/b6001/companyOnboardingStatuses \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/*+json' \
5
     --header 'testMode: false'


xxxxxxxxxx
 
1
{
2
  "companyId": " A00123",
3
  "onboardingStatus": "Approved",
4
  "additionalProp": {}
5
}

201Created - Resource has been created.

400Bad Request - Returns the details of the error.

404Not Found - Returns the details of the error.

415Unsupported Media Type - Returns the details of the error.