Skip to main content
PATCH
Update an employee profile

Authorizations

Authorization
string
header
required

Use an API key or OAuth access token. Enter only the token in the authorization dialog; requests send it as Authorization: Bearer <TOKEN>.

Create an API key in your workspace's Settings → API keys. Keys start with wm_api_ and only work in the workspace where they were created. Read-only keys can read data; creating, updating, or deleting data requires a read-write key.

OAuth access tokens are issued for connected Windmill applications.

Both token types use the authenticated user's workspace permissions. Each endpoint's permission requirements and the sharing settings of the requested items still apply.

Path Parameters

companyId
string
required

Company ID. A URL slug is also accepted. The caller must have access to this company.

Required string length: 1 - 128
Example:

"company-acme"

employeeId
string
required

Opaque employee ID in the company. This identifies an org-chart person, not a member or user.

Required string length: 1 - 128
Example:

"employee-avery"

Body

application/json

Supply at least one field. Omitted fields stay unchanged; null clears only nullable fields.

firstName
string

New first name, up to 200 characters. Omit to retain it; an empty string is accepted.

Maximum string length: 200
Example:

"Avery"

lastName
string

New last name, up to 200 characters. Omit to retain it; an empty string is accepted.

Maximum string length: 200
Example:

"Chen"

displayFullName
string

Display name to use for this employee. Omit it to retain the existing value.

Maximum string length: 400
Example:

"Avery Chen"

jobTitle
string | null

New job title, up to 256 characters. Omit to retain it or send null to clear it.

Maximum string length: 256
Example:

"Senior Engineer"

jobLevel
string | null

New job level, up to 256 characters. Omit to retain it or send null to clear it. Not included in this route's returned profile.

Maximum string length: 256
Example:

"L3"

managerId
string | null

New manager employee ID in the company. Omit to retain it or send null to remove the manager.

Required string length: 1 - 128
Example:

"employee-morgan"

primaryEmail
string | null

New primary email, up to 320 characters. A non-empty value must already be a known employee email. Null clears it.

Maximum string length: 320
Example:

"avery@example.test"

startDate
string<date> | null

New date in YYYY-MM-DD format. Omit to retain it or send null to clear it.

Example:

"2025-03-17"

gender
string | null

Employee gender value. Omit it to retain the value or send null to clear it.

Maximum string length: 256
pronouns
string | null

Employee pronouns. Omit them to retain the value or send null to clear them.

Maximum string length: 256
Example:

"they/them"

claimOwnership
enum<string>[]

Unique field keys to claim as manually owned. Claims can take over integration-owned or unowned fields without changing their values. Omit to leave ownership unchanged.

Maximum array length: 22

Employee profile field whose owning source is configured or resolved.

Available options:
avatarUrl,
dateOfBirth,
departments,
displayFullName,
employmentStatus,
employmentType,
ethnicity,
firstName,
preferredName,
gender,
jobLevel,
jobTitle,
lastName,
managerId,
maritalStatus,
phoneNumber,
primaryEmail,
pronouns,
startDate,
terminationDate,
workLocation,
country
Example:

Response

Extended employee profile after the patch.

employee
Employee · object
required

Employee profile returned by this operation.

Example: