Update Skill (Partial)

🚧

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 Update Skill (Partial) endpoint updates specific fields on an existing skill definition using JSON Patch (RFC 6902). Send an array of operations; only the fields you reference are changed and everything else stays the same. Most updates use the replace operation. Changes to a skill definition also apply to the employees who have the skill. The update returns 204 No Content; call Get Skill to see the updated skill.

Use Cases

  • Deactivate a skill (set active to false) so it can no longer be assigned, without removing existing employee records.
  • Change how long a skill stays valid or how far ahead renewal is flagged.

Company Set Behavior

Because skills are shared across the company set, changes apply to the skill for every Company ID in the set, and to the employees who have the skill.

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.

uuid
required

The unique identifier (UUID) of the skill definition. Get this value from List Company Skills or Create Skill.

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

An RFC 6902 JSON Patch document describing the skill fields to change, for example /active, /expirationInfo/durationValue, or /renewalNotification/durationValue. Values can be any JSON type (string, number, boolean, or object).

A list of JSON Patch operations.

Responses
204

No Content. The skill was updated.

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. No skill with this skillKey exists in the company set.

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