---
title: "Partially update an existing agreement"
method: PATCH
path: "/v2/employee/agreements/{id}"
tags: ["Agreements"]
---

# Partially update an existing agreement

`PATCH /v2/employee/agreements/{id}`

## Query parameters

- `agreementRestId` union, required — An identifier that can be either a Quinyx ID or a prefixed external ID string.
  - string — The Quinyx ID of the resource.
  - string — The external string ID, which must start with 'xrefId:'.

## Request body

- EmployeeAgreementPatchRequest
  - `payroll` EmployeePayroll
    - `payScheduleId` string

## Response `200`

Agreement details

- EmployeeAgreementResponse
  - `id` string
  - `xrefId` string
  - `name` string
  - `payroll` EmployeePayroll
    - `payScheduleId` string

## Other responses

- `401` — Unauthorized. Missing Bearer token.
- `403` — Forbidden. Missing permission: agreement:update
- `404` — Agreement or credential's customer are not found.

---

[API](https://skmtc.net/quinyx/apis/quinyx-api.md) · [All operations](https://skmtc.net/quinyx/apis/quinyx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/quinyx/quinyx-api/revisions/70a12bbb88c9/schema)
