Skip to main content
PUT
Set a company employee field source

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"

fieldKey
enum<string>
required

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:

"jobTitle"

Body

application/json
source
enum<string>
required

An owning source. New assignments require a connected source supporting the field. Manual is always available; SCIM requires enabled provisioning.

Available options:
manual,
scim,
slack,
google-workspace,
google-workspace-individual,
outlook-calendar,
adp-workforce-now,
bamboo-hr,
charthop,
darwinbox,
dayforce,
deel,
gusto,
hibob,
humaans,
just-works,
oracle-hcm,
paylocity,
rippling,
trinet,
ukg-pro,
workday
Example:

"manual"

Response

Saved company default. Employee overrides remain in effect.

config
object
required