Sets CURRENT to restore an employee or FORMER to archive them without deleting their record. Repeating the existing status succeeds without a change. Rippling-managed employees cannot change status through this endpoint. An employee with active workspace access or a current direct report cannot become FORMER; remove their workspace access and reassign their direct reports first. Returns the updated employee profile. Requires permission to manage employee profiles (org_chart.manage).
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.
Authorization: Bearer wm_api_example
OAuth access tokens are issued for connected Windmill applications.
Authorization: Bearer <OAUTH_ACCESS_TOKEN>
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
employmentStatus
enum<string>
required
CURRENT means the employee is not archived; FORMER means archived. Employment status is separate from member access.
Available options:
CURRENT,
FORMER
Example:
"CURRENT"
Response
Employee profile with the requested employment status.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Windmill Help Site","colors":{"primary":"#4084FB","light":"#7aadff","dark":"#1758c1"},"logo":{"light":"https://mintcdn.com/windmill/438SkEPmWnjrcDyT/logo/light.svg?fit=max\u0026auto=format\u0026n=438SkEPmWnjrcDyT\u0026q=85\u0026s=911e75d2985851400d148f9e5e20c94f","dark":"https://mintcdn.com/windmill/438SkEPmWnjrcDyT/logo/dark.svg?fit=max\u0026auto=format\u0026n=438SkEPmWnjrcDyT\u0026q=85\u0026s=3942c2e1a12a8a71050cdb71a6613cf0"},"favicon":"https://mintcdn.com/windmill/438SkEPmWnjrcDyT/favicon.svg?fit=max\u0026auto=format\u0026n=438SkEPmWnjrcDyT\u0026q=85\u0026s=d0f6bb9380e55bd874dafc8c7a0bf0cc","navbar":{"links":[{"href":"mailto:support@gowindmill.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.gowindmill.com"}},"footer":{"socials":{"x":"https://x.com/trywindmill","linkedin":"https://www.linkedin.com/company/gowindmill"}},"seo":{"metatags":{"og:site_name":"Windmill Help Center"}},"contextual":{"options":["copy","view"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"windmill","hasAudioNarration":false,"actualSubdomain":"windmill","customDomains":["help.gowindmill.com"],"gitSource":{"type":"github","owner":"windmill-dev","repo":"windmill-help","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aff06a676e1397cafb01751","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"Platform","count":143},{"language":"default","tag":"Review Cycles","count":50},{"language":"default","tag":"API reference","count":48},{"language":"default","tag":"Integrations","count":44},{"language":"default","tag":"Endpoints","count":39},{"language":"default","tag":"Productivity","count":30},{"language":"default","tag":"Pulse surveys","count":28},{"language":"default","tag":"Features","count":17},{"language":"default","tag":"Getting started","count":16},{"language":"default","tag":"Groups","count":16}]},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"loom-embed.css","content":"[data-loom]{position:relative;aspect-ratio:16 / 9;background:#000;border-radius:0.75rem;overflow:hidden;margin-bottom:1rem}[data-loom]>a{position:absolute;inset:0;display:block}[data-loom] img{width:100%;height:100%;margin:0;border-radius:0;object-fit:contain;object-position:center}[data-loom]::before{content:attr(data-title);position:absolute;inset:0;z-index:1;pointer-events:none;padding:1rem 1.25rem;color:#fff;font-weight:600;font-size:1.25rem;line-height:1.25;text-shadow:0 1px 4px rgba(0, 0, 0, 0.4);background:linear-gradient(\n to bottom,\n rgba(0, 0, 0, 0.75) 0%,\n rgba(0, 0, 0, 0.28) 45%,\n rgba(0, 0, 0, 0.28) 100%\n );transition:opacity 0.5s}[data-loom][data-duration]::after{content:attr(data-duration);position:absolute;bottom:0.75rem;right:0.75rem;z-index:1;pointer-events:none;border-radius:0.375rem;background:rgba(0, 0, 0, 0.7);padding:0.125rem 0.5rem;font-size:0.75rem;font-weight:500;font-variant-numeric:tabular-nums;color:#fff;transition:opacity 0.5s}[data-loom]>a::after{content:\"\";position:absolute;inset:0;z-index:1;margin:auto;width:clamp(72px, 15%, 124px);aspect-ratio:1;border-radius:100%;box-shadow:0 1px 6px rgba(0, 0, 0, 0.25);background:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 90 90' fill='none'%3E%3Cpath fill='%23ffffff' opacity='0.3' d='M45 90C69.8529 90 90 69.8527 90 44.9999C90 20.1471 69.8529 0 45 0C20.1472 0 0 20.1471 0 44.9999C0 69.8527 20.1472 90 45 90Z'/%3E%3Cpath fill='%23ffffff' d='M45 85C67.0914 85 85 67.0913 85 44.9999C85 22.9086 67.0914 5 45 5C22.9086 5 5 22.9086 5 44.9999C5 67.0913 22.9086 85 45 85Z'/%3E%3Cpath fill='%23000000' opacity='0.8' d='M35 33.268V56.732C35 58.5212 37.0582 59.6083 38.6432 58.6344L57.8999 46.9025C59.3667 46.0192 59.3667 43.9808 57.8999 43.0749L38.6432 31.3656C37.0582 30.3917 35 31.4788 35 33.268Z'/%3E%3C/svg%3E\")\n center / contain no-repeat;transition:transform 0.2s, opacity 0.5s}[data-loom]:hover>a::after,[data-loom]:focus-within>a::after{transform:scale(1.1)}[data-loom]>iframe{position:absolute;inset:0;width:100%;height:100%;z-index:2;border:0;opacity:0;pointer-events:none;transition:opacity 0.5s}[data-loom][data-playing]>iframe{opacity:1;pointer-events:auto}[data-loom][data-playing]::before,[data-loom][data-playing]::after,[data-loom][data-playing]>a::after{opacity:0}[data-loom]>button{position:absolute;inset:0;width:100%;height:100%;z-index:3;cursor:pointer;background:transparent;border:0;padding:0}"}]}
{"page":{"pagePath":"api-reference/employees/set-an-employees-employment-status","slug":"/api-reference/employees/set-an-employees-employment-status","pageMetadata":{"title":"Set an employee's employment status","description":"Sets CURRENT to restore an employee or FORMER to archive them without deleting their record. Repeating the existing status succeeds without a change. Rippling-managed employees cannot change status through this endpoint. An employee with active workspace access or a current direct report cannot become FORMER; remove their workspace access and reassign their direct reports first. Returns the updated employee profile. Requires permission to manage employee profiles (`org_chart.manage`).","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json put /c/{companyId}/employees/{employeeId}/employment-status","href":"/api-reference/employees/set-an-employees-employment-status","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Sets CURRENT to restore an employee or FORMER to archive them without deleting their record. Repeating the existing status succeeds without a change. Rippling-managed employees cannot change status through this endpoint. An employee with active workspace access or a current direct report cannot become FORMER; remove their workspace access and reassign their direct reports first. Returns the updated employee profile. Requires permission to manage employee profiles (\", _jsx(_components.code, {\n children: \"org_chart.manage\"\n }), \").\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Set an employee's employment status","description":"Sets CURRENT to restore an employee or FORMER to archive them without deleting their record. Repeating the existing status succeeds without a change. Rippling-managed employees cannot change status through this endpoint. An employee with active workspace access or a current direct report cannot become FORMER; remove their workspace access and reassign their direct reports first. Returns the updated employee profile. Requires permission to manage employee profiles (`org_chart.manage`).","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json put /c/{companyId}/employees/{employeeId}/employment-status","href":"/api-reference/employees/set-an-employees-employment-status","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"employees.employmentStatus.update","summary":"Set an employee's employment status","description":"Sets CURRENT to restore an employee or FORMER to archive them without deleting their record. Repeating the existing status succeeds without a change. Rippling-managed employees cannot change status through this endpoint. An employee with active workspace access or a current direct report cannot become FORMER; remove their workspace access and reassign their direct reports first. Returns the updated employee profile. Requires permission to manage employee profiles (`org_chart.manage`).","x-windmill-capabilities":{"allOf":["org_chart.manage"]},"tags":["Employees"],"security":["12cd0f57-b267-4156-9989-b66636809110"],"parameters":["da603677-952d-46c3-8123-0f3f7e7d9f2c","0f576667-0d2d-4418-a467-1e395dd723b9"],"requestBody":"dcc20084-1094-4fa8-af9c-2454d7e3601f","responses":{"200":"dfd1bb7d-b423-4f80-b30e-a1eca5c15f77","400":"ebebad4c-fa66-4172-b336-38296460db64","401":"73d959a2-1552-4564-b177-f7cace31a852","403":"e0b7d4a7-ce5e-4e21-8a77-37b392030609","404":"f5f7a41c-c574-4fd5-a68d-98a13236b764","429":"aadd33b6-a6ce-4e99-aacf-3abd71773660"},"method":"put","type":"path","servers":["bc3cc9da-1158-4cfa-97b3-e455483a1d98"],"path":"/c/{companyId}/employees/{employeeId}/employment-status","baseUrlOptions":["https://api.gowindmill.com/api/v2"],"title":"Set an employee's employment status","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"da603677-952d-46c3-8123-0f3f7e7d9f2c":{"schema":{"type":"string","minLength":1,"maxLength":128,"description":"Company ID. A URL slug is also accepted. The caller must have access to this company.","title":"Company ID","example":"company-acme","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"Company ID. A URL slug is also accepted. The caller must have access to this company.","name":"companyId","in":"path"},"0f576667-0d2d-4418-a467-1e395dd723b9":{"schema":{"type":"string","minLength":1,"maxLength":128,"description":"Opaque employee ID in the company. This identifies an org-chart person, not a member or user.","title":"Employee ID","example":"employee-avery","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"Opaque employee ID in the company. This identifies an org-chart person, not a member or user.","name":"employeeId","in":"path"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"employmentStatus":{"type":"string","enum":["CURRENT","FORMER"],"description":"CURRENT means the employee is not archived; FORMER means archived. Employment status is separate from member access.","title":"Employment status","example":"CURRENT","isRequired":true,"uniqueKey":"employmentStatus","typeLabel":"enum\u003cstring>"}},"required":["employmentStatus"],"additionalProperties":false,"title":"Set employee employment status request","example":{"employmentStatus":"FORMER"},"uniqueKey":"","typeLabel":"Set employee employment status request · object"},"examples":{"Example":{"title":"Example","value":{"employmentStatus":"FORMER"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"dfd1bb7d-b423-4f80-b30e-a1eca5c15f77":{"description":"Employee profile with the requested employment status.","content":{"application/json":{"schema":{"type":"object","properties":{"employee":{"type":"object","title":"Employee","description":"Employee profile returned by this operation.","required":["startDate","timezone","employmentStatus","emails","directReportsCount","directReportMembersCount","manager","id","name","avatarUrl","jobTitle","managerId","primaryEmail","phoneNumber","firstName","preferredName","lastName","isActiveMember"],"example":{"id":"employee-avery","name":"Avery Chen","avatarUrl":null,"jobTitle":"Engineer","managerId":"employee-morgan","primaryEmail":"avery@example.test","phoneNumber":null,"firstName":"Avery","preferredName":null,"lastName":"Chen","isActiveMember":true,"startDate":"2025-03-17","timezone":"America/New_York","employmentStatus":"CURRENT","emails":["avery@example.test"],"directReportsCount":0,"directReportMembersCount":0,"manager":{"id":"employee-morgan","name":"Morgan Reed","avatarUrl":null,"jobTitle":"Engineering Manager","managerId":null,"primaryEmail":"morgan@example.test","phoneNumber":null,"firstName":"Morgan","preferredName":null,"lastName":"Reed","isActiveMember":true}},"properties":{"id":{"type":"string","description":"Opaque employee identifier. This identifies an org-chart person, not a member or user.","title":"Employee ID","example":"employee-avery","isRequired":true,"uniqueKey":"employee.id","typeLabel":"string"},"name":{"type":"string","description":"Resolved display name for the employee.","title":"Display name","example":"Avery Chen","isRequired":true,"uniqueKey":"employee.name","typeLabel":"string"},"avatarUrl":{"oneOf":[{"type":"string","description":"Employee avatar URL, or null when no avatar is available.","title":"Avatar URL","isRequired":true,"uniqueKey":"employee.avatarUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Employee avatar URL, or null when no avatar is available.","title":"Avatar URL","isRequired":true,"uniqueKey":"employee.avatarUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.avatarUrl","typeLabel":"string | null"},"jobTitle":{"oneOf":[{"type":"string","description":"Employee job title. Null indicates no recorded title.","title":"Job title","example":"Engineer","isRequired":true,"uniqueKey":"employee.jobTitle.oneOf.0","typeLabel":"string"},{"type":"null","description":"Employee job title. Null indicates no recorded title.","title":"Job title","example":"Engineer","isRequired":true,"uniqueKey":"employee.jobTitle.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.jobTitle","typeLabel":"string | null"},"managerId":{"oneOf":[{"type":"string","description":"Employee ID of the direct manager, or null when no manager is assigned.","title":"Manager ID","example":"employee-morgan","isRequired":true,"uniqueKey":"employee.managerId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Employee ID of the direct manager, or null when no manager is assigned.","title":"Manager ID","example":"employee-morgan","isRequired":true,"uniqueKey":"employee.managerId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.managerId","typeLabel":"string | null"},"primaryEmail":{"oneOf":[{"type":"string","description":"Primary employee email address, or null when none is set.","title":"Primary email","example":"avery@example.test","isRequired":true,"uniqueKey":"employee.primaryEmail.oneOf.0","typeLabel":"string"},{"type":"null","description":"Primary employee email address, or null when none is set.","title":"Primary email","example":"avery@example.test","isRequired":true,"uniqueKey":"employee.primaryEmail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.primaryEmail","typeLabel":"string | null"},"phoneNumber":{"oneOf":[{"type":"string","description":"Employee phone number, or null when unavailable.","title":"Phone number","isRequired":true,"uniqueKey":"employee.phoneNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Employee phone number, or null when unavailable.","title":"Phone number","isRequired":true,"uniqueKey":"employee.phoneNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.phoneNumber","typeLabel":"string | null"},"firstName":{"oneOf":[{"type":"string","description":"Employee first name, or null when unavailable.","title":"First name","example":"Avery","isRequired":true,"uniqueKey":"employee.firstName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Employee first name, or null when unavailable.","title":"First name","example":"Avery","isRequired":true,"uniqueKey":"employee.firstName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.firstName","typeLabel":"string | null"},"preferredName":{"oneOf":[{"type":"string","description":"Employee preferred first name, or null when unavailable.","title":"Preferred name","isRequired":true,"uniqueKey":"employee.preferredName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Employee preferred first name, or null when unavailable.","title":"Preferred name","isRequired":true,"uniqueKey":"employee.preferredName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.preferredName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","description":"Employee last name, or null when unavailable.","title":"Last name","example":"Chen","isRequired":true,"uniqueKey":"employee.lastName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Employee last name, or null when unavailable.","title":"Last name","example":"Chen","isRequired":true,"uniqueKey":"employee.lastName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.lastName","typeLabel":"string | null"},"isActiveMember":{"type":"boolean","description":"Whether the employee has an active linked workspace membership.","title":"Has active workspace access","example":true,"isRequired":true,"uniqueKey":"employee.isActiveMember","typeLabel":"boolean"},"startDate":{"oneOf":[{"type":"string","description":"Employee start date as YYYY-MM-DD, or null when unavailable.","title":"Start date","example":"2025-03-17","isRequired":true,"uniqueKey":"employee.startDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"Employee start date as YYYY-MM-DD, or null when unavailable.","title":"Start date","example":"2025-03-17","isRequired":true,"uniqueKey":"employee.startDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.startDate","typeLabel":"string | null"},"timezone":{"oneOf":[{"type":"string","description":"Resolved IANA timezone name, or null when unavailable.","title":"Timezone","example":"America/New_York","isRequired":true,"uniqueKey":"employee.timezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Resolved IANA timezone name, or null when unavailable.","title":"Timezone","example":"America/New_York","isRequired":true,"uniqueKey":"employee.timezone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.timezone","typeLabel":"string | null"},"employmentStatus":{"type":"string","enum":["CURRENT","FORMER"],"description":"CURRENT means the employee is not archived; FORMER means archived. Employment status is separate from member access.","title":"Employment status","example":"CURRENT","isRequired":true,"uniqueKey":"employee.employmentStatus","typeLabel":"enum\u003cstring>"},"emails":{"type":"array","items":{"type":"string","uniqueKey":"employee.emails.items.[INDEX]","typeLabel":"string"},"description":"Known email addresses associated with the employee.","title":"Known email addresses","example":["avery@example.test"],"isRequired":true,"uniqueKey":"employee.emails","typeLabel":"string[]"},"directReportsCount":{"type":"number","description":"Direct reports in the primary organization. Former reports are included only when the caller requests archived-report counts.","title":"Direct report count","example":0,"isRequired":true,"uniqueKey":"employee.directReportsCount","typeLabel":"number"},"directReportMembersCount":{"type":"number","description":"Direct reports in the primary organization with active workspace memberships, independent of employee archive status.","title":"Direct report member count","example":0,"isRequired":true,"uniqueKey":"employee.directReportMembersCount","typeLabel":"number"},"manager":{"type":"object","title":"Direct manager","description":"Basic profile of the direct manager, or null when none is assigned.","required":["id","name","avatarUrl","jobTitle","managerId","primaryEmail","phoneNumber","firstName","preferredName","lastName","isActiveMember"],"example":{"id":"employee-avery","name":"Avery Chen","avatarUrl":null,"jobTitle":"Engineer","managerId":"employee-morgan","primaryEmail":"avery@example.test","phoneNumber":null,"firstName":"Avery","preferredName":null,"lastName":"Chen","isActiveMember":true},"properties":{"id":{"type":"string","description":"Opaque employee identifier. This identifies an org-chart person, not a member or user.","title":"Employee ID","example":"employee-avery","isRequired":true,"uniqueKey":"employee.manager.id","typeLabel":"string"},"name":{"type":"string","description":"Resolved display name for the employee.","title":"Display name","example":"Avery Chen","isRequired":true,"uniqueKey":"employee.manager.name","typeLabel":"string"},"avatarUrl":{"oneOf":[{"type":"string","description":"Employee avatar URL, or null when no avatar is available.","title":"Avatar URL","isRequired":true,"uniqueKey":"employee.manager.avatarUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Employee avatar URL, or null when no avatar is available.","title":"Avatar URL","isRequired":true,"uniqueKey":"employee.manager.avatarUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.manager.avatarUrl","typeLabel":"string | null"},"jobTitle":{"oneOf":[{"type":"string","description":"Employee job title. Null indicates no recorded title.","title":"Job title","example":"Engineer","isRequired":true,"uniqueKey":"employee.manager.jobTitle.oneOf.0","typeLabel":"string"},{"type":"null","description":"Employee job title. Null indicates no recorded title.","title":"Job title","example":"Engineer","isRequired":true,"uniqueKey":"employee.manager.jobTitle.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.manager.jobTitle","typeLabel":"string | null"},"managerId":{"oneOf":[{"type":"string","description":"Employee ID of the direct manager, or null when no manager is assigned.","title":"Manager ID","example":"employee-morgan","isRequired":true,"uniqueKey":"employee.manager.managerId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Employee ID of the direct manager, or null when no manager is assigned.","title":"Manager ID","example":"employee-morgan","isRequired":true,"uniqueKey":"employee.manager.managerId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.manager.managerId","typeLabel":"string | null"},"primaryEmail":{"oneOf":[{"type":"string","description":"Primary employee email address, or null when none is set.","title":"Primary email","example":"avery@example.test","isRequired":true,"uniqueKey":"employee.manager.primaryEmail.oneOf.0","typeLabel":"string"},{"type":"null","description":"Primary employee email address, or null when none is set.","title":"Primary email","example":"avery@example.test","isRequired":true,"uniqueKey":"employee.manager.primaryEmail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.manager.primaryEmail","typeLabel":"string | null"},"phoneNumber":{"oneOf":[{"type":"string","description":"Employee phone number, or null when unavailable.","title":"Phone number","isRequired":true,"uniqueKey":"employee.manager.phoneNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Employee phone number, or null when unavailable.","title":"Phone number","isRequired":true,"uniqueKey":"employee.manager.phoneNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.manager.phoneNumber","typeLabel":"string | null"},"firstName":{"oneOf":[{"type":"string","description":"Employee first name, or null when unavailable.","title":"First name","example":"Avery","isRequired":true,"uniqueKey":"employee.manager.firstName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Employee first name, or null when unavailable.","title":"First name","example":"Avery","isRequired":true,"uniqueKey":"employee.manager.firstName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.manager.firstName","typeLabel":"string | null"},"preferredName":{"oneOf":[{"type":"string","description":"Employee preferred first name, or null when unavailable.","title":"Preferred name","isRequired":true,"uniqueKey":"employee.manager.preferredName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Employee preferred first name, or null when unavailable.","title":"Preferred name","isRequired":true,"uniqueKey":"employee.manager.preferredName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.manager.preferredName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","description":"Employee last name, or null when unavailable.","title":"Last name","example":"Chen","isRequired":true,"uniqueKey":"employee.manager.lastName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Employee last name, or null when unavailable.","title":"Last name","example":"Chen","isRequired":true,"uniqueKey":"employee.manager.lastName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employee.manager.lastName","typeLabel":"string | null"},"isActiveMember":{"type":"boolean","description":"Whether the employee has an active linked workspace membership.","title":"Has active workspace access","example":true,"isRequired":true,"uniqueKey":"employee.manager.isActiveMember","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"employee.manager","typeLabel":"Direct manager · object"}},"isRequired":true,"uniqueKey":"employee","typeLabel":"Employee · object"}},"required":["employee"],"additionalProperties":false,"title":"Employee employment status response","example":{"employee":{"id":"employee-avery","name":"Avery Chen","avatarUrl":null,"jobTitle":"Engineer","managerId":"employee-morgan","primaryEmail":"avery@example.test","phoneNumber":null,"firstName":"Avery","preferredName":null,"lastName":"Chen","isActiveMember":false,"startDate":"2025-03-17","timezone":"America/New_York","employmentStatus":"FORMER","emails":["avery@example.test"],"directReportsCount":0,"directReportMembersCount":0,"manager":{"id":"employee-morgan","name":"Morgan Reed","avatarUrl":null,"jobTitle":"Engineering Manager","managerId":null,"primaryEmail":"morgan@example.test","phoneNumber":null,"firstName":"Morgan","preferredName":null,"lastName":"Reed","isActiveMember":true}}},"uniqueKey":"","typeLabel":"Employee employment status response · object"},"examples":{"Example":{"title":"Example","value":{"employee":{"id":"employee-avery","name":"Avery Chen","avatarUrl":null,"jobTitle":"Engineer","managerId":"employee-morgan","primaryEmail":"avery@example.test","phoneNumber":null,"firstName":"Avery","preferredName":null,"lastName":"Chen","isActiveMember":false,"startDate":"2025-03-17","timezone":"America/New_York","employmentStatus":"FORMER","emails":["avery@example.test"],"directReportsCount":0,"directReportMembersCount":0,"manager":{"id":"employee-morgan","name":"Morgan Reed","avatarUrl":null,"jobTitle":"Engineering Manager","managerId":null,"primaryEmail":"morgan@example.test","phoneNumber":null,"firstName":"Morgan","preferredName":null,"lastName":"Reed","isActiveMember":true}}}}},"exampleType":"generated"}},"exampleType":"generated"},"ebebad4c-fa66-4172-b336-38296460db64":{"description":"Bad request or request validation failed","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["error"],"properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST"],"isRequired":true,"uniqueKey":"oneOf.0.error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.requestId","typeLabel":"string"}},"required":["code","message","requestId"],"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["error"],"properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR"],"isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error.message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error.requestId","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"oneOf.1.error.details.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.1.error.details.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"oneOf.1.error.details.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"isRequired":true,"uniqueKey":"oneOf.1.error.details.items.[INDEX].path","typeLabel":"(string | number)[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error.details.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"oneOf.1.error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.1.error.details","typeLabel":"object[]"}},"required":["code","message","requestId","details"],"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"BAD_REQUEST","message":"\u003cstring>","requestId":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"73d959a2-1552-4564-b177-f7cace31a852":{"description":"Authentication is missing or invalid. Send a valid API key or OAuth access token in the Authorization: Bearer \u003cTOKEN> header before retrying.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"}},"required":["code","message","requestId"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNAUTHORIZED","message":"\u003cstring>","requestId":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"e0b7d4a7-ce5e-4e21-8a77-37b392030609":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["FORBIDDEN"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"}},"required":["code","message","requestId"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"FORBIDDEN","message":"\u003cstring>","requestId":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"f5f7a41c-c574-4fd5-a68d-98a13236b764":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["NOT_FOUND"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"}},"required":["code","message","requestId"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_FOUND","message":"\u003cstring>","requestId":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"aadd33b6-a6ce-4e99-aacf-3abd71773660":{"description":"The API-client request budget is exhausted. API keys allow 500 requests per minute per key; OAuth clients allow 500 per minute per client and workspace. Reads and writes share the budget. One HTTP request counts once, including bulk requests. Wait for the Retry-After delay before retrying.","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","required":true,"schema":{"type":"integer","minimum":0,"example":42}},"RateLimit":{"description":"Current request budget: limit is the maximum count, remaining is the unused count, and reset is seconds until the window resets, not a timestamp.","required":true,"schema":{"type":"string","example":"limit=500, remaining=0, reset=42"}},"RateLimit-Policy":{"description":"Request limit and window length in seconds, formatted as \u003climit>;w=\u003cseconds>.","required":true,"schema":{"type":"string","example":"500;w=60"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["RATE_LIMITED"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"}},"required":["code","message","requestId"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMITED","message":"\u003cstring>","requestId":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"12cd0f57-b267-4156-9989-b66636809110":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Use an API key or OAuth access token. Enter only the token in the authorization dialog; requests send it as `Authorization: Bearer \u003cTOKEN>`.\n\nCreate 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.\n\n```http\nAuthorization: Bearer wm_api_example\n```\n\nOAuth access tokens are issued for connected Windmill applications.\n\n```http\nAuthorization: Bearer \u003cOAUTH_ACCESS_TOKEN>\n```\n\nBoth token types use the authenticated user's workspace permissions. Each endpoint's permission requirements and the sharing settings of the requested items still apply.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"bc3cc9da-1158-4cfa-97b3-e455483a1d98":{"url":"https://api.gowindmill.com/api/v2"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Use an API key or OAuth access token. Enter only the token in the authorization dialog; requests send it as `Authorization: Bearer \u003cTOKEN>`.\n\nCreate 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.\n\n```http\nAuthorization: Bearer wm_api_example\n```\n\nOAuth access tokens are issued for connected Windmill applications.\n\n```http\nAuthorization: Bearer \u003cOAUTH_ACCESS_TOKEN>\n```\n\nBoth token types use the authenticated user's workspace permissions. Each endpoint's permission requirements and the sharing settings of the requested items still apply.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use an API key or OAuth access token. Enter only the token in the authorization dialog; requests send it as `Authorization: Bearer \u003cTOKEN>`.\n\nCreate 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.\n\n```http\nAuthorization: Bearer wm_api_example\n```\n\nOAuth access tokens are issued for connected Windmill applications.\n\n```http\nAuthorization: Bearer \u003cOAUTH_ACCESS_TOKEN>\n```\n\nBoth token types use the authenticated user's workspace permissions. Each endpoint's permission requirements and the sharing settings of the requested items still apply.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://api.gowindmill.com/api/v2/openapi.json"},"subdomain":"windmill","siteName":"Windmill Help Site","title":"Set an employee's employment status - Windmill Help Site","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T14:24:43.602Z","originalFileLocation":"api-reference/employees/set-an-employees-employment-status.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Sets CURRENT to restore an employee or FORMER to archive them without deleting their record. Repeating the existing status succeeds without a change. Rippling-managed employees cannot change status through this endpoint. An employee with active workspace access or a current direct report cannot become FORMER; remove their workspace access and reassign their direct reports first. Returns the updated employee profile. Requires permission to manage employee profiles (org_chart.manage).\">\u003cmeta data-mint-head name=\"application-name\" content=\"Windmill Help Site\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/windmill/W7N_zh2zYbm8zD54/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/windmill/W7N_zh2zYbm8zD54/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/windmill/W7N_zh2zYbm8zD54/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/windmill/W7N_zh2zYbm8zD54/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/windmill/W7N_zh2zYbm8zD54/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/windmill/W7N_zh2zYbm8zD54/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/windmill/W7N_zh2zYbm8zD54/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/windmill/W7N_zh2zYbm8zD54/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/windmill/W7N_zh2zYbm8zD54/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Set an employee\u0026#x27;s employment status - Windmill Help Site\">\u003cmeta data-mint-head property=\"og:description\" content=\"Sets CURRENT to restore an employee or FORMER to archive them without deleting their record. Repeating the existing status succeeds without a change. Rippling-managed employees cannot change status through this endpoint. An employee with active workspace access or a current direct report cannot become FORMER; remove their workspace access and reassign their direct reports first. Returns the updated employee profile. Requires permission to manage employee profiles (org_chart.manage).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Windmill Help Center\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://help.gowindmill.com/api-reference/employees/set-an-employees-employment-status\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://windmill.mintlify.site/_mintlify/api/og/v2?division=Employees\u0026amp;title=Set+an+employee%27s+employment+status\u0026amp;description=Sets+CURRENT+to+restore+an+employee+or+FORMER+to+archive+them+without+deleting+their+record.+Repeating+the+existing+status+succeeds+without+a+change.+Rippling-m\u0026amp;theme=819f4f407f94f51efe0e1a0f\u0026amp;signature=78aae4c60c5800ae467b5b1b2cc69b75893b1d9d739c44d36bb0ac46c2498cd7\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Set an employee\u0026#x27;s employment status - Windmill Help Site\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Sets CURRENT to restore an employee or FORMER to archive them without deleting their record. Repeating the existing status succeeds without a change. Rippling-managed employees cannot change status through this endpoint. An employee with active workspace access or a current direct report cannot become FORMER; remove their workspace access and reassign their direct reports first. Returns the updated employee profile. Requires permission to manage employee profiles (org_chart.manage).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://windmill.mintlify.site/_mintlify/api/og/v2?division=Employees\u0026amp;title=Set+an+employee%27s+employment+status\u0026amp;description=Sets+CURRENT+to+restore+an+employee+or+FORMER+to+archive+them+without+deleting+their+record.+Repeating+the+existing+status+succeeds+without+a+change.+Rippling-m\u0026amp;theme=819f4f407f94f51efe0e1a0f\u0026amp;signature=78aae4c60c5800ae467b5b1b2cc69b75893b1d9d739c44d36bb0ac46c2498cd7\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/windmill/W7N_zh2zYbm8zD54/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Windmill Help Site\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4084FB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://help.gowindmill.com/api-reference/employees/set-an-employees-employment-status\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/employees/set-an-employees-employment-status.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://help.gowindmill.com/#organization\",\"name\":\"Windmill Help Site\",\"url\":\"https://help.gowindmill.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/windmill/438SkEPmWnjrcDyT/logo/light.svg?fit=max\u0026auto=format\u0026n=438SkEPmWnjrcDyT\u0026q=85\u0026s=911e75d2985851400d148f9e5e20c94f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://help.gowindmill.com#website\",\"name\":\"Windmill Help Site\",\"url\":\"https://help.gowindmill.com\",\"publisher\":{\"@id\":\"https://help.gowindmill.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://help.gowindmill.com/api-reference/employees/set-an-employees-employment-status#webpage\",\"url\":\"https://help.gowindmill.com/api-reference/employees/set-an-employees-employment-status\",\"name\":\"Set an employee's employment status\",\"description\":\"Sets CURRENT to restore an employee or FORMER to archive them without deleting their record. Repeating the existing status succeeds without a change. Rippling-managed employees cannot change status through this endpoint. An employee with active workspace access or a current direct report cannot become FORMER; remove their workspace access and reassign their direct reports first. Returns the updated employee profile. Requires permission to manage employee profiles (org_chart.manage).\",\"dateModified\":\"2026-11-19T14:24:43.602Z\",\"isPartOf\":{\"@id\":\"https://help.gowindmill.com#website\"},\"breadcrumb\":{\"@id\":\"https://help.gowindmill.com/api-reference/employees/set-an-employees-employment-status#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://help.gowindmill.com/api-reference/employees/set-an-employees-employment-status#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://help.gowindmill.com/api-reference/employees/search-employee-profiles\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Employees\",\"item\":\"https://help.gowindmill.com/api-reference/employees/search-employee-profiles\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Set an employee's employment status\",\"item\":\"https://help.gowindmill.com/api-reference/employees/set-an-employees-employment-status\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://help.gowindmill.com/api-reference/employees/set-an-employees-employment-status#apireference\",\"headline\":\"Set an employee's employment status\",\"name\":\"Set an employee's employment status\",\"description\":\"Sets CURRENT to restore an employee or FORMER to archive them without deleting their record. Repeating the existing status succeeds without a change. Rippling-managed employees cannot change status through this endpoint. An employee with active workspace access or a current direct report cannot become FORMER; remove their workspace access and reassign their direct reports first. Returns the updated employee profile. Requires permission to manage employee profiles (org_chart.manage).\",\"url\":\"https://help.gowindmill.com/api-reference/employees/set-an-employees-employment-status\",\"mainEntityOfPage\":{\"@id\":\"https://help.gowindmill.com/api-reference/employees/set-an-employees-employment-status#webpage\"},\"dateModified\":\"2026-11-19T14:24:43.602Z\",\"publisher\":{\"@id\":\"https://help.gowindmill.com/#organization\"},\"isPartOf\":{\"@id\":\"https://help.gowindmill.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Windmill Help Site\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Windmill Help Site\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/employees/set-an-employees-employment-status.md","siteName":"Windmill Help Site","nav":{"global":null,"tabs":[{"tab":"Platform","pages":[{"title":"Platform","href":""}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/integrations"}]},{"tab":"API reference","groups":[{"group":"Getting started","icon":"code","pages":[{"title":"API overview","href":"/api-reference/overview"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"OAuth","href":"/api-reference/oauth"},{"title":"Making requests","href":"/api-reference/making-requests"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Rate limits","href":"/api-reference/rate-limits"},{"title":"Versioning","href":"/api-reference/versioning"},{"title":"API changelog","href":"/api-reference/changelog"}]},{"group":"Endpoints","icon":"plug","pages":[{"group":"Employees","pages":[{"title":"Search employee profiles","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/employees/search","href":"/api-reference/employees/search-employee-profiles"},{"title":"Get an employee profile","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/employees/{employeeId}","href":"/api-reference/employees/get-an-employee-profile"},{"title":"Search employee IDs","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/employees/search/ids","href":"/api-reference/employees/search-employee-ids"},{"title":"Count matching employees","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/employees/count","href":"/api-reference/employees/count-matching-employees"},{"title":"Create an employee","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/employees","href":"/api-reference/employees/create-an-employee"},{"title":"Update an employee profile","description":"Updates the supplied fields and returns the employee profile. Omitted fields keep their values; nullable fields accept null to clear them. Supply at least one field. primaryEmail must already be linked to the employee. Managers must belong to the company; an employee cannot become their own manager, directly or through their reporting chain. Value changes keep field ownership unchanged unless the field keys are included in claimOwnership. Include an integration-owned field in claimOwnership to switch it to manual ownership, or set its source to manual through PUT /c/{companyId}/employees/{employeeId}/field-sources/{fieldKey}. Ownership claims also work without value changes. The response omits some editable fields, including jobLevel, gender, and pronouns. Use PUT /c/{companyId}/employees/{employeeId}/employment-status to archive or restore an employee. Requires permission to manage employee profiles (`org_chart.manage`).","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json patch /c/{companyId}/employees/{employeeId}","href":"/api-reference/employees/update-an-employee-profile"},{"title":"Set an employee's employment status","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json put /c/{companyId}/employees/{employeeId}/employment-status","href":"/api-reference/employees/set-an-employees-employment-status"},{"title":"Create employees in bulk","description":"Creates 1 to 100 new employees and returns their profiles in input order. The entire batch fails without changes if an email matches an existing current or former employee, is repeated within the batch, or a manager is invalid. Email conflicts return 409. To restore a former employee, use PUT /c/{companyId}/employees/{employeeId}/employment-status with CURRENT. No workspace invitations are sent. Returns 201 for a successful batch. Requires permission to manage employee profiles (`org_chart.manage`).","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/employees/bulk","href":"/api-reference/employees/create-employees-in-bulk"}]},{"group":"Field sources","pages":[{"title":"List available employee field sources","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/field-sources/available-sources","href":"/api-reference/employee-field-sources/list-available-employee-field-sources"},{"title":"List company employee field defaults","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/field-sources/defaults","href":"/api-reference/employee-field-sources/list-company-employee-field-defaults"},{"title":"List employee field source overrides","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/employees/{employeeId}/field-sources","href":"/api-reference/employee-field-sources/list-employee-field-source-overrides"},{"title":"Resolve effective employee field sources","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/field-sources/resolve","href":"/api-reference/employee-field-sources/resolve-effective-employee-field-sources"},{"title":"Set a company employee field source","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json put /c/{companyId}/field-sources/defaults/{fieldKey}","href":"/api-reference/employee-field-sources/set-a-company-employee-field-source"},{"title":"Set an employee field source override","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json put /c/{companyId}/employees/{employeeId}/field-sources/{fieldKey}","href":"/api-reference/employee-field-sources/set-an-employee-field-source-override"},{"title":"Remove an employee field source override","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json delete /c/{companyId}/employees/{employeeId}/field-sources/{fieldKey}","href":"/api-reference/employee-field-sources/remove-an-employee-field-source-override"},{"title":"Remove a company employee field default","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json delete /c/{companyId}/field-sources/defaults/{fieldKey}","href":"/api-reference/employee-field-sources/remove-a-company-employee-field-default"}]},{"group":"Groups","pages":[{"title":"List readable employee groups","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/groups","href":"/api-reference/groups/list-readable-employee-groups"},{"title":"Count readable employee groups","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/groups/count","href":"/api-reference/groups/count-readable-employee-groups"},{"title":"Get an employee group","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/groups/{groupId}","href":"/api-reference/groups/get-an-employee-group"},{"title":"Create an employee group","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups","href":"/api-reference/groups/create-an-employee-group"},{"title":"Update an employee group","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json patch /c/{companyId}/groups/{groupId}","href":"/api-reference/groups/update-an-employee-group"},{"title":"List employees in a group","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/groups/{groupId}/members","href":"/api-reference/groups/list-employees-in-a-group"},{"title":"Count employee group members","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/groups/{groupId}/members/count","href":"/api-reference/groups/count-employee-group-members"},{"title":"Add employees to a manual group","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/{groupId}/members","href":"/api-reference/groups/add-employees-to-a-manual-group"},{"title":"Remove employees from a manual group","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/{groupId}/members/remove","href":"/api-reference/groups/remove-employees-from-a-manual-group"},{"title":"Replace smart group employee rules","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json put /c/{companyId}/groups/{groupId}/rules","href":"/api-reference/groups/replace-smart-group-employee-rules"},{"title":"Refresh an employee group","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/{groupId}/sync","href":"/api-reference/groups/refresh-an-employee-group"},{"title":"Replace employee group sharing","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json put /c/{companyId}/groups/{groupId}/access","href":"/api-reference/groups/replace-employee-group-sharing"},{"title":"Upload and review a group member CSV","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/{groupId}/members/imports/uploads","href":"/api-reference/groups/upload-and-review-a-group-member-csv"},{"title":"Submit a reviewed group member import","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/{groupId}/members/imports","href":"/api-reference/groups/submit-a-reviewed-group-member-import"},{"title":"Get group member import progress","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/groups/{groupId}/members/imports/{importId}","href":"/api-reference/groups/get-group-member-import-progress"},{"title":"Delete an employee group","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json delete /c/{companyId}/groups/{groupId}","href":"/api-reference/groups/delete-an-employee-group"}]},{"group":"Group categories","pages":[{"title":"List employee group categories","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/groups/categories","href":"/api-reference/group-categories/list-employee-group-categories"},{"title":"Get an employee group category","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/groups/categories/{categoryId}","href":"/api-reference/group-categories/get-an-employee-group-category"},{"title":"Create an employee group category","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/categories","href":"/api-reference/group-categories/create-an-employee-group-category"},{"title":"Update an employee group category","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json patch /c/{companyId}/groups/categories/{categoryId}","href":"/api-reference/group-categories/update-an-employee-group-category"},{"title":"Add employee groups to a category","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/categories/{categoryId}/groups","href":"/api-reference/group-categories/add-employee-groups-to-a-category"},{"title":"Remove employee groups from a category","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/categories/{categoryId}/groups/remove","href":"/api-reference/group-categories/remove-employee-groups-from-a-category"},{"title":"Delete an employee group category","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json delete /c/{companyId}/groups/categories/{categoryId}","href":"/api-reference/group-categories/delete-an-employee-group-category"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"Best practices","pages":[{"title":"Best practices","href":"/introducing-windmill"}]}]},"basePath":"","title":"Set an employee's employment status - Windmill Help Site","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}