Use the areas field to control area assignments. Omit it to leave the event’s areas unchanged. Send an empty array ([]) to clear all areas. Send a non-empty array of area IDs to replace the current set. Invalid IDs return a 400 error.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Roosted HR API Documentation","colors":{"primary":"#22233a","light":"#f99b39","dark":"#171727"},"logo":{"light":"https://mintcdn.com/roostedinc/gMdQreXdkBLq8PaC/images/light.svg?fit=max\u0026auto=format\u0026n=gMdQreXdkBLq8PaC\u0026q=85\u0026s=da88ba240ddd676db3066d79cefa0702","dark":"https://mintcdn.com/roostedinc/gMdQreXdkBLq8PaC/images/dark.svg?fit=max\u0026auto=format\u0026n=gMdQreXdkBLq8PaC\u0026q=85\u0026s=62c13b3f25cedb32b6c2d38f1591e824","href":"https://docs.roostedhr.com"},"favicon":"https://mintcdn.com/roostedinc/gMdQreXdkBLq8PaC/favicon.ico?fit=max\u0026auto=format\u0026n=gMdQreXdkBLq8PaC\u0026q=85\u0026s=77e88b01663ffe107937f8d0719f405e","appearance":{"default":"system"},"background":{"decoration":"grid","color":{"light":"#efefef","dark":"#222"}},"navbar":{"links":[],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.mintlify.com"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"roostedinc","hasAudioNarration":false,"actualSubdomain":"roostedinc","customDomains":["docs.roostedhr.com"],"gitSource":{"type":"github","owner":"derickdorner","repo":"roosted-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a66a95a46a9de7af622588f","collectionId":"33b4f838-623d-4add-9a06-54f4e790c976","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a66a95a46a9de7af622588f"},"entitlements":{},"buildId":"6a66a95a46a9de7af622588f:success","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API reference","count":220},{"language":"default","tag":"Guides","count":136},{"language":"default","tag":"ATS","count":80},{"language":"default","tag":"Workers","count":68},{"language":"default","tag":"Configuration","count":33},{"language":"default","tag":"Clients","count":30},{"language":"default","tag":"Scheduling","count":22},{"language":"default","tag":"Candidates","count":15},{"language":"default","tag":"Documents","count":15},{"language":"default","tag":"Company","count":14}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/v01.12.00/events/edit-event","slug":"/api-reference/v01.12.00/events/edit-event","pageMetadata":{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /events/{id}","title":"Edit Event","description":"Updates an existing event. Despite being a PATCH endpoint, `name`, `date`, and `location` are required in every request.","href":"/api-reference/v01.12.00/events/edit-event"},"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: [\"Updates an existing event. Despite being a PATCH endpoint, \", _jsx(_components.code, {\n children: \"name\"\n }), \", \", _jsx(_components.code, {\n children: \"date\"\n }), \", and \", _jsx(_components.code, {\n children: \"location\"\n }), \" are required in every request.\"]\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components},{Heading,Note}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsxs(_components.p,{children:[`Even though this is a PATCH endpoint, `,_jsx(_components.code,{children:`name`}),`, `,_jsx(_components.code,{children:`date`}),`, and `,_jsx(_components.code,{children:`location`}),` are required in every request. Omitting them returns a validation error.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`areas`,children:`Areas`}),`\n`,_jsxs(_components.p,{children:[`Use the `,_jsx(_components.code,{children:`areas`}),` field to control area assignments. Omit it to leave the event’s areas unchanged. Send an empty array (`,_jsx(_components.code,{children:`[]`}),`) to clear all areas. Send a non-empty array of area IDs to replace the current set. Invalid IDs return a `,_jsx(_components.code,{children:`400`}),` error.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /events/{id}","title":"Edit Event","description":"Updates an existing event. Despite being a PATCH endpoint, `name`, `date`, and `location` are required in every request.","href":"/api-reference/v01.12.00/events/edit-event"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Areas","slug":"areas","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Edit Event","operationId":"patch-event","responses":{"200":"bf562601-9a25-4711-b418-aa82c6aca04b","400":"6716092d-e01d-4539-b79d-393860cdf4fe","401":"375e2a26-f7cc-4b3f-9fad-026678fd8bd5","403":"09248d50-7628-454e-acab-99af15dc2de8","404":"57c2de85-d820-4f54-bb4f-64c0cfc9abee","500":"19ee0d51-b5da-42a7-92c4-43a20d91b702"},"description":"Updates an existing event. Despite being a PATCH endpoint, `name`, `date`, and `location` are required in every request.","requestBody":"2df8449c-76db-47a9-92d1-36d1f263f4ee","parameters":[],"tags":["Events"],"method":"patch","type":"path","servers":["a1cfa6f2-7ef5-4b2e-90c0-22787add552d","d1d87584-8be3-4489-9a6c-b5e22dfc52fa"],"security":["9be8a80f-65a5-4ba9-85de-b004e45c6a4e"],"path":"/events/{id}","baseUrlOptions":["https://api.roostedhr.com/api/1_12","https://sandbox.roostedhr.com/api/1_12"],"title":"Edit Event","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"be56b175-263b-4b39-968a-13c6117bdd95":{"schema":{"type":"string","isRequired":true,"description":"Event ID","uniqueKey":"","typeLabel":"string"},"name":"id","in":"path","required":true,"description":"Event ID"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"date":{"type":"string","format":"date","isRequired":true,"uniqueKey":"date","typeLabel":"string\u003cdate>"},"location":{"type":"object","minProperties":1,"properties":{"location_id":{"type":"string","description":"ID of an existing saved location. If provided, other location fields are optional and will override the saved values.","pattern":"^[A-Za-z0-9]+","uniqueKey":"location.location_id","typeLabel":"string"},"name":{"type":"string","maxLength":150,"uniqueKey":"location.name","typeLabel":"string"},"address":{"type":"string","maxLength":150,"uniqueKey":"location.address","typeLabel":"string"},"city":{"type":"string","maxLength":75,"uniqueKey":"location.city","typeLabel":"string"},"zip":{"type":"string","maxLength":10,"uniqueKey":"location.zip","typeLabel":"string"},"saved":{"type":"string","description":"Set to `\"1\"` to save this location for future use.","pattern":"^[01]","maxLength":1,"uniqueKey":"location.saved","typeLabel":"string"}},"isRequired":true,"uniqueKey":"location","typeLabel":"object"},"event_id":{"type":"string","pattern":"^[A-Za-z0-9]+","uniqueKey":"event_id","typeLabel":"string"},"client_id":{"type":"string","pattern":"^[A-Za-z0-9]+","uniqueKey":"client_id","typeLabel":"string"},"admin_comments":{"type":"string","maxLength":65535,"uniqueKey":"admin_comments","typeLabel":"string"},"comments":{"type":"string","maxLength":65535,"uniqueKey":"comments","typeLabel":"string"},"custom_fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom field ID","isRequired":true,"uniqueKey":"custom_fields.items.[INDEX].id","typeLabel":"string"},"value":{"type":"string","maxLength":65535,"isRequired":true,"uniqueKey":"custom_fields.items.[INDEX].value","typeLabel":"string"}},"required":["id","value"],"uniqueKey":"custom_fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"custom_fields","typeLabel":"object[]"},"areas":{"type":"array","description":"Area IDs. Omit to leave unchanged; send [] to clear all; send a non-empty list to replace. Invalid IDs return 400.","items":{"type":"string","uniqueKey":"areas.items.[INDEX]","typeLabel":"string"},"uniqueKey":"areas","typeLabel":"string[]"}},"required":["name","date","location"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","date":"2023-12-25","location":{"location_id":"\u003cstring>","name":"\u003cstring>","address":"\u003cstring>","city":"\u003cstring>","zip":"\u003cstring>","saved":"\u003cstring>"},"event_id":"\u003cstring>","client_id":"\u003cstring>","admin_comments":"\u003cstring>","comments":"\u003cstring>","custom_fields":[{"id":"\u003cstring>","value":"\u003cstring>"}],"areas":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"bf562601-9a25-4711-b418-aa82c6aca04b":{"description":"OK","content":{"application/json":{"schema":{"title":"Event","type":"object","properties":{"id":{"type":"integer","uniqueKey":"id","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"date":{"type":"string","format":"date","uniqueKey":"date","typeLabel":"string\u003cdate>"},"event_id":{"type":"string","uniqueKey":"event_id","typeLabel":"string"},"client_id":{"type":"string","uniqueKey":"client_id","typeLabel":"string"},"created":{"type":"string","format":"date","uniqueKey":"created","typeLabel":"string\u003cdate>"},"location":{"title":"Location","type":"object","properties":{"id":{"type":"string","description":"Location identifier","uniqueKey":"location.id","typeLabel":"string"},"location":{"type":"string","description":"Location name","uniqueKey":"location.location","typeLabel":"string"},"addy_street_number":{"type":"string","description":"Street address","uniqueKey":"location.addy_street_number","typeLabel":"string"},"addy_city":{"type":"string","description":"City","uniqueKey":"location.addy_city","typeLabel":"string"},"addy_zip":{"type":"string","description":"ZIP/postal code","uniqueKey":"location.addy_zip","typeLabel":"string"},"location_comments":{"oneOf":[{"type":"string","description":"Additional comments","uniqueKey":"location.location_comments.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional comments","uniqueKey":"location.location_comments.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.location_comments","typeLabel":"string | null"},"default":{"oneOf":[{"type":"integer","minimum":0,"maximum":1,"description":"Whether this is the default location (0 or 1)","uniqueKey":"location.default.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"maximum":1,"description":"Whether this is the default location (0 or 1)","uniqueKey":"location.default.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.default","typeLabel":"integer | null"},"saved":{"oneOf":[{"type":"integer","minimum":0,"maximum":1,"description":"Whether the location is saved (0 or 1)","uniqueKey":"location.saved.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"maximum":1,"description":"Whether the location is saved (0 or 1)","uniqueKey":"location.saved.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.saved","typeLabel":"integer | null"},"color":{"oneOf":[{"type":"string","description":"Hex color code","example":"#DC136C","uniqueKey":"location.color.oneOf.0","typeLabel":"string"},{"type":"null","description":"Hex color code","example":"#DC136C","uniqueKey":"location.color.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.color","typeLabel":"string | null"},"timezone":{"type":"object","description":"Location timezone","properties":{"id":{"oneOf":[{"type":"integer","description":"Timezone identifier","uniqueKey":"location.timezone.id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Timezone identifier","uniqueKey":"location.timezone.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.timezone.id","typeLabel":"integer | null"},"name":{"oneOf":[{"type":"string","description":"Timezone name","uniqueKey":"location.timezone.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Timezone name","uniqueKey":"location.timezone.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.timezone.name","typeLabel":"string | null"},"offset":{"oneOf":[{"type":"string","description":"UTC offset","uniqueKey":"location.timezone.offset.oneOf.0","typeLabel":"string"},{"type":"null","description":"UTC offset","uniqueKey":"location.timezone.offset.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.timezone.offset","typeLabel":"string | null"}},"uniqueKey":"location.timezone","typeLabel":"object"},"companies_payroll_rulesets_id":{"oneOf":[{"type":"string","description":"Associated payroll ruleset ID","uniqueKey":"location.companies_payroll_rulesets_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Associated payroll ruleset ID","uniqueKey":"location.companies_payroll_rulesets_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.companies_payroll_rulesets_id","typeLabel":"string | null"},"payroll_rule_display":{"oneOf":[{"type":"string","description":"Payroll rule display name","uniqueKey":"location.payroll_rule_display.oneOf.0","typeLabel":"string"},{"type":"null","description":"Payroll rule display name","uniqueKey":"location.payroll_rule_display.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.payroll_rule_display","typeLabel":"string | null"},"latitude":{"oneOf":[{"type":"string","description":"GPS latitude coordinate","uniqueKey":"location.latitude.oneOf.0","typeLabel":"string"},{"type":"null","description":"GPS latitude coordinate","uniqueKey":"location.latitude.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.latitude","typeLabel":"string | null"},"longitude":{"oneOf":[{"type":"string","description":"GPS longitude coordinate","uniqueKey":"location.longitude.oneOf.0","typeLabel":"string"},{"type":"null","description":"GPS longitude coordinate","uniqueKey":"location.longitude.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.longitude","typeLabel":"string | null"},"default_clients_id":{"oneOf":[{"type":"string","description":"Default client hashed ID","uniqueKey":"location.default_clients_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Default client hashed ID","uniqueKey":"location.default_clients_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.default_clients_id","typeLabel":"string | null"},"default_areas":{"type":"array","description":"Default area IDs","items":{"type":"string","uniqueKey":"location.default_areas.items.[INDEX]","typeLabel":"string"},"uniqueKey":"location.default_areas","typeLabel":"string[]"}},"uniqueKey":"location","typeLabel":"Location · object"},"admin_origin":{"title":"EventManager","type":"object","properties":{"personnel_id":{"type":"string","uniqueKey":"admin_origin.personnel_id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"admin_origin.name","typeLabel":"string"}},"uniqueKey":"admin_origin","typeLabel":"EventManager · object"},"reviewer":{"title":"EventManager","type":"object","properties":{"personnel_id":{"type":"string","uniqueKey":"reviewer.personnel_id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"reviewer.name","typeLabel":"string"}},"uniqueKey":"reviewer","typeLabel":"EventManager · object"},"time_tracking_manager":{"title":"EventManager","type":"object","properties":{"personnel_id":{"type":"string","uniqueKey":"time_tracking_manager.personnel_id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"time_tracking_manager.name","typeLabel":"string"}},"uniqueKey":"time_tracking_manager","typeLabel":"EventManager · object"},"custom_fields":{"type":"array","items":{"title":"CustomField","type":"object","properties":{"id":{"type":"string","uniqueKey":"custom_fields.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"custom_fields.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","uniqueKey":"custom_fields.items.[INDEX].value","typeLabel":"string"},"options":{"type":"array","description":"Available options for this custom field (e.g., dropdown choices).","items":{"type":"object","properties":{"title":{"type":"string","uniqueKey":"custom_fields.items.[INDEX].options.items.[INDEX].title","typeLabel":"string"},"value":{"type":"string","uniqueKey":"custom_fields.items.[INDEX].options.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"custom_fields.items.[INDEX].options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"custom_fields.items.[INDEX].options","typeLabel":"object[]"}},"uniqueKey":"custom_fields.items.[INDEX]","typeLabel":"CustomField · object"},"uniqueKey":"custom_fields","typeLabel":"CustomField · object[]"},"areas":{"oneOf":[{"type":"array","description":"Areas/zones assigned to the event. Null if none.","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"areas.oneOf.0.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"areas.oneOf.0.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"areas.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"areas.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Areas/zones assigned to the event. Null if none.","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"uniqueKey":"areas.oneOf.1","typeLabel":"null"}],"uniqueKey":"areas","typeLabel":"object[] | null"}},"uniqueKey":"","typeLabel":"Event · object"},"examples":{"Example":{"title":"Example","value":{"id":123,"name":"\u003cstring>","date":"2023-12-25","event_id":"\u003cstring>","client_id":"\u003cstring>","created":"2023-12-25","location":{"id":"\u003cstring>","location":"\u003cstring>","addy_street_number":"\u003cstring>","addy_city":"\u003cstring>","addy_zip":"\u003cstring>","location_comments":"\u003cstring>","default":0,"saved":0,"color":"#DC136C","timezone":{"id":123,"name":"\u003cstring>","offset":"\u003cstring>"},"companies_payroll_rulesets_id":"\u003cstring>","payroll_rule_display":"\u003cstring>","latitude":"\u003cstring>","longitude":"\u003cstring>","default_clients_id":"\u003cstring>","default_areas":["\u003cstring>"]},"admin_origin":{"personnel_id":"\u003cstring>","name":"\u003cstring>"},"reviewer":{"personnel_id":"\u003cstring>","name":"\u003cstring>"},"time_tracking_manager":{"personnel_id":"\u003cstring>","name":"\u003cstring>"},"custom_fields":[{"id":"\u003cstring>","name":"\u003cstring>","value":"\u003cstring>","options":[{"title":"\u003cstring>","value":"\u003cstring>"}]}],"areas":[{"id":"\u003cstring>","name":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"6716092d-e01d-4539-b79d-393860cdf4fe":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code.","uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","description":"Human-readable error message.","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Name is required":{"title":"Name is required","value":{"code":"EVT-200","error":"Name is required"}},"Event ID exceeds maximum length":{"title":"Event ID exceeds maximum length","value":{"code":"EVT-200","error":"Event ID exceeds maximum length"}},"Admin comments exceeds maximum length":{"title":"Admin comments exceeds maximum length","value":{"code":"EVT-200","error":"Admin comments exceeds maximum length"}},"Comments exceeds maximum length":{"title":"Comments exceeds maximum length","value":{"code":"EVT-200","error":"Comments exceeds maximum length"}},"Invalid custom field":{"title":"Invalid custom field","value":{"code":"EVT-200","error":"Invalid custom field"}},"Custom field value exceeds maximum length":{"title":"Custom field value exceeds maximum length","value":{"code":"EVT-200","error":"Custom field value exceeds maximum length"}},"Date is required":{"title":"Date is required","value":{"code":"EVT-300","error":"Date is required"}},"Location is required":{"title":"Location is required","value":{"code":"EVT-400","error":"Location is required"}},"Invalid date format":{"title":"Invalid date format","value":{"code":"EVT-500","error":"Invalid date format"}},"Invalid client_id":{"title":"Invalid client_id","value":{"code":"EVT-600","error":"Invalid client_id"}}},"exampleType":"examples"}},"exampleType":"examples"},"375e2a26-f7cc-4b3f-9fad-026678fd8bd5":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code.","uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","description":"Human-readable error message.","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Invalid API key":{"title":"Invalid API key","value":{"code":"ATH-100","error":"Invalid or missing API key"}}},"exampleType":"examples"}},"exampleType":"examples"},"09248d50-7628-454e-acab-99af15dc2de8":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code.","uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","description":"Human-readable error message.","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Insufficient permissions":{"title":"Insufficient permissions","value":{"code":"EVT-800","error":"Insufficient permissions to manage events"}}},"exampleType":"examples"}},"exampleType":"examples"},"57c2de85-d820-4f54-bb4f-64c0cfc9abee":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code.","uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","description":"Human-readable error message.","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Event not found":{"title":"Event not found","value":{"code":"EVT-700","error":"Event not found"}}},"exampleType":"examples"}},"exampleType":"examples"},"19ee0d51-b5da-42a7-92c4-43a20d91b702":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code.","uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","description":"Human-readable error message.","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Unexpected error":{"title":"Unexpected error","value":{"code":"EVT-1000","error":"An unexpected error occurred"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"9be8a80f-65a5-4ba9-85de-b004e45c6a4e":{"X-API-KEY":{"name":"X-API-KEY","type":"apiKey","in":"header","scopes":[]}}},"servers":{"a1cfa6f2-7ef5-4b2e-90c0-22787add552d":{"url":"https://api.roostedhr.com/api/1_12"},"d1d87584-8be3-4489-9a6c-b5e22dfc52fa":{"url":"https://sandbox.roostedhr.com/api/1_12"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"name":"X-API-KEY","type":"apiKey","in":"header","scopes":[]},"schema":{"title":"X-API-KEY","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"X-API-KEY","name":"X-API-KEY"}],"title":"X-API-KEY"}]},"originalFileLocation":"api-reference/v01.12.00/openapi-v01.12.00.json"},"subdomain":"roostedinc","siteName":"Roosted HR API Documentation","title":"Edit Event - Roosted HR API Documentation","navMaps":{"firstHrefInVersion":{"v1.12":{"href":"/api-reference/v01.12.00/events/edit-event","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-06-16T19:55:38.834Z","originalFileLocation":"api-reference/v01.12.00/events/edit-event.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=\"Updates an existing event. Despite being a PATCH endpoint, name, date, and location are required in every request.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Roosted HR API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/roostedinc/oZIi9yjWrhtWen8Q/_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/roostedinc/oZIi9yjWrhtWen8Q/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/roostedinc/oZIi9yjWrhtWen8Q/_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/roostedinc/oZIi9yjWrhtWen8Q/_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/roostedinc/oZIi9yjWrhtWen8Q/_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/roostedinc/oZIi9yjWrhtWen8Q/_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/roostedinc/oZIi9yjWrhtWen8Q/_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/roostedinc/oZIi9yjWrhtWen8Q/_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/roostedinc/oZIi9yjWrhtWen8Q/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Edit Event - Roosted HR API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates an existing event. Despite being a PATCH endpoint, name, date, and location are required in every request.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Roosted HR API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.roostedhr.com/api-reference/v01.12.00/events/edit-event\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://roostedinc.mintlify.app/_mintlify/api/og/v2?division=Events\u0026amp;title=Edit+Event\u0026amp;description=Updates+an+existing+event.+Despite+being+a+PATCH+endpoint%2C+%60name%60%2C+%60date%60%2C+and+%60location%60+are+required+in+every+request.\u0026amp;theme=1407b01aea4a739c2f8c2dc5\u0026amp;signature=de1b7c6402082ffc426c6c931a7cf7a11bf6a8c97dccc8eff75a42b81739bff2\">\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=\"Edit Event - Roosted HR API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates an existing event. Despite being a PATCH endpoint, name, date, and location are required in every request.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://roostedinc.mintlify.app/_mintlify/api/og/v2?division=Events\u0026amp;title=Edit+Event\u0026amp;description=Updates+an+existing+event.+Despite+being+a+PATCH+endpoint%2C+%60name%60%2C+%60date%60%2C+and+%60location%60+are+required+in+every+request.\u0026amp;theme=1407b01aea4a739c2f8c2dc5\u0026amp;signature=de1b7c6402082ffc426c6c931a7cf7a11bf6a8c97dccc8eff75a42b81739bff2\">\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/roostedinc/oZIi9yjWrhtWen8Q/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Roosted HR API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#22233a\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.roostedhr.com/api-reference/v01.12.00/events/edit-event\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v01.12.00/events/edit-event.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.roostedhr.com/#organization\",\"name\":\"Roosted HR API Documentation\",\"url\":\"https://docs.roostedhr.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/roostedinc/gMdQreXdkBLq8PaC/images/light.svg?fit=max\u0026auto=format\u0026n=gMdQreXdkBLq8PaC\u0026q=85\u0026s=da88ba240ddd676db3066d79cefa0702\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.roostedhr.com#website\",\"name\":\"Roosted HR API Documentation\",\"url\":\"https://docs.roostedhr.com\",\"publisher\":{\"@id\":\"https://docs.roostedhr.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.roostedhr.com/api-reference/v01.12.00/events/edit-event#webpage\",\"url\":\"https://docs.roostedhr.com/api-reference/v01.12.00/events/edit-event\",\"name\":\"Edit Event\",\"description\":\"Updates an existing event. Despite being a PATCH endpoint, name, date, and location are required in every request.\",\"dateModified\":\"2026-06-16T19:55:38.834Z\",\"isPartOf\":{\"@id\":\"https://docs.roostedhr.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.roostedhr.com/api-reference/v01.12.00/events/edit-event#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.roostedhr.com/api-reference/v01.12.00/events/edit-event#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Events\",\"item\":\"https://docs.roostedhr.com/api-reference/v01.12.00/events/get-events\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Edit Event\",\"item\":\"https://docs.roostedhr.com/api-reference/v01.12.00/events/edit-event\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.roostedhr.com/api-reference/v01.12.00/events/edit-event#apireference\",\"headline\":\"Edit Event\",\"name\":\"Edit Event\",\"description\":\"Updates an existing event. Despite being a PATCH endpoint, name, date, and location are required in every request.\",\"url\":\"https://docs.roostedhr.com/api-reference/v01.12.00/events/edit-event\",\"mainEntityOfPage\":{\"@id\":\"https://docs.roostedhr.com/api-reference/v01.12.00/events/edit-event#webpage\"},\"dateModified\":\"2026-06-16T19:55:38.834Z\",\"publisher\":{\"@id\":\"https://docs.roostedhr.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.roostedhr.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Roosted HR API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Roosted HR API Documentation","nav":{"global":null,"versions":[{"version":"v1.12","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/getting-started/getting-started-with-roosted"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"Getting Started","href":"/api-reference/getting-started"}]},{"group":"Announcements","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /announcements","title":"Get Announcements","href":"/api-reference/v01.12.00/announcements/get-announcements"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /announcements","title":"Create Announcement","href":"/api-reference/v01.12.00/announcements/create-announcement"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /announcements/{id}","title":"Get Announcement","href":"/api-reference/v01.12.00/announcements/get-announcement"}]},{"group":"Areas","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /areas","title":"Get Areas","href":"/api-reference/v01.12.00/areas/get-areas"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /areas","title":"Create Area","href":"/api-reference/v01.12.00/areas/create-area"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /areas/{id}","title":"Get Area","href":"/api-reference/v01.12.00/areas/get-area"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /areas/{id}","title":"Edit Area","href":"/api-reference/v01.12.00/areas/edit-area"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /areas/{id}","title":"Delete Area","href":"/api-reference/v01.12.00/areas/delete-area"}]},{"group":"ATS","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-contracts","title":"List Contracts","href":"/api-reference/v01.12.00/ats/get-contracts"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-contracts","title":"Create Contract","href":"/api-reference/v01.12.00/ats/create-contract"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-contracts/{uuid}","title":"Get Contract","href":"/api-reference/v01.12.00/ats/get-contract"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-contracts/{uuid}","title":"Update Contract","href":"/api-reference/v01.12.00/ats/edit-contract"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-contracts/{uuid}","title":"Delete Contract","href":"/api-reference/v01.12.00/ats/delete-contract"},{"group":"Contract Admins","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-contracts/{uuid}/admins","title":"List Contract Admins","href":"/api-reference/v01.12.00/ats/get-contract-admins"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-contracts/{uuid}/admins","title":"Add Contract Admin","href":"/api-reference/v01.12.00/ats/add-contract-admin"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-contracts/{uuid}/admins/{personnel_id}","title":"Remove Contract Admin","href":"/api-reference/v01.12.00/ats/remove-contract-admin"}]},{"group":"Contract Compliance","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-contracts/{uuid}/compliance","title":"Get Contract Compliance Requirements","href":"/api-reference/v01.12.00/ats/get-contract-compliance"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-contracts/{uuid}/compliance/apply","title":"Apply Compliance Template to Contract","href":"/api-reference/v01.12.00/ats/apply-contract-compliance"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-contracts/{uuid}/custom-fields","title":"Get Contract Custom Fields","href":"/api-reference/v01.12.00/ats/get-contract-custom-fields"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-contracts/{uuid}/custom-fields","title":"Set Contract Custom Field Value","href":"/api-reference/v01.12.00/ats/set-contract-custom-field"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-contracts/{uuid}/credential-visibility","title":"Get Credential Visibility","href":"/api-reference/v01.12.00/ats/get-contract-credential-visibility"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-contracts/{uuid}/credential-visibility","title":"Set Credential Visibility","href":"/api-reference/v01.12.00/ats/set-contract-credential-visibility"}]},{"group":"Compliance Templates","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-compliance-templates","title":"List Compliance Templates","href":"/api-reference/v01.12.00/ats/get-compliance-templates"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-compliance-templates","title":"Create Compliance Template","href":"/api-reference/v01.12.00/ats/create-compliance-template"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-compliance-templates/{id}","title":"Update Compliance Template","href":"/api-reference/v01.12.00/ats/edit-compliance-template"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-compliance-templates/{id}","title":"Delete Compliance Template","href":"/api-reference/v01.12.00/ats/delete-compliance-template"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-compliance-templates/{id}/default","title":"Set Compliance Template Default","href":"/api-reference/v01.12.00/ats/set-compliance-template-default"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-compliance-templates/defaults","title":"Get Default Requirements","href":"/api-reference/v01.12.00/ats/get-compliance-template-defaults"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-compliance-templates/{id}/requirements","title":"List Template Requirements","href":"/api-reference/v01.12.00/ats/get-compliance-template-requirements"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-compliance-templates/{id}/requirements","title":"Add Template Requirement","href":"/api-reference/v01.12.00/ats/add-compliance-template-requirement"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-compliance-templates/{id}/requirements/{req_id}","title":"Update Template Requirement","href":"/api-reference/v01.12.00/ats/edit-compliance-template-requirement"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-compliance-templates/{id}/requirements/{req_id}","title":"Delete Template Requirement","href":"/api-reference/v01.12.00/ats/delete-compliance-template-requirement"}]},{"group":"Pipelines","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-pipelines","title":"List Pipelines","href":"/api-reference/v01.12.00/ats/get-pipelines"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-pipelines","title":"Create Pipeline","href":"/api-reference/v01.12.00/ats/create-pipeline"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-pipelines/{id}","title":"Update Pipeline","href":"/api-reference/v01.12.00/ats/edit-pipeline"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-pipelines/{id}","title":"Delete Pipeline","href":"/api-reference/v01.12.00/ats/delete-pipeline"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-pipelines/{id}/default","title":"Set Default Pipeline","href":"/api-reference/v01.12.00/ats/set-pipeline-default"}]},{"group":"Stages","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-stages","title":"List All Stages","href":"/api-reference/v01.12.00/ats/get-stages"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-pipelines/{id}/stages","title":"List Pipeline Stages","href":"/api-reference/v01.12.00/ats/get-pipeline-stages"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-pipelines/{id}/stages","title":"Create Stage","href":"/api-reference/v01.12.00/ats/create-pipeline-stage"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-stages/{id}","title":"Update Stage","href":"/api-reference/v01.12.00/ats/edit-stage"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-stages/{id}","title":"Delete Stage","href":"/api-reference/v01.12.00/ats/delete-stage"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-stages/reorder","title":"Reorder Stages","href":"/api-reference/v01.12.00/ats/reorder-stages"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-stages/{id}/requirements","title":"List Stage Requirements","href":"/api-reference/v01.12.00/ats/get-stage-requirements"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-stages/{id}/requirements","title":"Add Stage Requirement","href":"/api-reference/v01.12.00/ats/add-stage-requirement"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-stages/{id}/requirements/{req_id}","title":"Delete Stage Requirement","href":"/api-reference/v01.12.00/ats/delete-stage-requirement"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-stages/{id}/task-templates","title":"List Task Templates","href":"/api-reference/v01.12.00/ats/get-stage-task-templates"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-stages/{id}/task-templates","title":"Create Task Template","href":"/api-reference/v01.12.00/ats/create-stage-task-template"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-task-templates/{id}","title":"Update Task Template","href":"/api-reference/v01.12.00/ats/edit-task-template"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-task-templates/{id}","title":"Delete Task Template","href":"/api-reference/v01.12.00/ats/delete-task-template"}]},{"group":"Applications","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-contracts/{uuid}/applications","title":"List Contract Applications","href":"/api-reference/v01.12.00/ats/get-contract-applications"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-contracts/{uuid}/applications","title":"Create Application","href":"/api-reference/v01.12.00/ats/create-contract-application"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-contracts/{uuid}/applications/batch","title":"Batch Create Applications","href":"/api-reference/v01.12.00/ats/batch-create-applications"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-contracts/{uuid}/eligible","title":"List Eligible Personnel","href":"/api-reference/v01.12.00/ats/get-contract-eligible"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-applications/{id}/advance","title":"Advance Application","href":"/api-reference/v01.12.00/ats/advance-application"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-applications/{id}/reject","title":"Reject Application","href":"/api-reference/v01.12.00/ats/reject-application"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-applications/{id}/withdraw","title":"Withdraw Application","href":"/api-reference/v01.12.00/ats/withdraw-application"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-applications/{id}/place","title":"Place Application","href":"/api-reference/v01.12.00/ats/place-application"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-applications/{id}/complete","title":"Complete Application","href":"/api-reference/v01.12.00/ats/complete-application"}]},{"group":"Tasks","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-tasks","title":"List Tasks","href":"/api-reference/v01.12.00/ats/get-tasks"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-applications/{id}/tasks","title":"Create Task","href":"/api-reference/v01.12.00/ats/create-application-task"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-tasks/{id}","title":"Update Task","href":"/api-reference/v01.12.00/ats/edit-task"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-tasks/{id}/complete","title":"Complete Task","href":"/api-reference/v01.12.00/ats/complete-task"}]},{"group":"Candidates","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-candidates","title":"List Candidates","href":"/api-reference/v01.12.00/ats/get-candidates"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-candidates","title":"Create Candidate","href":"/api-reference/v01.12.00/ats/create-candidate"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-candidates/import","title":"Import Worker as Candidate","href":"/api-reference/v01.12.00/ats/import-candidate"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-candidates/{id}","title":"Get Candidate","href":"/api-reference/v01.12.00/ats/get-candidate"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-candidates/{id}/resend-invitation","title":"Resend Candidate Invitation","href":"/api-reference/v01.12.00/ats/resend-candidate-invitation"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-candidates/{id}/convert-to-worker","title":"Convert Candidate to Worker","href":"/api-reference/v01.12.00/ats/convert-candidate-to-worker"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-candidates/{id}/compliance-gaps","title":"Get Compliance Gaps","href":"/api-reference/v01.12.00/ats/get-candidate-compliance-gaps"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-candidates/{id}/applications","title":"List Candidate Applications","href":"/api-reference/v01.12.00/ats/get-candidate-applications"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-candidates/{id}/applied-contracts","title":"List Applied Contracts","href":"/api-reference/v01.12.00/ats/get-candidate-applied-contracts"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-candidates/{id}/notes","title":"List Candidate Notes","href":"/api-reference/v01.12.00/ats/get-candidate-notes"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-candidates/{id}/notes","title":"Create Candidate Note","href":"/api-reference/v01.12.00/ats/create-candidate-note"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-candidates/{id}/messages/{application_id}","title":"Get Candidate Messages","href":"/api-reference/v01.12.00/ats/get-candidate-messages"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-candidates/{id}/messages/{application_id}","title":"Send Candidate Message","href":"/api-reference/v01.12.00/ats/send-candidate-message"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-candidates/{id}/activity","title":"Get Candidate Activity","href":"/api-reference/v01.12.00/ats/get-candidate-activity"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-credentials/{id}/review","title":"Review Credential","href":"/api-reference/v01.12.00/ats/review-credential"}]},{"group":"Dashboard","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-dashboard/badges","title":"Get Dashboard Badges","href":"/api-reference/v01.12.00/ats/get-dashboard-badges"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-dashboard/pipeline-summary","title":"Get Pipeline Summary","href":"/api-reference/v01.12.00/ats/get-dashboard-pipeline-summary"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-dashboard/audit-log","title":"Get Audit Log","href":"/api-reference/v01.12.00/ats/get-dashboard-audit-log"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-dashboard/audit-log/accessors","title":"List Audit Log Accessors","href":"/api-reference/v01.12.00/ats/get-dashboard-audit-log-accessors"}]},{"group":"Settings","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-settings/config","title":"Get ATS Configuration","href":"/api-reference/v01.12.00/ats/get-settings-config"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-settings/config","title":"Update ATS Configuration","href":"/api-reference/v01.12.00/ats/edit-settings-config"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-settings/custom-fields","title":"List Custom Fields","href":"/api-reference/v01.12.00/ats/get-settings-custom-fields"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-settings/custom-fields","title":"Create Custom Field","href":"/api-reference/v01.12.00/ats/create-settings-custom-field"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-settings/custom-fields/{id}","title":"Update Custom Field","href":"/api-reference/v01.12.00/ats/edit-settings-custom-field"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-settings/custom-fields/{id}","title":"Delete Custom Field","href":"/api-reference/v01.12.00/ats/delete-settings-custom-field"}]}]},{"group":"Clients","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /clients","title":"Get Clients","href":"/api-reference/v01.12.00/clients/get-clients"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /clients","title":"Create Client","href":"/api-reference/v01.12.00/clients/create-client"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}","title":"Get Client","href":"/api-reference/v01.12.00/clients/get-client"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /clients/{id}","title":"Edit Client","href":"/api-reference/v01.12.00/clients/edit-client"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /clients/{id}","title":"Delete Client","href":"/api-reference/v01.12.00/clients/delete-client"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /clients/{id}/invite","title":"Invite Client by Email","href":"/api-reference/v01.12.00/clients/invite-client"},{"group":"Contacts","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/contacts","title":"Get Client Contacts","href":"/api-reference/v01.12.00/clients/get-client-contacts"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /clients/{id}/contacts","title":"Create Client Contact","href":"/api-reference/v01.12.00/clients/create-client-contact"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/contacts/{contact_id}","title":"Get Client Contact","href":"/api-reference/v01.12.00/clients/get-client-contact"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /clients/{id}/contacts/{contact_id}","title":"Edit Client Contact","href":"/api-reference/v01.12.00/clients/edit-client-contact"}]},{"group":"Custom Fields","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/custom-fields","title":"Get Client Custom Fields with Values","href":"/api-reference/v01.12.00/clients/get-client-custom-fields"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /clients/{id}/custom-fields","title":"Set Client Custom Field Value","href":"/api-reference/v01.12.00/clients/set-client-custom-field"}]},{"group":"Documents","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/documents","title":"Get Client Documents","href":"/api-reference/v01.12.00/clients/get-client-documents"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /clients/{id}/documents","title":"Upload Client Document","href":"/api-reference/v01.12.00/clients/upload-client-document"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/documents/{document_id}","title":"Get Client Document","href":"/api-reference/v01.12.00/clients/get-client-document"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /clients/{id}/documents/{document_id}","title":"Delete Client Document","href":"/api-reference/v01.12.00/clients/delete-client-document"}]},{"group":"Orders","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/orders","title":"Get Client Orders","href":"/api-reference/v01.12.00/clients/get-client-orders"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/orders/{order_id}","title":"Get Client Order","href":"/api-reference/v01.12.00/clients/get-client-order"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /clients/{id}/orders/{order_id}/approve","title":"Approve Client Order","href":"/api-reference/v01.12.00/clients/approve-client-order"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /clients/{id}/orders/{order_id}/decline","title":"Decline Client Order","href":"/api-reference/v01.12.00/clients/decline-client-order"}]},{"group":"Rules","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/rules","title":"Get Client Rules","href":"/api-reference/v01.12.00/clients/get-client-rules"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /clients/{id}/rules","title":"Create Client Rule","href":"/api-reference/v01.12.00/clients/create-client-rule"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /clients/{id}/rules/{rule_id}","title":"Delete Client Rule","href":"/api-reference/v01.12.00/clients/delete-client-rule"}]},{"group":"Workers","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/workers","title":"Get Client Workers","href":"/api-reference/v01.12.00/clients/get-client-workers"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/workers/{worker_id}/status","title":"Get Client Worker Status","href":"/api-reference/v01.12.00/clients/get-client-worker-status"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /clients/{id}/workers/{worker_id}/status","title":"Edit Client Worker Status","href":"/api-reference/v01.12.00/clients/edit-client-worker-status"}]}]},{"group":"Company","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /company/info","title":"Get Company Info","href":"/api-reference/v01.12.00/company/get-company-info"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /company/info","title":"Edit Company Info","href":"/api-reference/v01.12.00/company/edit-company-info"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /company/info/hr","title":"Get Company HR Info","href":"/api-reference/v01.12.00/company/get-company-hr-info"},{"group":"Documents","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /company/documents","title":"Get Company Documents","href":"/api-reference/v01.12.00/company/get-company-documents"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /company/documents","title":"Create Company Document","href":"/api-reference/v01.12.00/company/create-company-document"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /company/documents/{id}","title":"Get Company Document","href":"/api-reference/v01.12.00/company/get-company-document"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /company/documents/{id}","title":"Delete Company Document","href":"/api-reference/v01.12.00/company/delete-company-document"}]},{"group":"Integrations","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /company/integrations","title":"Get Company Integrations","href":"/api-reference/v01.12.00/company/get-company-integrations"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /company/integrations/count","title":"Get Company Integrations Count","href":"/api-reference/v01.12.00/company/get-company-integrations-count"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /company/integrations/{id}","title":"Get Company Integration","href":"/api-reference/v01.12.00/company/get-company-integration"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /company/integrations","title":"Set Up Company Integration","href":"/api-reference/v01.12.00/company/set-up-company-integration"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /company/integrations/{id}","title":"Update Company Integration","href":"/api-reference/v01.12.00/company/update-company-integration"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /company/integrations/{id}/regenerate","title":"Regenerate Company Integration Secret Key","href":"/api-reference/v01.12.00/company/regenerate-company-integration"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /company/integrations/{id}","title":"Delete Company Integration","href":"/api-reference/v01.12.00/company/delete-company-integration"}]}]},{"group":"Configuration","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /config","title":"Get Configuration","href":"/api-reference/v01.12.00/configuration/get-configuration"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /config","title":"Edit Configuration","href":"/api-reference/v01.12.00/configuration/edit-configuration"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /countries","title":"Get Countries","href":"/api-reference/v01.12.00/configuration/get-countries"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /timezones","title":"Get Timezones","href":"/api-reference/v01.12.00/configuration/get-timezones"}]},{"group":"Events","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /events","title":"Get Events","href":"/api-reference/v01.12.00/events/get-events"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /events","title":"Create Event","href":"/api-reference/v01.12.00/events/create-event"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /events/search","title":"Search Events","href":"/api-reference/v01.12.00/events/search-events"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /events/{id}","title":"Get Event","description":"Returns details for a single event by ID.","href":"/api-reference/v01.12.00/events/get-event"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /events/{id}","title":"Edit Event","href":"/api-reference/v01.12.00/events/edit-event"},{"group":"Admins","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /events/{id}/admins","title":"Get Event Admins","description":"Returns the list of admins assigned to an event.","href":"/api-reference/v01.12.00/events/get-event-admins"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /events/{id}/admins","title":"Add Event Admin","href":"/api-reference/v01.12.00/events/add-event-admin"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /events/{id}/admins/{admin_id}","title":"Delete Event Admin","href":"/api-reference/v01.12.00/events/delete-event-admin"}]},{"group":"Shifts","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /events/{id}/shifts","title":"Get Event Shifts","href":"/api-reference/v01.12.00/events/get-shifts"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /events/{id}/shifts","title":"Create Shift","href":"/api-reference/v01.12.00/events/create-shift"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /events/{id}/shifts/{shift_id}","title":"Get Shift","href":"/api-reference/v01.12.00/events/get-shift"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /events/{id}/shifts/{shift_id}","title":"Edit Shift","href":"/api-reference/v01.12.00/events/edit-shift"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /events/{id}/shifts/{shift_id}","title":"Delete Shift","href":"/api-reference/v01.12.00/events/delete-shift"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /events/{id}/shifts/{shift_id}/is-full","title":"Check if Shift is Full","href":"/api-reference/v01.12.00/events/check-shift-full"}]}]},{"group":"Locations","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /locations","title":"Get Locations","href":"/api-reference/v01.12.00/locations/get-locations"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /locations","title":"Create Location","href":"/api-reference/v01.12.00/locations/create-location"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /locations/{id}","title":"Get Location","href":"/api-reference/v01.12.00/locations/get-location"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /locations/{id}","title":"Edit Location","href":"/api-reference/v01.12.00/locations/edit-location"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /locations/{id}","title":"Delete Location","href":"/api-reference/v01.12.00/locations/delete-location"}]},{"group":"Payroll Groups","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /payroll-groups","title":"Get Payroll Groups","href":"/api-reference/v01.12.00/payroll-groups/get-payroll-groups"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /payroll-groups","title":"Create Payroll Group","href":"/api-reference/v01.12.00/payroll-groups/create-payroll-group"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /payroll-groups/{id}","title":"Get Payroll Group","href":"/api-reference/v01.12.00/payroll-groups/get-payroll-group"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /payroll-groups/{id}","title":"Edit Payroll Group","href":"/api-reference/v01.12.00/payroll-groups/edit-payroll-group"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /payroll-groups/{id}","title":"Delete Payroll Group","href":"/api-reference/v01.12.00/payroll-groups/delete-payroll-group"}]},{"group":"Rate Cards","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /rate-cards","title":"Get Rate Cards","href":"/api-reference/v01.12.00/rate-cards/get-rate-cards"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /rate-cards","title":"Create Rate Card","href":"/api-reference/v01.12.00/rate-cards/create-rate-card"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /rate-cards/{id}","title":"Get Rate Card","href":"/api-reference/v01.12.00/rate-cards/get-rate-card"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /rate-cards/{id}","title":"Edit Rate Card","href":"/api-reference/v01.12.00/rate-cards/edit-rate-card"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /rate-cards/{id}","title":"Delete Rate Card","href":"/api-reference/v01.12.00/rate-cards/delete-rate-card"}]},{"group":"Skillsets","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /skillsets","title":"Get Skillsets","href":"/api-reference/v01.12.00/skillsets/get-skillsets"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /skillsets","title":"Create Skillset","href":"/api-reference/v01.12.00/skillsets/create-skillset"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /skillsets/{id}","title":"Get Skillset","href":"/api-reference/v01.12.00/skillsets/get-skillset"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /skillsets/{id}","title":"Edit Skillset","href":"/api-reference/v01.12.00/skillsets/edit-skillset"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /skillsets/{id}","title":"Delete Skillset","href":"/api-reference/v01.12.00/skillsets/delete-skillset"}]},{"group":"Time Tracking","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /time-tracking/worker-summary","title":"Get Worker Time Tracking Summary","href":"/api-reference/v01.12.00/time-tracking/get-worker-time-tracking-summary"}]},{"group":"Wage Rules","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /wage-rules","title":"Get Wage Rules","href":"/api-reference/v01.12.00/wage-rules/get-wage-rules"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /wage-rules","title":"Create Wage Rule","href":"/api-reference/v01.12.00/wage-rules/create-wage-rule"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /wage-rules/{id}","title":"Get Wage Rule","href":"/api-reference/v01.12.00/wage-rules/get-wage-rule"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /wage-rules/{id}","title":"Edit Wage Rule","href":"/api-reference/v01.12.00/wage-rules/edit-wage-rule"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /wage-rules/{id}","title":"Delete Wage Rule","href":"/api-reference/v01.12.00/wage-rules/delete-wage-rule"}]},{"group":"Workers","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers","title":"Get Workers","href":"/api-reference/v01.12.00/workers/get-workers"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /workers","title":"Create Worker","href":"/api-reference/v01.12.00/workers/create-worker"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}","title":"Get Worker","href":"/api-reference/v01.12.00/workers/get-worker"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /workers/{id}","title":"Edit Worker","href":"/api-reference/v01.12.00/workers/edit-worker"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/transferred-workers","title":"Get Transferred Workers","href":"/api-reference/v01.12.00/workers/get-transferred-workers"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/transferred-workers","title":"Add Transferred Workers","href":"/api-reference/v01.12.00/workers/add-transferred-workers"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/availability","title":"Get Worker Availability","href":"/api-reference/v01.12.00/workers/get-worker-availability"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/limits","title":"Get Worker Limits","href":"/api-reference/v01.12.00/workers/get-worker-limits"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/permissions","title":"Get Worker Permissions","href":"/api-reference/v01.12.00/workers/get-worker-permissions"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /workers/{id}/permissions","title":"Edit Worker Permissions","href":"/api-reference/v01.12.00/workers/edit-worker-permissions"},{"group":"Chats","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/chats","title":"Get Chats","href":"/api-reference/v01.12.00/workers/get-chats"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/chats","title":"Create Chat","href":"/api-reference/v01.12.00/workers/create-chat"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/chats/{chat_id}","title":"Get Chat","href":"/api-reference/v01.12.00/workers/get-chat"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /workers/{id}/chats/{chat_id}","title":"Edit Chat","href":"/api-reference/v01.12.00/workers/edit-chat"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /workers/{id}/chats/{chat_id}","title":"Delete Chat","href":"/api-reference/v01.12.00/workers/delete-chat"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/chats/unread-messages-count","title":"Get Unread Messages Count","href":"/api-reference/v01.12.00/workers/get-unread-messages-count"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/chats/{chat_id}/messages","title":"Get Chat Messages","href":"/api-reference/v01.12.00/workers/get-chat-messages"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/chats/{chat_id}/messages","title":"Send Message","href":"/api-reference/v01.12.00/workers/send-chat-message"}]},{"group":"Credentials","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/credentials","title":"Get Worker Credentials","href":"/api-reference/v01.12.00/workers/get-worker-credentials"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/credentials","title":"Create Worker Credential","href":"/api-reference/v01.12.00/workers/create-worker-credential"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/credentials/{credentials_id}","title":"Get Worker Credential","href":"/api-reference/v01.12.00/workers/get-worker-credential"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /workers/{id}/credentials/{credentials_id}","title":"Delete Worker Credential","href":"/api-reference/v01.12.00/workers/delete-worker-credential"}]},{"group":"Documents","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/documents","title":"Get Worker Documents","href":"/api-reference/v01.12.00/workers/get-worker-documents"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/documents","title":"Upload Worker Document","href":"/api-reference/v01.12.00/workers/upload-worker-document"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/documents/{document_id}","title":"Get Worker Document","href":"/api-reference/v01.12.00/workers/get-worker-document"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/documents/{document_id}","title":"Set Worker Document Viewable","href":"/api-reference/v01.12.00/workers/set-worker-document-viewable"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /workers/{id}/documents/{document_id}","title":"Delete Worker Document","href":"/api-reference/v01.12.00/workers/delete-worker-document"}]},{"group":"Orders","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/orders","title":"Get Worker Orders","href":"/api-reference/v01.12.00/workers/get-worker-orders"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/orders","title":"Create Worker Order","href":"/api-reference/v01.12.00/workers/create-worker-order"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/orders/{order_id}","title":"Get Worker Order","href":"/api-reference/v01.12.00/workers/get-worker-order"}]},{"group":"Reimbursements","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/reimbursements","title":"Get Worker Reimbursements","href":"/api-reference/v01.12.00/workers/get-worker-reimbursements"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/reimbursements","title":"Add Worker Reimbursement","href":"/api-reference/v01.12.00/workers/add-worker-reimbursement"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/reimbursements/{reimbursement_id}","title":"Get Worker Reimbursement","href":"/api-reference/v01.12.00/workers/get-worker-reimbursement"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/reimbursements/{reimbursement_id}/approve","title":"Approve Worker Reimbursement","href":"/api-reference/v01.12.00/workers/approve-worker-reimbursement"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/reimbursements/{reimbursement_id}/reject","title":"Reject Worker Reimbursement","href":"/api-reference/v01.12.00/workers/reject-worker-reimbursement"}]},{"group":"Shifts","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/shifts","title":"Get Worker Shifts","href":"/api-reference/v01.12.00/workers/get-worker-shifts"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/shifts/{shift_id}","title":"Get Worker Shift","href":"/api-reference/v01.12.00/workers/get-worker-shift"}]},{"group":"Tags","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/tags","title":"Get Worker Tags","href":"/api-reference/v01.12.00/workers/get-worker-tags"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/tags","title":"Create Worker Tag","href":"/api-reference/v01.12.00/workers/create-worker-tag"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/tags/{tag_id}","title":"Add Worker Tag","href":"/api-reference/v01.12.00/workers/add-worker-tag"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /workers/{id}/tags/{tag_id}","title":"Delete Worker Tag","href":"/api-reference/v01.12.00/workers/delete-worker-tag"}]},{"group":"Time Punches","pages":[{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/time-punches","title":"Get Worker Time Punches","href":"/api-reference/v01.12.00/workers/get-worker-time-punches"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/time-punches","title":"Add Worker Time Punch","href":"/api-reference/v01.12.00/workers/add-worker-time-punch"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/time-punches/{punch_id}","title":"Get Worker Time Punch","href":"/api-reference/v01.12.00/workers/get-worker-time-punch"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json PATCH /workers/{id}/time-punches/{punch_id}","title":"Edit Worker Time Punch","href":"/api-reference/v01.12.00/workers/edit-worker-time-punch"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/time-punches/{punch_id}/approve","title":"Approve Worker Time Punch","href":"/api-reference/v01.12.00/workers/approve-worker-time-punch"},{"openapi":"api-reference/v01.12.00/openapi-v01.12.00.json DELETE /workers/{id}/time-punches/{punch_id}","title":"Delete Worker Time Punch","href":"/api-reference/v01.12.00/workers/delete-worker-time-punch"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}],"global":{"anchors":[]}}]},"title":"Edit Event - Roosted HR API Documentation","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-kQh739Uz.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}