Upsert Onboarding Status

put

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

🚧
Partner Restricted
The Partner Onboarding API is only available to approved partners who have signed a Paylocity Technology Partnership Agreement. If you are not yet a partner and are interested, please reach out to our team to discuss partnership opportunities.

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.

Body Params

Payload of query.

The onboarding details.

companyId

string | null

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. 
Allowable Values:
9 char max

onboardingStatus

string

enum

The status to indicate the onboarding stage for a customer where the account form was filled up and is currently under review by your team.

Allowed:

Headers

testMode

boolean

Defaults to false

If true all responses are mocked and generated randomly.

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

204

No Content - Resource has been updated.

Language

Loading…

Response

Choose an example:

application/json

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.