[{"data":1,"prerenderedAt":459},["ShallowReactive",2],{"navigation_docs":3,"-api-reference-employees-update-employee-operation":217,"-api-reference-employees-update-employee":435,"-api-reference-employees-update-employee-surround":452},[4,55],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":12},"Guides","i-nucleo-book","\u002Fguides","1.guides",[10,21,41],{"title":11,"icon":12,"path":13,"stem":14,"children":15,"page":12},"Getting started",false,"\u002Fguides\u002Fgetting-started","1.guides\u002F1.getting-started",[16],{"title":17,"path":18,"stem":19,"icon":20},"Introduction","\u002Fguides\u002Fgetting-started\u002Fintroduction","1.guides\u002F1.getting-started\u002F1.introduction","i-nucleo-home",{"title":22,"icon":12,"path":23,"stem":24,"children":25,"page":12},"Connect an AI app","\u002Fguides\u002Fconnect-ai","1.guides\u002F2.connect-ai",[26,31,36],{"title":27,"path":28,"stem":29,"icon":30},"Connect Claude","\u002Fguides\u002Fconnect-ai\u002Fconnect-claude","1.guides\u002F2.connect-ai\u002F1.connect-claude","i-nucleo-plug",{"title":32,"path":33,"stem":34,"icon":35},"What it can see","\u002Fguides\u002Fconnect-ai\u002Fwhat-it-can-see","1.guides\u002F2.connect-ai\u002F2.what-it-can-see","i-nucleo-eye",{"title":37,"path":38,"stem":39,"icon":40},"Manage connections","\u002Fguides\u002Fconnect-ai\u002Fmanage-connections","1.guides\u002F2.connect-ai\u002F3.manage-connections","i-nucleo-sliders",{"title":42,"icon":12,"path":43,"stem":44,"children":45,"page":12},"Using the API","\u002Fguides\u002Fusing-the-api","1.guides\u002F3.using-the-api",[46,50],{"title":47,"path":48,"stem":49,"icon":35},"Read your data","\u002Fguides\u002Fusing-the-api\u002Fread-your-data","1.guides\u002F3.using-the-api\u002F1.read-your-data",{"title":51,"path":52,"stem":53,"icon":54},"Send metric values","\u002Fguides\u002Fusing-the-api\u002Fsend-metric-values","1.guides\u002F3.using-the-api\u002F2.send-metric-values","i-nucleo-chart-activity",{"title":56,"path":57,"stem":58,"children":59,"icon":216},"API Reference","\u002Fapi-reference","2.api-reference\u002F01.index",[60,62,67,72,77,90,114,151,161,186,201],{"title":11,"path":57,"stem":58,"icon":61},"i-nucleo-rocket",{"title":63,"path":64,"stem":65,"icon":66},"Authentication","\u002Fapi-reference\u002Fauthentication","2.api-reference\u002F02.authentication","i-nucleo-key",{"title":68,"path":69,"stem":70,"icon":71},"Errors and limits","\u002Fapi-reference\u002Ferrors","2.api-reference\u002F03.errors","i-nucleo-triangle-warning",{"title":73,"path":74,"stem":75,"icon":76},"Pagination","\u002Fapi-reference\u002Fpagination","2.api-reference\u002F04.pagination","i-nucleo-check-list",{"title":78,"icon":12,"path":79,"stem":80,"children":81,"page":12},"Programs","\u002Fapi-reference\u002Fprograms","2.api-reference\u002F05.programs",[82],{"title":83,"path":84,"stem":85,"badge":86},"List programs","\u002Fapi-reference\u002Fprograms\u002Flist-programs","2.api-reference\u002F05.programs\u002F1.list-programs",{"label":87,"color":88,"variant":89},"GET","success","subtle",{"title":91,"icon":12,"path":92,"stem":93,"children":94,"page":12},"Employees","\u002Fapi-reference\u002Femployees","2.api-reference\u002F06.employees",[95,100,107],{"title":96,"path":97,"stem":98,"badge":99},"List employees","\u002Fapi-reference\u002Femployees\u002Flist-employees","2.api-reference\u002F06.employees\u002F1.list-employees",{"label":87,"color":88,"variant":89},{"title":101,"path":102,"stem":103,"badge":104},"Create an employee","\u002Fapi-reference\u002Femployees\u002Fcreate-employee","2.api-reference\u002F06.employees\u002F2.create-employee",{"label":105,"color":106,"variant":89},"POST","info",{"title":108,"path":109,"stem":110,"badge":111},"Update an employee","\u002Fapi-reference\u002Femployees\u002Fupdate-employee","2.api-reference\u002F06.employees\u002F3.update-employee",{"label":112,"color":113,"variant":89},"PATCH","warning",{"title":115,"icon":12,"path":116,"stem":117,"children":118,"page":12},"Groups","\u002Fapi-reference\u002Fgroups","2.api-reference\u002F07.groups",[119,124,129,134,141,146],{"title":120,"path":121,"stem":122,"badge":123},"List groups","\u002Fapi-reference\u002Fgroups\u002Flist-groups","2.api-reference\u002F07.groups\u002F1.list-groups",{"label":87,"color":88,"variant":89},{"title":125,"path":126,"stem":127,"badge":128},"Create a group","\u002Fapi-reference\u002Fgroups\u002Fcreate-group","2.api-reference\u002F07.groups\u002F2.create-group",{"label":105,"color":106,"variant":89},{"title":130,"path":131,"stem":132,"badge":133},"Update a group","\u002Fapi-reference\u002Fgroups\u002Fupdate-group","2.api-reference\u002F07.groups\u002F3.update-group",{"label":112,"color":113,"variant":89},{"title":135,"path":136,"stem":137,"badge":138},"Archive a group","\u002Fapi-reference\u002Fgroups\u002Farchive-group","2.api-reference\u002F07.groups\u002F4.archive-group",{"label":139,"color":140,"variant":89},"DELETE","error",{"title":142,"path":143,"stem":144,"badge":145},"Add employees to groups","\u002Fapi-reference\u002Fgroups\u002Fadd-employees-to-groups","2.api-reference\u002F07.groups\u002F5.add-employees-to-groups",{"label":105,"color":106,"variant":89},{"title":147,"path":148,"stem":149,"badge":150},"Remove employees from groups","\u002Fapi-reference\u002Fgroups\u002Fremove-employees-from-groups","2.api-reference\u002F07.groups\u002F6.remove-employees-from-groups",{"label":105,"color":106,"variant":89},{"title":152,"icon":12,"path":153,"stem":154,"children":155,"page":12},"Rewards","\u002Fapi-reference\u002Frewards","2.api-reference\u002F08.rewards",[156],{"title":157,"path":158,"stem":159,"badge":160},"List upcoming rewards","\u002Fapi-reference\u002Frewards\u002Flist-upcoming-rewards","2.api-reference\u002F08.rewards\u002F1.list-upcoming-rewards",{"label":87,"color":88,"variant":89},{"title":162,"icon":12,"path":163,"stem":164,"children":165,"page":12},"Insights","\u002Fapi-reference\u002Finsights","2.api-reference\u002F09.insights",[166,171,176,181],{"title":167,"path":168,"stem":169,"badge":170},"Get coverage gaps","\u002Fapi-reference\u002Finsights\u002Fget-coverage-gaps","2.api-reference\u002F09.insights\u002F1.get-coverage-gaps",{"label":87,"color":88,"variant":89},{"title":172,"path":173,"stem":174,"badge":175},"List coverage gap employees","\u002Fapi-reference\u002Finsights\u002Flist-coverage-gap-employees","2.api-reference\u002F09.insights\u002F2.list-coverage-gap-employees",{"label":87,"color":88,"variant":89},{"title":177,"path":178,"stem":179,"badge":180},"Get quiet employees","\u002Fapi-reference\u002Finsights\u002Fget-quiet-employees","2.api-reference\u002F09.insights\u002F3.get-quiet-employees",{"label":87,"color":88,"variant":89},{"title":182,"path":183,"stem":184,"badge":185},"Get program review","\u002Fapi-reference\u002Finsights\u002Fget-program-review","2.api-reference\u002F09.insights\u002F4.get-program-review",{"label":87,"color":88,"variant":89},{"title":187,"icon":12,"path":188,"stem":189,"children":190,"page":12},"Metrics","\u002Fapi-reference\u002Fmetrics","2.api-reference\u002F10.metrics",[191,196],{"title":192,"path":193,"stem":194,"badge":195},"Send a metric value","\u002Fapi-reference\u002Fmetrics\u002Fsend-metric-value","2.api-reference\u002F10.metrics\u002F1.send-metric-value",{"label":105,"color":106,"variant":89},{"title":197,"path":198,"stem":199,"badge":200},"Get a metric value","\u002Fapi-reference\u002Fmetrics\u002Fget-metric-value","2.api-reference\u002F10.metrics\u002F2.get-metric-value",{"label":87,"color":88,"variant":89},{"title":202,"icon":12,"path":203,"stem":204,"children":205,"page":12},"System","\u002Fapi-reference\u002Fsystem","2.api-reference\u002F11.system",[206,211],{"title":207,"path":208,"stem":209,"badge":210},"Check API health","\u002Fapi-reference\u002Fsystem\u002Fhealth","2.api-reference\u002F11.system\u002F1.health",{"label":87,"color":88,"variant":89},{"title":212,"path":213,"stem":214,"badge":215},"Get the OpenAPI document","\u002Fapi-reference\u002Fsystem\u002Fopenapi","2.api-reference\u002F11.system\u002F2.openapi",{"label":87,"color":88,"variant":89},"i-nucleo-code",{"method":112,"path":218,"description":219,"scope":220,"parameters":221,"body":231,"responses":275},"\u002Fv1\u002Femployees\u002F{id}","Changes the fields you send and leaves the rest. Send `null` to clear an optional field. A new start date or birthday moves the rewards that depend on it, and a new email is where their rewards are sent from then on. Sending the same change again is safe. The API can't archive someone who has left, or restore them: do that in the Teambrite dashboard, under Employees, where you can see which scheduled rewards it cancels.","employee:write",[222],{"name":223,"in":224,"required":225,"description":226,"schema":227},"id","path",true,"The employee's ID.",{"type":228,"maxLength":229,"pattern":230},"string",100,"^emp_[A-Za-z0-9_-]+$",{"schema":232,"example":272},{"type":233,"properties":234,"additionalProperties":12},"object",{"fullName":235,"email":239,"startDate":243,"birthday":250,"timezone":256,"externalId":261,"externalIdSource":267},{"type":228,"minLength":236,"maxLength":237,"description":238},1,200,"Their full name.",{"type":228,"maxLength":240,"format":241,"description":242},254,"email","Their work email. Rewards are sent here, and no two employees in your company can share one. Capitals don't matter.",{"anyOf":244},[245,248],{"type":228,"format":246,"description":247},"date","The day they started. Work anniversary programs count from it.",{"type":249},"null",{"anyOf":251},[252,255],{"type":228,"pattern":253,"description":254},"^(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$","Their birthday as `MM-DD`. Send no year: Teambrite never keeps one. Whether coworkers see it stays their own choice.",{"type":249},{"anyOf":257},[258,260],{"type":228,"minLength":236,"maxLength":229,"description":259},"Their IANA time zone, such as `America\u002FToronto`.",{"type":249},{"anyOf":262},[263,266],{"type":228,"minLength":236,"maxLength":264,"description":265},255,"The ID your own system uses for them. No two employees in your company can share one.",{"type":249},{"anyOf":268},[269,271],{"type":228,"minLength":236,"maxLength":229,"description":270},"The system `externalId` comes from, such as `workday`.",{"type":249},{"startDate":273,"externalId":274},"2021-04-01","EMP-1042",[276,339,354,364,374,384,394,404,414,424],{"status":277,"description":278,"schema":279,"example":330},"200","Their profile after the change.",{"type":233,"properties":280,"required":321,"additionalProperties":12},{"id":281,"fullName":283,"email":285,"startDate":290,"yearsOfService":295,"birthday":302,"avatarUrl":307,"timezone":313,"externalId":315,"externalIdSource":318},{"type":228,"maxLength":229,"pattern":230,"description":282},"The employee's ID, which is also in the address of their dashboard profile. Use it as `employeeId` when you send a metric value.",{"type":228,"description":284},"The employee's full name.",{"anyOf":286,"description":289},[287,288],{"type":228,"format":241},{"type":249},"Their work email.",{"anyOf":291},[292,294],{"type":228,"format":246,"description":293},"The day they started.",{"type":249},{"anyOf":296},[297,301],{"type":298,"minimum":299,"description":300},"integer",0,"Whole years since `startDate`, as of today in your company's time zone. Someone who started on 29 February reaches the next year on 28 February in other years. `null` with no start date, or one still to come.",{"type":249},{"anyOf":303,"description":306},[304,305],{"type":228,"pattern":253},{"type":249},"Their birthday as `MM-DD`. Teambrite keeps no birth year. `null` if it's missing or they have made it private, and the two aren't told apart.",{"anyOf":308,"description":312},[309,311],{"type":228,"format":310},"uri",{"type":249},"The address of the picture they uploaded.",{"description":259,"type":314},[228,249],{"description":316,"type":317},"The ID your own system uses for them.",[228,249],{"description":319,"type":320},"The system `externalId` came from.",[228,249],[223,322,241,323,324,325,326,327,328,329],"fullName","startDate","yearsOfService","birthday","avatarUrl","timezone","externalId","externalIdSource",{"id":331,"fullName":332,"email":333,"startDate":273,"yearsOfService":334,"birthday":335,"avatarUrl":336,"timezone":337,"externalId":274,"externalIdSource":338},"emp_LssEG8crOK3xrxCVx1nS6jy7","Ada Lovelace","ada@example.com",5,"12-10","https:\u002F\u002Fcdn.teambrite.com\u002Favatars\u002Fada.png","America\u002FToronto","workday",{"status":340,"description":341,"schema":342,"example":344},"400","`REQUEST_BODY_INVALID`: The body has a field that is unknown, missing or out of range. `API_QUERY_INVALID`: A query parameter, or an ID in the path, is unknown or not in the right form.",{"$ref":343},"#\u002Fcomponents\u002Fschemas\u002FError",{"error":225,"status":345,"message":346,"data":347},400,"The body has a field that is unknown, missing or out of range.",{"code":348,"why":346,"fix":349,"formErrors":350,"fieldErrors":351},"REQUEST_BODY_INVALID","Correct the fields listed under `fieldErrors`, or the problem under `formErrors`, and send it again.",[],{"limit":352},[353],"Too big: expected number to be \u003C=100",{"status":355,"description":356,"schema":357,"example":358},"401","`API_KEY_INVALID`: The key is missing, wrong, expired or revoked.",{"$ref":343},{"error":225,"status":359,"message":360,"data":361},401,"The key is missing, wrong, expired or revoked.",{"code":362,"why":360,"fix":363},"API_KEY_INVALID","Send a current key as a Bearer token. Owners and admins manage keys in Settings, under Developer.",{"status":365,"description":366,"schema":367,"example":368},"403","`API_KEY_SCOPE_MISSING`: The key is valid but wasn't given the scope this endpoint needs. `PLAN_UPGRADE_REQUIRED`: Your plan doesn't include the API. `COMPANY_CLOSED`: Your company has closed its Teambrite account.",{"$ref":343},{"error":225,"status":369,"message":370,"data":371},403,"The key is valid but wasn't given the scope this endpoint needs.",{"code":372,"why":370,"fix":373},"API_KEY_SCOPE_MISSING","Create a new key with this scope in Settings, under Developer. A key's scopes can't be changed afterwards.",{"status":375,"description":376,"schema":377,"example":378},"404","`EMPLOYEE_NOT_FOUND`: No employee in your company has this ID.",{"$ref":343},{"error":225,"status":379,"message":380,"data":381},404,"No employee in your company has this ID.",{"code":382,"why":380,"fix":383},"EMPLOYEE_NOT_FOUND","Find the right ID with List employees. When several were sent, `data.employeeIds` lists the ones that weren't found.",{"status":385,"description":386,"schema":387,"example":388},"409","`EMPLOYEE_EMAIL_TAKEN`: Another employee in your company already has this email. `EMPLOYEE_EXTERNAL_ID_TAKEN`: Another employee in your company already has this `externalId`.",{"$ref":343},{"error":225,"status":389,"message":390,"data":391},409,"Another employee in your company already has this email.",{"code":392,"why":390,"fix":393},"EMPLOYEE_EMAIL_TAKEN","Update the employee in `data.employeeId` instead. A create that is retried after a timeout gets this answer, with the ID it made.",{"status":395,"description":396,"schema":397,"example":398},"411","`REQUEST_LENGTH_REQUIRED`: The request didn't declare its length.",{"$ref":343},{"error":225,"status":399,"message":400,"data":401},411,"The request didn't declare its length.",{"code":402,"why":400,"fix":403},"REQUEST_LENGTH_REQUIRED","Send the request with a Content-Length header.",{"status":405,"description":406,"schema":407,"example":408},"413","`REQUEST_TOO_LARGE`: The body is over 1 MB.",{"$ref":343},{"error":225,"status":409,"message":410,"data":411},413,"The body is over 1 MB.",{"code":412,"why":410,"fix":413},"REQUEST_TOO_LARGE","Send less at once and try again.",{"status":415,"description":416,"schema":417,"example":418},"422","`EMPLOYEE_INACTIVE`: The employee is no longer active.",{"$ref":343},{"error":225,"status":419,"message":420,"data":421},422,"The employee is no longer active.",{"code":422,"why":420,"fix":423},"EMPLOYEE_INACTIVE","Leave this person out, or restore them in the Teambrite dashboard, under Employees. The API can't. When several were sent, `data.employeeIds` lists the inactive ones.",{"status":425,"description":426,"schema":427,"example":428},"429","`API_KEY_RATE_LIMITED`: The key is over 600 requests a minute.",{"$ref":343},{"error":225,"status":429,"message":430,"data":431},429,"The key is over 600 requests a minute.",{"code":432,"why":430,"fix":433,"retryAfterSeconds":434},"API_KEY_RATE_LIMITED","Wait for the number of seconds in the `Retry-After` header, then send it again.",42,{"id":436,"title":108,"body":437,"description":444,"extension":445,"links":446,"meta":447,"navigation":448,"path":109,"seo":450,"stem":110,"__hash__":451},"docs\u002F2.api-reference\u002F06.employees\u002F3.update-employee.md",{"type":438,"value":439,"toc":440},"minimark",[],{"title":441,"searchDepth":442,"depth":442,"links":443},"",2,[],"Change someone's profile, such as a new start date or email.","md",null,{},{"badge":449},{"label":112,"color":113,"variant":89},{"title":108,"description":444},"rhJB3QxC3knxndJZ56wCTc3KAPBW0kiQ38uJH0es00o",[453,456],{"title":101,"path":102,"stem":103,"description":454,"badge":455,"children":-1},"Add someone, with the dates their rewards depend on.",{"label":105,"color":106,"variant":89},{"title":120,"path":121,"stem":122,"description":457,"badge":458,"children":-1},"Your departments, teams and other groups.",{"label":87,"color":88,"variant":89},1794422646790]