Patch semantics (absent/null = unchanged, "" clears). Upserts by sourceId, falling back to email; when matched by email, the email can’t be changed. Applies to the token’s own company only.
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"essentry Integration Portal","colors":{"primary":"#045dd9","light":"#045dd9","dark":"#045dd9"},"logo":"https://mintcdn.com/essentry/7q4HEkq-dIzvu0DP/assets/logo-dark.svg?fit=max\u0026auto=format\u0026n=7q4HEkq-dIzvu0DP\u0026q=85\u0026s=bbe86a1ea80a23f4bd79bb95f3fa2c69","favicon":"https://mintcdn.com/essentry/zioFo8p_mLl3JETi/assets/favicon.png?fit=max\u0026auto=format\u0026n=zioFo8p_mLl3JETi\u0026q=85\u0026s=1008f87eccf222576411ea15af8431b8","api":{"playground":{"proxy":false}},"appearance":{"default":"dark","strict":true},"navbar":{"links":[{"href":"mailto:support@essentry.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.essentry.com"}},"footer":{"socials":{"website":"https://essentry.com"}},"integrations":{"posthog":{"apiKey":"phc_JPIiOH7dNCiSPXZAitrPEGRRAnVrvVpysqPLDKl11To"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"essentry","hasAudioNarration":false,"actualSubdomain":"essentry","customDomains":["integrate.essentry.com"],"gitSource":{"type":"github","owner":"essentry","repo":"integrate.essentry.com","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adee9c3d1c84ec1c20f80e6","collectionId":"1efeb644-d194-4c26-8f6d-b7eecf5e364b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adee9c3d1c84ec1c20f80e6"},"feedback":{"edits":true,"issues":true,"thumbs":false,"agentFeedback":true},"entitlements":{},"buildId":"6adee9c3d1c84ec1c20f80e6","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"API Reference","count":12},{"language":"default","tag":"Cloud Connector","count":4},{"language":"default","tag":"Access Control","count":3},{"language":"default","tag":"Post-Processor","count":3},{"language":"default","tag":"User Provisioning","count":3},{"language":"default","tag":"Post-Processor Integration","count":3},{"language":"default","tag":"API Documentation","count":2},{"language":"default","tag":"Permanent Identities","count":2},{"language":"default","tag":"Configuration","count":2}]},"assistantConfig":{},"basePath":"","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":"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":"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":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/permanent-identities/synchronize-permanent-identities","slug":"/api-reference/permanent-identities/synchronize-permanent-identities","pageMetadata":{"openapi":"api-reference/openapi.yaml put /permanent-identities","title":"Synchronize Permanent Identities","description":"Patch semantics (absent/null = unchanged, \"\" clears). Upserts by sourceId, falling back to email; when matched by email, the email can't be changed. Applies to the token's own company only.","href":"/api-reference/permanent-identities/synchronize-permanent-identities"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Patch semantics (absent/null = unchanged, \\\"\\\" clears). Upserts by sourceId, falling back to email; when matched by email, the email can’t be changed. Applies to the token’s own company only.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"api-reference/openapi.yaml put /permanent-identities","title":"Synchronize Permanent Identities","description":"Patch semantics (absent/null = unchanged, \"\" clears). Upserts by sourceId, falling back to email; when matched by email, the email can't be changed. Applies to the token's own company only.","href":"/api-reference/permanent-identities/synchronize-permanent-identities"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"PermanentIdentities_synchronizePermanentIdentities","summary":"Synchronize Permanent Identities","description":"Patch semantics (absent/null = unchanged, \"\" clears). Upserts by sourceId, falling back to email; when matched by email, the email can't be changed. Applies to the token's own company only.","parameters":[],"responses":{"200":"e122639d-6564-4712-a026-546db33862e4"},"tags":["Permanent Identities"],"requestBody":"9f2e0cbb-93e3-47f1-8892-f8c92ef8d264","method":"put","type":"path","servers":["41c52938-f232-49d9-9aff-cbcd678d040c"],"security":["c6d58f20-2415-43a8-aee6-309f1df54e0e"],"path":"/permanent-identities","baseUrlOptions":["https://app.essentry.com/api/v2"],"title":"Synchronize Permanent Identities","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"permanentIdentities":{"type":"array","items":{"type":"object","properties":{"sourceId":{"type":"string","description":"This is the ID in your system, e.g. an employee number. Unique per company. At least one of sourceId and email is required.","uniqueKey":"permanentIdentities.items.[INDEX].sourceId","typeLabel":"string"},"email":{"type":"string","uniqueKey":"permanentIdentities.items.[INDEX].email","typeLabel":"string"},"firstName":{"type":"string","uniqueKey":"permanentIdentities.items.[INDEX].firstName","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"permanentIdentities.items.[INDEX].lastName","typeLabel":"string"},"companyName":{"type":"string","uniqueKey":"permanentIdentities.items.[INDEX].companyName","typeLabel":"string"},"language":{"type":"string","enum":["CS","DE","EN","ES","FR","HR","HU","IT","NL","PL","PT","RO","RU","TR","ZH_CN"],"uniqueKey":"permanentIdentities.items.[INDEX].language","typeLabel":"enum\u003cstring>"},"customFields":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"permanentIdentities.items.[INDEX].customFields.additionalProperties","typeLabel":"any"},"uniqueKey":"permanentIdentities.items.[INDEX].customFields","typeLabel":"object"},"startsAt":{"type":"string","format":"date-time","description":"If absent, the current value is kept.","uniqueKey":"permanentIdentities.items.[INDEX].startsAt","typeLabel":"string\u003cdate-time>"},"endsAt":{"oneOf":[{"type":"string","format":"date-time","description":"If absent, the current value is kept. Null means no end date (indefinite).","uniqueKey":"permanentIdentities.items.[INDEX].endsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"If absent, the current value is kept. Null means no end date (indefinite).","uniqueKey":"permanentIdentities.items.[INDEX].endsAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"permanentIdentities.items.[INDEX].endsAt","typeLabel":"string\u003cdate-time> | null"},"accessProfiles":{"type":"array","items":{"type":"object","properties":{"accessProfileGroupSourceId":{"type":"string","description":"Your ID of the access profile group, as configured in your integration.","isRequired":true,"uniqueKey":"permanentIdentities.items.[INDEX].accessProfiles.items.[INDEX].accessProfileGroupSourceId","typeLabel":"string"},"sourceId":{"type":"string","description":"The ID of the profile in the access control system.","isRequired":true,"uniqueKey":"permanentIdentities.items.[INDEX].accessProfiles.items.[INDEX].sourceId","typeLabel":"string"}},"required":["accessProfileGroupSourceId","sourceId"],"uniqueKey":"permanentIdentities.items.[INDEX].accessProfiles.items.[INDEX]","typeLabel":"object"},"description":"Absent = assignments unchanged; present = replaces the identity's full assignment set within groups the caller has a mapping for ([] removes all of them); assignments in other groups are untouched. Unresolvable entries are dropped and reported via PARTIAL_SUCCESS_UNKNOWN_ACCESS_PROFILES - the rest of the item, including removals, is still applied.","uniqueKey":"permanentIdentities.items.[INDEX].accessProfiles","typeLabel":"object[]"},"deletedAt":{"type":"string","format":"date-time","description":"If set, the identity is deleted and its access revoked.","uniqueKey":"permanentIdentities.items.[INDEX].deletedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"permanentIdentities.items.[INDEX]","typeLabel":"object"},"maxItems":200,"isRequired":true,"uniqueKey":"permanentIdentities","typeLabel":"object[]"}},"required":["permanentIdentities"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"permanentIdentities":[{"sourceId":"\u003cstring>","email":"\u003cstring>","firstName":"\u003cstring>","lastName":"\u003cstring>","companyName":"\u003cstring>","customFields":{},"startsAt":"2023-11-07T05:31:56Z","endsAt":"2023-11-07T05:31:56Z","accessProfiles":[{"accessProfileGroupSourceId":"\u003cstring>","sourceId":"\u003cstring>"}],"deletedAt":"2023-11-07T05:31:56Z"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"e122639d-6564-4712-a026-546db33862e4":{"description":"The request has succeeded.","content":{"application/json":{"schema":{"type":"object","properties":{"permanentIdentities":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","PARTIAL_SUCCESS_UNKNOWN_ACCESS_PROFILES","ERROR_EMAIL_ALREADY_IN_USE","ERROR_MISSING_REQUIRED_FIELDS"],"isRequired":true,"uniqueKey":"permanentIdentities.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"sourceId":{"type":"string","uniqueKey":"permanentIdentities.items.[INDEX].sourceId","typeLabel":"string"},"email":{"type":"string","uniqueKey":"permanentIdentities.items.[INDEX].email","typeLabel":"string"},"unknownAccessProfiles":{"type":"array","items":{"type":"object","properties":{"accessProfileGroupSourceId":{"type":"string","isRequired":true,"uniqueKey":"permanentIdentities.items.[INDEX].unknownAccessProfiles.items.[INDEX].accessProfileGroupSourceId","typeLabel":"string"},"sourceId":{"type":"string","isRequired":true,"uniqueKey":"permanentIdentities.items.[INDEX].unknownAccessProfiles.items.[INDEX].sourceId","typeLabel":"string"}},"required":["accessProfileGroupSourceId","sourceId"],"uniqueKey":"permanentIdentities.items.[INDEX].unknownAccessProfiles.items.[INDEX]","typeLabel":"object"},"description":"Entries that could not be resolved and were dropped; the rest of the item was applied.","uniqueKey":"permanentIdentities.items.[INDEX].unknownAccessProfiles","typeLabel":"object[]"}},"required":["status"],"uniqueKey":"permanentIdentities.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"permanentIdentities","typeLabel":"object[]"}},"required":["permanentIdentities"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"permanentIdentities":[{"status":"SUCCESS","sourceId":"\u003cstring>","email":"\u003cstring>","unknownAccessProfiles":[{"accessProfileGroupSourceId":"\u003cstring>","sourceId":"\u003cstring>"}]}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c6d58f20-2415-43a8-aee6-309f1df54e0e":{"BearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"41c52938-f232-49d9-9aff-cbcd678d040c":{"url":"https://app.essentry.com/api/v2","description":"essentry Cloud","variables":{}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"essentry","siteName":"essentry Integration Portal","title":"Synchronize Permanent Identities - essentry Integration Portal","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-29T11:18:57.727Z","originalFileLocation":"api-reference/permanent-identities/synchronize-permanent-identities.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";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=\"dark\"}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=\"Patch semantics (absent/null = unchanged, \u0026quot;\u0026quot; clears). Upserts by sourceId, falling back to email; when matched by email, the email can\u0026#x27;t be changed. Applies to the token\u0026#x27;s own company only.\">\u003cmeta data-mint-head name=\"application-name\" content=\"essentry Integration Portal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/essentry/ABfbCHGU8h8V8feF/_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/essentry/ABfbCHGU8h8V8feF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/essentry/ABfbCHGU8h8V8feF/_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/essentry/ABfbCHGU8h8V8feF/_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/essentry/ABfbCHGU8h8V8feF/_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/essentry/ABfbCHGU8h8V8feF/_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/essentry/ABfbCHGU8h8V8feF/_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/essentry/ABfbCHGU8h8V8feF/_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/essentry/ABfbCHGU8h8V8feF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Synchronize Permanent Identities - essentry Integration Portal\">\u003cmeta data-mint-head property=\"og:description\" content=\"Patch semantics (absent/null = unchanged, \u0026quot;\u0026quot; clears). Upserts by sourceId, falling back to email; when matched by email, the email can\u0026#x27;t be changed. Applies to the token\u0026#x27;s own company only.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"essentry Integration Portal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://integrate.essentry.com/api-reference/permanent-identities/synchronize-permanent-identities\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://essentry.mintlify.app/_mintlify/api/og/v2?division=Permanent+Identities\u0026amp;title=Synchronize+Permanent+Identities\u0026amp;description=Patch+semantics+%28absent%2Fnull+%3D+unchanged%2C+%22%22+clears%29.+Upserts+by+sourceId%2C+falling+back+to+email%3B+when+matched+by+email%2C+the+email+can%27t+be+changed.+Applies+to+\u0026amp;theme=771f43cc910f664db1dc2caf\u0026amp;signature=ed22af081a1c9313b4499cdc4cc7ef016809ef5a2a8344a617e162c62387d25a\">\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=\"Synchronize Permanent Identities - essentry Integration Portal\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Patch semantics (absent/null = unchanged, \u0026quot;\u0026quot; clears). Upserts by sourceId, falling back to email; when matched by email, the email can\u0026#x27;t be changed. Applies to the token\u0026#x27;s own company only.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://essentry.mintlify.app/_mintlify/api/og/v2?division=Permanent+Identities\u0026amp;title=Synchronize+Permanent+Identities\u0026amp;description=Patch+semantics+%28absent%2Fnull+%3D+unchanged%2C+%22%22+clears%29.+Upserts+by+sourceId%2C+falling+back+to+email%3B+when+matched+by+email%2C+the+email+can%27t+be+changed.+Applies+to+\u0026amp;theme=771f43cc910f664db1dc2caf\u0026amp;signature=ed22af081a1c9313b4499cdc4cc7ef016809ef5a2a8344a617e162c62387d25a\">\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/essentry/ABfbCHGU8h8V8feF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"essentry Integration Portal\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#045dd9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://integrate.essentry.com/api-reference/permanent-identities/synchronize-permanent-identities\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/permanent-identities/synchronize-permanent-identities.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://integrate.essentry.com/#organization\",\"name\":\"essentry Integration Portal\",\"url\":\"https://integrate.essentry.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/essentry/7q4HEkq-dIzvu0DP/assets/logo-dark.svg?fit=max\u0026auto=format\u0026n=7q4HEkq-dIzvu0DP\u0026q=85\u0026s=bbe86a1ea80a23f4bd79bb95f3fa2c69\"}},{\"@type\":\"WebSite\",\"@id\":\"https://integrate.essentry.com#website\",\"name\":\"essentry Integration Portal\",\"url\":\"https://integrate.essentry.com\",\"publisher\":{\"@id\":\"https://integrate.essentry.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://integrate.essentry.com/api-reference/permanent-identities/synchronize-permanent-identities#webpage\",\"url\":\"https://integrate.essentry.com/api-reference/permanent-identities/synchronize-permanent-identities\",\"name\":\"Synchronize Permanent Identities\",\"description\":\"Patch semantics (absent/null = unchanged, \\\"\\\" clears). Upserts by sourceId, falling back to email; when matched by email, the email can't be changed. Applies to the token's own company only.\",\"dateModified\":\"2026-07-29T11:18:57.727Z\",\"isPartOf\":{\"@id\":\"https://integrate.essentry.com#website\"},\"breadcrumb\":{\"@id\":\"https://integrate.essentry.com/api-reference/permanent-identities/synchronize-permanent-identities#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://integrate.essentry.com/api-reference/permanent-identities/synchronize-permanent-identities#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Permanent Identities\",\"item\":\"https://integrate.essentry.com/api-reference/permanent-identities/get-permanent-identities\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Synchronize Permanent Identities\",\"item\":\"https://integrate.essentry.com/api-reference/permanent-identities/synchronize-permanent-identities\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://integrate.essentry.com/api-reference/permanent-identities/synchronize-permanent-identities#apireference\",\"headline\":\"Synchronize Permanent Identities\",\"name\":\"Synchronize Permanent Identities\",\"description\":\"Patch semantics (absent/null = unchanged, \\\"\\\" clears). Upserts by sourceId, falling back to email; when matched by email, the email can't be changed. Applies to the token's own company only.\",\"url\":\"https://integrate.essentry.com/api-reference/permanent-identities/synchronize-permanent-identities\",\"mainEntityOfPage\":{\"@id\":\"https://integrate.essentry.com/api-reference/permanent-identities/synchronize-permanent-identities#webpage\"},\"dateModified\":\"2026-07-29T11:18:57.727Z\",\"publisher\":{\"@id\":\"https://integrate.essentry.com/#organization\"},\"isPartOf\":{\"@id\":\"https://integrate.essentry.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"essentry Integration Portal\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"essentry Integration Portal","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":null,"href":"/api-reference/authentication"},{"title":null,"href":"/api-reference/pagination"}]},{"group":"Pre-Processor","pages":[{"openapi":"api-reference/openapi.yaml put /events","title":"Synchronize Events and Invitations","href":"/api-reference/pre-processor/synchronize-events-and-invitations"}]},{"group":"Post-Processor","pages":[{"openapi":"api-reference/openapi.yaml get /locations/{locationId}/invitations","title":"Get Upcoming Invitations","href":"/api-reference/post-processor/get-upcoming-invitations"},{"openapi":"api-reference/openapi.yaml get /locations/{locationId}/check-ins","title":"Get Current and Past Check-Ins","href":"/api-reference/post-processor/get-current-and-past-check-ins"},{"openapi":"api-reference/openapi.yaml post /check-ins/transitions","title":"Transition Check-In","href":"/api-reference/post-processor/transition-check-in"}]},{"group":"Access Control","pages":[{"openapi":"api-reference/openapi.yaml get /access-control/access-profile-groups","title":"Get Access Profile Groups","href":"/api-reference/access-control/get-access-profile-groups"},{"openapi":"api-reference/openapi.yaml get /access-control/access-profile-groups/{sourceId}/access-profiles","title":"Get Access Profiles","href":"/api-reference/access-control/get-access-profiles"},{"openapi":"api-reference/openapi.yaml put /access-control/access-profile-groups/{sourceId}/access-profiles","title":"Upload Access Profiles","href":"/api-reference/access-control/upload-access-profiles"}]},{"group":"User Provisioning","pages":[{"openapi":"api-reference/openapi.yaml get /users","title":"Get Users","href":"/api-reference/user-provisioning/get-users"}]},{"group":"Permanent Identities","pages":[{"openapi":"api-reference/openapi.yaml get /permanent-identities","title":"Get Permanent Identities","description":null,"href":"/api-reference/permanent-identities/get-permanent-identities"},{"openapi":"api-reference/openapi.yaml put /permanent-identities","title":"Synchronize Permanent Identities","href":"/api-reference/permanent-identities/synchronize-permanent-identities"}]}]}]},"title":"Synchronize Permanent Identities - essentry Integration Portal","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}