Request Skill Removal

🚧

Early Access (EA)

This API is currently in Early Access and available only to approved EA participants. Do not rely on this version for production workloads unless explicitly authorized. If you have any feedback, please share with your designated Early Adoption program representative.

Summary Description

The Request Skill Removal endpoint removes one or more skills from the company's skill catalog. Only skills that are not assigned to any employee can be removed. The request returns 201 Created with no response body.

Use Cases

  • Clean up skills that are no longer used, such as a retired certification.
  • Remove skills created in error during setup.

Company Set Behavior

Because skills are shared across the company set, removing a skill removes it for every Company ID in the set. A skill that is still assigned to any employee in the company set cannot be removed: the request returns 400 Bad Request for that skill. Delete the employee assignments first, or set active to false with Update Skill (Partial) to stop new assignments without removing history.

Path Params
string
required
length ≤ 9

The Paylocity Company ID. This is the unique value provided by Paylocity to each specific payroll entity. Skills are shared across the company set, so this Company ID determines which company set is used.

Query Params
boolean
Defaults to false

When true, returns sample (mocked) responses without reading or changing any real data, and without validating the request body. Authentication and company access are still checked. Use for integration testing only. Must be true or false. Default: false.

Body Params

One item per skill to remove from the company skill catalog.

A list of skill removal requests.

Responses
201

Created. The removal request was accepted. No response body is returned.

401

Unauthorized. The bearer token is missing, invalid, or expired. Request a new access token and try again.

403

Forbidden. The token is valid, but the API client is not authorized to access this API or this company.

404

Not Found. The Company ID does not exist or is not accessible to the API client.

429

Too Many Requests. The API client exceeded the rate limit of 3 requests per second. Wait briefly, then retry using a backoff strategy.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json