# Update an employer

**PATCH /employers/{employer_id}**

Update an employer's configuration. All fields are optional — only provided fields are updated.


## Servers
- https://payroll-api.getpenfold.dev/v4: https://payroll-api.getpenfold.dev/v4 ()


## Authentication methods
- O auth2 client credentials


## Parameters



### Body: application/json (object)

- **primary_contact_email** (string(email))
  The email address of the employer primary contact.

- **primary_contact_role** (string)
  The role of the employer primary contact.

- **payroll_frequencies** (array[object])
  Payroll frequencies to **add** for this employer. Additive only: each value
  is added if not already configured; existing frequencies are never removed
  by this field. Sending a frequency that is already set is a no-op.

- **default_employer_contributions_percent** (number)
  The default contribution percentage for the employer.

- **default_employee_contributions_percent** (number)
  The default contribution percentage for the employee.

- **contribution_basis** (string)
  The basis on which the employer makes pension contributions.

- **allows_salary_sacrifice** (boolean)
  Whether the employer allows for salary sacrifice.

- **payment_method** (string)
  The payment method used by the employer.



## Responses
### 200
Employer updated successfully

#### Body: application/json (object)
- **id** (string)
  The unique identifier for the employer.

- **created_at** (string(date-time))
  The date and time the employer record was created, in ISO 8601 format.

- **updated_at** (string(date-time))
  The date and time the employer record was last updated, in ISO 8601 format.

- **name** (string)
  The name of the employer.

- **contribution_basis** (string)
  The basis on which the employer makes pension contributions. **Informational
  only** — Penfold does not validate submitted contribution amounts against this
  basis. Integrators must compute final amounts themselves. Possible values:

  - `QualifyingEarnings`: contributions calculated on banded earnings (currently £6,240–£50,270).
  - `TotalPay`: contributions calculated on all earnings, with no banding.
  - `BasicPay`: contributions calculated on basic pay only.

- **allows_salary_sacrifice** (boolean)
  Whether the employer allows for salary sacrifice. **Informational only** — used to provide a tailored experience to members in the Penfold app. Penfold processes submissions as-is and makes no amendments to contribution amounts; integrators must provide final amounts regardless of salary sacrifice status.

- **external_reference** (string)
  An external reference for the employer. Should be used as the value in the EmployerId column in file uploads.

- **company_number** (string)
  Companies House registration number.

- **payment_method** (string | null)
  The payment method used by the employer.

- **primary_contact_email** (string(email) | null)
  The email address of the primary contact for the employer.

- **primary_contact_role** (string | null)
  Role of the employer primary contact.

- **default_employee_contributions_percent** (number | null)
  Default employee contribution percentage.

- **default_employer_contributions_percent** (number | null)
  Default employer contribution percentage.

- **status** ()
  The status of the employer.


### 400
Request body failed validation

#### Body: application/json (object)
- **error** (string)
  A descriptive error message.

- **validation_errors** (array[object])


### 401
Missing or invalid authentication token

#### Body: application/json (object)
- **error** (string)
  A descriptive error message.


### 404
Resource not found

#### Body: application/json (object)
- **error** (string)
  A descriptive error message.


### 500
Internal server error

#### Body: application/json (object)
- **error** (string)
  A descriptive error message.



[Powered by Bump.sh](https://bump.sh)