Updates a resource by its external ID. This is an incremental update, only provided fields will be updated. Fields not included in the request are left unchanged. Null values will explicitly delete the field (required fields cannot be deleted and will return a validation error).
Whether to allow extra fields that are not defined in the schema. If true, extra fields will be accepted but not saved. If false, requests with extra fields will be rejected.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Reach Marketing \u0026 Automation Documentation","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/reach/VGl-b8qK8JmS6Tpg/logo/reach-logo.svg?fit=max\u0026auto=format\u0026n=VGl-b8qK8JmS6Tpg\u0026q=85\u0026s=d233fb37e119c10d0b620741f92a401d","dark":"https://mintcdn.com/reach/VGl-b8qK8JmS6Tpg/logo/reach-logo.svg?fit=max\u0026auto=format\u0026n=VGl-b8qK8JmS6Tpg\u0026q=85\u0026s=d233fb37e119c10d0b620741f92a401d"},"favicon":"https://mintcdn.com/reach/ol2jimDngsGIddSy/favicon.ico?fit=max\u0026auto=format\u0026n=ol2jimDngsGIddSy\u0026q=85\u0026s=4c7acb93bfaae0adf61e04bedfb56dff","navbar":{"links":[{"href":"mailto:support@embedreach.com","label":"Support"}],"primary":{"type":"button","label":"Home","href":"https://embedreach.com"}},"footer":{},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"reach","hasAudioNarration":false,"actualSubdomain":"reach","customDomains":["docs.embedreach.com"],"gitSource":{"type":"github","owner":"embedreach","repo":"reach-mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aecf5a791d42fb92d276392","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API Reference","count":126},{"language":"default","tag":"API Documentation","count":126},{"language":"default","tag":"Documentation","count":41},{"language":"default","tag":"Default Partner Resources","count":25},{"language":"default","tag":"Core Products","count":19},{"language":"default","tag":"Implementation","count":17},{"language":"default","tag":"Segments","count":14},{"language":"default","tag":"Onboarding","count":14},{"language":"default","tag":"Integration Guide","count":13},{"language":"default","tag":"Engage","count":11}]},"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":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":".card-container{display:flex;flex-direction:column;height:100%;min-height:150px;position:relative}.card-content{flex-grow:1;margin-bottom:40px}.status-container{position:absolute;bottom:16px;left:0;width:100%}.developer-card{min-height:100px}.table-status{display:inline-block;text-align:center}.status-pill-wrapper{margin-top:8px;display:inline-block}.live-pill{background-color:#d1fae5;color:#065f46;font-size:0.75rem;font-weight:500;padding:0.25rem 0.625rem;border-radius:9999px}.beta-pill{background-color:#dbeafe;color:#1e40af;font-size:0.75rem;font-weight:500;padding:0.25rem 0.625rem;border-radius:9999px}.alpha-pill{background-color:#fef3c7;color:#92400e;font-size:0.75rem;font-weight:500;padding:0.25rem 0.625rem;border-radius:9999px}.inquire-pill{background-color:#dfafff;color:#000000;font-size:0.75rem;font-weight:500;padding:0.25rem 0.625rem;border-radius:9999px}"}],"page":{"pagePath":"api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid","slug":"/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid","pageMetadata":{"title":"Patch Resource","openapi":"PATCH /api/resources/{schemaDefinitionNameOrId}/{externalId}","description":"Updates a resource by its external ID. This is an incremental update, only provided fields will be updated. Fields not included in the request are left unchanged. Null values will explicitly delete the field (required fields cannot be deleted and will return a validation error).","href":"/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid"},"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: \"Updates a resource by its external ID. This is an incremental update, only provided fields will be updated. Fields not included in the request are left unchanged. Null values will explicitly delete the field (required fields cannot be deleted and will return a validation error).\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Patch Resource","openapi":"PATCH /api/resources/{schemaDefinitionNameOrId}/{externalId}","description":"Updates a resource by its external ID. This is an incremental update, only provided fields will be updated. Fields not included in the request are left unchanged. Null values will explicitly delete the field (required fields cannot be deleted and will return a validation error).","href":"/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Patch Resource","description":"Updates a resource by its external ID. This is an incremental update, only provided fields will be updated. Fields not included in the request are left unchanged. Null values will explicitly delete the field (required fields cannot be deleted and will return a validation error).","tags":["Partner Resources"],"parameters":["98325ce5-5fea-4402-8d1c-f0905663de28","61f4dd49-beed-4617-8835-1b32d6a9ecb0","9583fe31-4c69-412d-aa89-f2c941cd212e","e8dabec7-6df1-4121-b027-02a6c29c9e57"],"requestBody":"bbdcc05f-0e0a-4810-bd7b-3934108cc3bc","responses":{"200":"db134639-7c22-4e0d-be67-a694371cabcb","400":"37c6b957-173c-4f70-aef3-c9599cc7631b","404":"ca467113-a687-4b63-9b4d-f9cceefb0e17"},"method":"patch","type":"path","servers":["735193de-6fcf-4c37-a982-4271aee06047"],"security":[],"path":"/api/resources/{schemaDefinitionNameOrId}/{externalId}","baseUrlOptions":["https://api.embedreach.com"],"title":"Patch Resource","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"98325ce5-5fea-4402-8d1c-f0905663de28":{"name":"reach-tenant-id","in":"header","required":false,"schema":{"type":"string","description":"If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.","isRequired":false,"uniqueKey":"","typeLabel":"string"}},"61f4dd49-beed-4617-8835-1b32d6a9ecb0":{"schema":{"type":"string","description":"The name or id of the schema definition for the resource being updated","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"The name or id of the schema definition for the resource being updated","name":"schemaDefinitionNameOrId","in":"path"},"9583fe31-4c69-412d-aa89-f2c941cd212e":{"schema":{"type":"string","description":"The external ID of the resource to update","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"The external ID of the resource to update","name":"externalId","in":"path"},"e8dabec7-6df1-4121-b027-02a6c29c9e57":{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Whether to allow extra fields that are not defined in the schema. If true, extra fields will be accepted but not saved. If false, requests with extra fields will be rejected.","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"description":"Whether to allow extra fields that are not defined in the schema. If true, extra fields will be accepted but not saved. If false, requests with extra fields will be rejected.","name":"ignoreUnknownFields","in":"query"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"data.additionalProperties","typeLabel":"any"},"description":"Resource data matching its schema definition","isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"db134639-7c22-4e0d-be67-a694371cabcb":{"description":"Status 200 response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the resource","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"schema_definition_id":{"type":"string","format":"uuid","description":"[Deprecated] Please use schemaDefinitionId instead. ID of the schema definition for this resource","isRequired":true,"uniqueKey":"data.schema_definition_id","typeLabel":"string\u003cuuid>"},"schemaDefinitionId":{"type":"string","format":"uuid","description":"ID of the schema definition for this resource","isRequired":true,"uniqueKey":"data.schemaDefinitionId","typeLabel":"string\u003cuuid>"},"platform_id":{"type":"string","format":"uuid","description":"[Deprecated] Please use platformId instead. ID of the platform this resource belongs to","isRequired":true,"uniqueKey":"data.platform_id","typeLabel":"string\u003cuuid>"},"platformId":{"type":"string","format":"uuid","description":"ID of the platform this resource belongs to","isRequired":true,"uniqueKey":"data.platformId","typeLabel":"string\u003cuuid>"},"business_id":{"type":"string","format":"uuid","description":"[Deprecated] Please use businessId instead. ID of the business this resource belongs to","isRequired":true,"uniqueKey":"data.business_id","typeLabel":"string\u003cuuid>"},"businessId":{"type":"string","format":"uuid","description":"ID of the business this resource belongs to","isRequired":true,"uniqueKey":"data.businessId","typeLabel":"string\u003cuuid>"},"resource_external_id":{"type":"string","description":"External ID of the resource","isRequired":true,"uniqueKey":"data.resource_external_id","typeLabel":"string"},"resourceExternalId":{"type":"string","description":"[Deprecated] Please use resourceExternalId instead. External ID of the resource","isRequired":true,"uniqueKey":"data.resourceExternalId","typeLabel":"string"},"created_at":{"type":"string","description":"[Deprecated] Please use createdAt instead","isRequired":true,"uniqueKey":"data.created_at","typeLabel":"string"},"createdAt":{"type":"string","description":"Creation timestamp","isRequired":true,"uniqueKey":"data.createdAt","typeLabel":"string"},"updated_at":{"type":"string","description":"[Deprecated] Please use updatedAt instead","isRequired":true,"uniqueKey":"data.updated_at","typeLabel":"string"},"updatedAt":{"type":"string","description":"Last update timestamp","isRequired":true,"uniqueKey":"data.updatedAt","typeLabel":"string"},"data":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"data.data.additionalProperties","typeLabel":"any"},"description":"Resource data matching its schema definition","isRequired":true,"uniqueKey":"data.data","typeLabel":"object"}},"required":["id","schema_definition_id","schemaDefinitionId","platform_id","platformId","business_id","businessId","resource_external_id","resourceExternalId","created_at","createdAt","updated_at","updatedAt","data"],"uniqueKey":"data","typeLabel":"object"}},"required":["success"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","schema_definition_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","schemaDefinitionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","platform_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","platformId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","business_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","businessId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","resource_external_id":"\u003cstring>","resourceExternalId":"\u003cstring>","created_at":"\u003cstring>","createdAt":"\u003cstring>","updated_at":"\u003cstring>","updatedAt":"\u003cstring>","data":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"37c6b957-173c-4f70-aef3-c9599cc7631b":{"description":"Bad Request - Validation or request error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing what went wrong","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","enum":[false],"default":false,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"description":"Optional array of specific validation errors","uniqueKey":"errors","typeLabel":"string[]"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","success":false,"errors":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"ca467113-a687-4b63-9b4d-f9cceefb0e17":{"description":"Status 404 response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"data.error","typeLabel":"string"}},"required":["error"],"uniqueKey":"data","typeLabel":"object"}},"required":["success"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","data":{"error":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"735193de-6fcf-4c37-a982-4271aee06047":{"url":"https://api.embedreach.com","description":"Production server"}}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"reach","siteName":"Reach Marketing \u0026 Automation Documentation","title":"Patch Resource - Reach Marketing \u0026 Automation Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-28T21:44:11.387Z","originalFileLocation":"api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid.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 a resource by its external ID. This is an incremental update, only provided fields will be updated. Fields not included in the request are left unchanged. Null values will explicitly delete the field (required fields cannot be deleted and will return a validation error).\">\u003cmeta data-mint-head name=\"application-name\" content=\"Reach Marketing \u0026amp; Automation 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/reach/Xd06gTcEFFBFlU7h/_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/reach/Xd06gTcEFFBFlU7h/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/reach/Xd06gTcEFFBFlU7h/_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/reach/Xd06gTcEFFBFlU7h/_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/reach/Xd06gTcEFFBFlU7h/_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/reach/Xd06gTcEFFBFlU7h/_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/reach/Xd06gTcEFFBFlU7h/_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/reach/Xd06gTcEFFBFlU7h/_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/reach/Xd06gTcEFFBFlU7h/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Patch Resource - Reach Marketing \u0026amp; Automation Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates a resource by its external ID. This is an incremental update, only provided fields will be updated. Fields not included in the request are left unchanged. Null values will explicitly delete the field (required fields cannot be deleted and will return a validation error).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Reach Marketing \u0026amp; Automation Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://reach.mintlify.site/_mintlify/api/og/v2?division=Partner+Resources\u0026amp;title=Patch+Resource\u0026amp;description=Updates+a+resource+by+its+external+ID.+This+is+an+incremental+update%2C+only+provided+fields+will+be+updated.+Fields+not+included+in+the+request+are+left+unchange\u0026amp;theme=5c8a24ad9fda3a72fa22f0c7\u0026amp;signature=c34af33a2f665dc60d005d77c3aff9e4a28bb5a9abb84589e807acf3447ce644\">\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=\"Patch Resource - Reach Marketing \u0026amp; Automation Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates a resource by its external ID. This is an incremental update, only provided fields will be updated. Fields not included in the request are left unchanged. Null values will explicitly delete the field (required fields cannot be deleted and will return a validation error).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://reach.mintlify.site/_mintlify/api/og/v2?division=Partner+Resources\u0026amp;title=Patch+Resource\u0026amp;description=Updates+a+resource+by+its+external+ID.+This+is+an+incremental+update%2C+only+provided+fields+will+be+updated.+Fields+not+included+in+the+request+are+left+unchange\u0026amp;theme=5c8a24ad9fda3a72fa22f0c7\u0026amp;signature=c34af33a2f665dc60d005d77c3aff9e4a28bb5a9abb84589e807acf3447ce644\">\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/reach/Xd06gTcEFFBFlU7h/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Reach Marketing \u0026amp; Automation Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.embedreach.com/#organization\",\"name\":\"Reach Marketing \u0026 Automation Documentation\",\"url\":\"https://docs.embedreach.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/reach/VGl-b8qK8JmS6Tpg/logo/reach-logo.svg?fit=max\u0026auto=format\u0026n=VGl-b8qK8JmS6Tpg\u0026q=85\u0026s=d233fb37e119c10d0b620741f92a401d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.embedreach.com#website\",\"name\":\"Reach Marketing \u0026 Automation Documentation\",\"url\":\"https://docs.embedreach.com\",\"publisher\":{\"@id\":\"https://docs.embedreach.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid#webpage\",\"url\":\"https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid\",\"name\":\"Patch Resource\",\"description\":\"Updates a resource by its external ID. This is an incremental update, only provided fields will be updated. Fields not included in the request are left unchanged. Null values will explicitly delete the field (required fields cannot be deleted and will return a validation error).\",\"dateModified\":\"2026-01-28T21:44:11.387Z\",\"isPartOf\":{\"@id\":\"https://docs.embedreach.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Documentation\",\"item\":\"https://docs.embedreach.com/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Partner Resources\",\"item\":\"https://docs.embedreach.com/api-reference/endpoint/delete-api-resources-schemadefinitionnameorid-batch\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Patch Resource\",\"item\":\"https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid#apireference\",\"headline\":\"Patch Resource\",\"name\":\"Patch Resource\",\"description\":\"Updates a resource by its external ID. This is an incremental update, only provided fields will be updated. Fields not included in the request are left unchanged. Null values will explicitly delete the field (required fields cannot be deleted and will return a validation error).\",\"url\":\"https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid\",\"mainEntityOfPage\":{\"@id\":\"https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid#webpage\"},\"dateModified\":\"2026-01-28T21:44:11.387Z\",\"publisher\":{\"@id\":\"https://docs.embedreach.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.embedreach.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Reach Marketing \u0026 Automation Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Reach Marketing \u0026 Automation Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/home/welcome"}]},{"tab":"Onboarding","pages":[{"title":"Onboarding","href":"/onboarding/overview"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"group":"Automation Categories","pages":[{"title":"Delete an automation category","openapi":"DELETE /partner/automation-categories/{id}","href":"/api-reference/endpoint/delete-partner-automation-categories-id"},{"title":"Get partner automation categories","href":"/api-reference/endpoint/get-partner-automation-categories"},{"title":"Get automation category usage","openapi":"GET /partner/automation-categories/{id}/usage","href":"/api-reference/endpoint/get-partner-automation-categories-id-usage"},{"title":"Get automation template categories","openapi":"GET /partner/automation-templates/{templateId}/categories","href":"/api-reference/endpoint/get-partner-automation-templates-templateid-categories"},{"title":"Update an automation category","openapi":"PATCH /partner/automation-categories/{id}","href":"/api-reference/endpoint/patch-partner-automation-categories-id"},{"title":"Create an automation category","openapi":"POST /partner/automation-categories","href":"/api-reference/endpoint/post-partner-automation-categories"},{"title":"Put partner automation templates templateid categories","href":"/api-reference/endpoint/put-partner-automation-templates-templateid-categories"}]},{"group":"Automation Templates","pages":[{"title":"Overview","href":"/api-reference/endpoint/automation-templates-introduction"},{"title":"List automation templates","openapi":"GET /partner/automation-templates","href":"/api-reference/endpoint/get-partner-automation-templates"},{"title":"Get automation template by ID","openapi":"GET /partner/automation-templates/{id}","href":"/api-reference/endpoint/get-partner-automation-templates-id"},{"title":"Get automation template sync","openapi":"GET /partner/automation-templates/{id}/syncs/{jobId}","href":"/api-reference/endpoint/get-partner-automation-templates-id-syncs-jobid"},{"title":"Update automation template","openapi":"PATCH /partner/automation-templates/{id}","href":"/api-reference/endpoint/patch-partner-automation-templates-id"},{"title":"Create automation template","openapi":"POST /partner/automation-templates","href":"/api-reference/endpoint/post-partner-automation-templates"},{"title":"Copy an automation template","openapi":"POST /partner/automation-templates/{id}/copy","href":"/api-reference/endpoint/post-partner-automation-templates-id-copy"},{"title":"Post partner automation templates id syncs","href":"/api-reference/endpoint/post-partner-automation-templates-id-syncs"}]},{"group":"Batch Operations","pages":[{"title":"List Batch Jobs","openapi":"GET /api/batches","href":"/api-reference/endpoint/get-api-batches"},{"title":"Get Batch Status","openapi":"GET /api/batches/{batchId}","href":"/api-reference/endpoint/get-api-batches-batchid"}]},{"group":"Channel Accounts","pages":[{"title":"List Channel Accounts","openapi":"GET /api/channel/accounts","href":"/api-reference/endpoint/get-api-channel-accounts"},{"title":"Update Channel Account","openapi":"PATCH /api/channel/accounts/{id}","href":"/api-reference/endpoint/patch-api-channel-accounts-id"},{"title":"Create Channel Account","openapi":"POST /api/channel/accounts","href":"/api-reference/endpoint/post-api-channel-accounts"}]},{"group":"Channel Integrations","pages":[{"title":"List Channel Integrations","openapi":"GET /partner/channel/integrations","href":"/api-reference/endpoint/get-partner-channel-integrations"},{"title":"Update Channel Integration","openapi":"PATCH /partner/channel/integrations/{id}","href":"/api-reference/endpoint/patch-partner-channel-integrations-id"},{"title":"Create Channel Integration","openapi":"POST /partner/channel/integrations","href":"/api-reference/endpoint/post-partner-channel-integrations"}]},{"group":"Channel Senders","pages":[{"title":"List Channel Senders","openapi":"GET /api/channel/senders","href":"/api-reference/endpoint/get-api-channel-senders"},{"title":"Update Channel Sender","openapi":"PATCH /api/channel/senders/{id}","href":"/api-reference/endpoint/patch-api-channel-senders-id"},{"title":"Create Channel Sender","openapi":"POST /api/channel/senders","href":"/api-reference/endpoint/post-api-channel-senders"}]},{"group":"Communication Groups","pages":[{"title":"List Communication Groups","openapi":"GET /api/communication-groups","href":"/api-reference/endpoint/get-api-communication-groups"},{"title":"Get Link Click Statistics","openapi":"GET /api/communication-groups/{automationId}/link-click-stats","href":"/api-reference/endpoint/get-api-communication-groups-automationid-link-click-stats"},{"title":"Get Communication Group","openapi":"GET /api/communication-groups/{id}","href":"/api-reference/endpoint/get-api-communication-groups-id"},{"title":"Get Available Merge Fields","openapi":"GET /api/communication-groups/{id}/merge-fields","href":"/api-reference/endpoint/get-api-communication-groups-id-merge-fields"},{"title":"Update Communication Group","openapi":"PATCH /api/communication-groups/{id}","href":"/api-reference/endpoint/patch-api-communication-groups-id"},{"title":"Create Communication Group","openapi":"POST /api/communication-groups","href":"/api-reference/endpoint/post-api-communication-groups"},{"title":"Reset Communication Group to Default Template","openapi":"POST /api/communication-groups/{communicationGroupId}/{automationId}/reset","href":"/api-reference/endpoint/post-api-communication-groups-communicationgroupid-automationid-reset"},{"title":"Send Test Email/SMS","openapi":"POST /api/communication-groups/{id}/test","href":"/api-reference/endpoint/post-api-communication-groups-id-test"},{"title":"Save Email Auto-Save","openapi":"PUT /api/communication-groups/{id}/email-auto-save","href":"/api-reference/endpoint/put-api-communication-groups-id-email-auto-save"}]},{"group":"Default Partner Resources","pages":[{"title":"Default Partner Resources","href":"/api-reference/endpoint/default-partner-resources-introduction"},{"title":"Batch Delete Customer Resources","openapi":"DELETE /api/resources/customers/batch","href":"/api-reference/endpoint/delete-api-resources-customers-batch"},{"title":"Delete Customer Resource","openapi":"DELETE /api/resources/customers/{externalId}","href":"/api-reference/endpoint/delete-api-resources-customers-externalid"},{"title":"Batch Delete Location Resources","openapi":"DELETE /api/resources/locations/batch","href":"/api-reference/endpoint/delete-api-resources-locations-batch"},{"title":"Delete Location Resource","openapi":"DELETE /api/resources/locations/{externalId}","href":"/api-reference/endpoint/delete-api-resources-locations-externalid"},{"title":"Batch Delete Transaction Resources","openapi":"DELETE /api/resources/transactions/batch","href":"/api-reference/endpoint/delete-api-resources-transactions-batch"},{"title":"Delete Transaction Resource","openapi":"DELETE /api/resources/transactions/{externalId}","href":"/api-reference/endpoint/delete-api-resources-transactions-externalid"},{"title":"List Customer Resources","openapi":"GET /api/resources/customers","href":"/api-reference/endpoint/get-api-resources-customers"},{"title":"Get Customer Resource","openapi":"GET /api/resources/customers/{externalId}","href":"/api-reference/endpoint/get-api-resources-customers-externalid"},{"title":"List Location Resources","openapi":"GET /api/resources/locations","href":"/api-reference/endpoint/get-api-resources-locations"},{"title":"Get Location Resource","openapi":"GET /api/resources/locations/{externalId}","href":"/api-reference/endpoint/get-api-resources-locations-externalid"},{"title":"List Transaction Resources","openapi":"GET /api/resources/transactions","href":"/api-reference/endpoint/get-api-resources-transactions"},{"title":"Get Transaction Resource","openapi":"GET /api/resources/transactions/{externalId}","href":"/api-reference/endpoint/get-api-resources-transactions-externalid"},{"title":"Batch Patch Customer Resources","openapi":"PATCH /api/resources/customers/batch","href":"/api-reference/endpoint/patch-api-resources-customers-batch"},{"title":"Patch Customer Resource","openapi":"PATCH /api/resources/customers/{externalId}","href":"/api-reference/endpoint/patch-api-resources-customers-externalid"},{"title":"Batch Patch Location Resources","openapi":"PATCH /api/resources/locations/batch","href":"/api-reference/endpoint/patch-api-resources-locations-batch"},{"title":"Patch Location Resource","openapi":"PATCH /api/resources/locations/{externalId}","href":"/api-reference/endpoint/patch-api-resources-locations-externalid"},{"title":"Batch Patch Transaction Resources","openapi":"PATCH /api/resources/transactions/batch","href":"/api-reference/endpoint/patch-api-resources-transactions-batch"},{"title":"Patch Transaction Resource","openapi":"PATCH /api/resources/transactions/{externalId}","href":"/api-reference/endpoint/patch-api-resources-transactions-externalid"},{"title":"Create Customer Resource","openapi":"POST /api/resources/customers","href":"/api-reference/endpoint/post-api-resources-customers"},{"title":"Batch Upload Customer Resources","openapi":"POST /api/resources/customers/batch","href":"/api-reference/endpoint/post-api-resources-customers-batch"},{"title":"Create Location Resource","openapi":"POST /api/resources/locations","href":"/api-reference/endpoint/post-api-resources-locations"},{"title":"Batch Upload Location Resources","openapi":"POST /api/resources/locations/batch","href":"/api-reference/endpoint/post-api-resources-locations-batch"},{"title":"Create Transaction Resource","openapi":"POST /api/resources/transactions","href":"/api-reference/endpoint/post-api-resources-transactions"},{"title":"Batch Upload Transaction Resources","openapi":"POST /api/resources/transactions/batch","href":"/api-reference/endpoint/post-api-resources-transactions-batch"}]},{"group":"Engage Library","pages":[{"title":"Get partner engage library tenantid","href":"/api-reference/endpoint/get-partner-engage-library-tenantid"},{"title":"Get Tenant Engage Library Sync Status","openapi":"GET /partner/engage-library/{tenantId}/jobs/{jobId}","href":"/api-reference/endpoint/get-partner-engage-library-tenantid-jobs-jobid"},{"title":"Sync Tenant Engage Library","openapi":"PATCH /partner/engage-library/{tenantId}","href":"/api-reference/endpoint/patch-partner-engage-library-tenantid"}]},{"group":"Partner DB","pages":[{"title":"Upload SQLite database for a tenant","openapi":"POST /api/partner-db/upload","href":"/api-reference/endpoint/post-api-partner-db-upload"},{"title":"Upload SQLite database (platform-wide)","openapi":"POST /partner/partner-db/upload","href":"/api-reference/endpoint/post-partner-partner-db-upload"}]},{"group":"Partner Engage","pages":[{"title":"Get Engage usage per tenant","openapi":"GET /partner/engage/tenants","href":"/api-reference/endpoint/get-partner-engage-tenants"},{"title":"Get partner-wide Engage tenant usage summary","openapi":"GET /partner/engage/tenants/summary","href":"/api-reference/endpoint/get-partner-engage-tenants-summary"}]},{"group":"Partner Resources","pages":[{"title":"Batch Delete Resources","openapi":"DELETE /api/resources/{schemaDefinitionNameOrId}/batch","href":"/api-reference/endpoint/delete-api-resources-schemadefinitionnameorid-batch"},{"title":"Delete Resource","openapi":"DELETE /api/resources/{schemaDefinitionNameOrId}/{externalId}","href":"/api-reference/endpoint/delete-api-resources-schemadefinitionnameorid-externalid"},{"title":"Get Resource Counts","openapi":"GET /api/resources/counts","href":"/api-reference/endpoint/get-api-resources-counts"},{"title":"List Resources","openapi":"GET /api/resources/{schemaDefinitionNameOrId}","href":"/api-reference/endpoint/get-api-resources-schemadefinitionnameorid"},{"title":"Get Resource","openapi":"GET /api/resources/{schemaDefinitionNameOrId}/{externalId}","href":"/api-reference/endpoint/get-api-resources-schemadefinitionnameorid-externalid"},{"title":"Get Resource Counts for All Tenants","openapi":"GET /partner/resources/counts","href":"/api-reference/endpoint/get-partner-resources-counts"},{"title":"Batch Patch Resources","openapi":"PATCH /api/resources/{schemaDefinitionNameOrId}/batch","description":"Patches multiple resources in a single batch via the event processor for asynchronous processing. Fields not included in the request are left unchanged. Null values will explicitly delete the field (required fields cannot be deleted and will return a validation error). The batch ID can be used to retrieve the status of the batch using the /api/batches/:batchId endpoint. The maximum number of resources that can be updated in a single batch is 1000.There are NO ordering guarantees across multiple batches. Within each batch, the patches for each resource are processed in the order they are received.","href":"/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-batch"},{"title":"Patch Resource","openapi":"PATCH /api/resources/{schemaDefinitionNameOrId}/{externalId}","href":"/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid"},{"title":"Upload Resource","openapi":"POST /api/resources/{schemaDefinitionNameOrId}","description":"Uploads data to the partner resource table after validating it against the specified schema definition. When upsert is enabled, new data is merged with existing data (preserving existing fields not included in the request). Null values will explicitly delete the field (required fields cannot be deleted and will return a validation error).","href":"/api-reference/endpoint/post-api-resources-schemadefinitionnameorid"},{"title":"Batch Upload Resources","openapi":"POST /api/resources/{schemaDefinitionNameOrId}/batch","href":"/api-reference/endpoint/post-api-resources-schemadefinitionnameorid-batch"}]},{"group":"Partner Voice","pages":[{"title":"Get voice call aggregates per tenant","openapi":"GET /partner/voice/calls/aggregates","href":"/api-reference/endpoint/get-partner-voice-calls-aggregates"},{"title":"Get partner-wide voice call aggregate summary","openapi":"GET /partner/voice/calls/aggregates/summary","href":"/api-reference/endpoint/get-partner-voice-calls-aggregates-summary"},{"title":"Update an active Voice call","openapi":"PATCH /partner/voice/active-calls/{callId}","href":"/api-reference/endpoint/patch-partner-voice-active-calls-callid"}]},{"group":"Schema Definitions","pages":[{"title":"Overview","href":"/api-reference/endpoint/schema-definitions-introduction"},{"title":"Deactivate Schema","openapi":"DELETE /partner/schema-definitions/{schemaIdOrName}","href":"/api-reference/endpoint/delete-partner-schema-definitions-schemaidorname"},{"title":"List Schemas","openapi":"GET /partner/schema-definitions","href":"/api-reference/endpoint/get-partner-schema-definitions"},{"title":"Get Schema","openapi":"GET /partner/schema-definitions/{schemaIdOrName}","href":"/api-reference/endpoint/get-partner-schema-definitions-schemaidorname"},{"title":"Get Schema Update","openapi":"GET /partner/schema-definitions/{schemaIdOrName}/updates/{updateId}","href":"/api-reference/endpoint/get-partner-schema-definitions-schemaidorname-updates-updateid"},{"title":"Create Schema","openapi":"POST /partner/schema-definitions","href":"/api-reference/endpoint/post-partner-schema-definitions"},{"title":"Update Schema","openapi":"POST /partner/schema-definitions/{schemaIdOrName}","href":"/api-reference/endpoint/post-partner-schema-definitions-schemaidorname"}]},{"group":"Schema Mappings","pages":[{"title":"Overview","href":"/api-reference/endpoint/schema-mappings-introduction"},{"title":"Get Partner Schema Mappings","openapi":"GET /partner/schema-mappings","href":"/api-reference/endpoint/get-partner-schema-mappings"},{"title":"Update Partner Schema Mappings","openapi":"POST /partner/schema-mappings","href":"/api-reference/endpoint/post-partner-schema-mappings"}]},{"group":"Segments","pages":[{"title":"Delete Tenant Segment","openapi":"DELETE /api/segments/{id}","href":"/api-reference/endpoint/delete-api-segments-id"},{"title":"List Tenant Segments","openapi":"GET /api/segments","href":"/api-reference/endpoint/get-api-segments"},{"title":"Get Segment Conditions","openapi":"GET /api/segments/conditions","href":"/api-reference/endpoint/get-api-segments-conditions"},{"title":"Find Segment Field Values","openapi":"GET /api/segments/field-values","href":"/api-reference/endpoint/get-api-segments-field-values"},{"title":"Get Tenant Segment","openapi":"GET /api/segments/{id}","href":"/api-reference/endpoint/get-api-segments-id"},{"title":"List Automations Using Tenant Segment","openapi":"GET /api/segments/{id}/automations","href":"/api-reference/endpoint/get-api-segments-id-automations"},{"title":"Get Users in Tenant Segment","openapi":"GET /api/segments/{id}/users","href":"/api-reference/endpoint/get-api-segments-id-users"},{"title":"Get Segment Schema Catalog","openapi":"GET /api/segments/schema-catalog","href":"/api-reference/endpoint/get-api-segments-schema-catalog"},{"title":"Get Segments by User External ID","openapi":"GET /api/segments/user/{externalId}","href":"/api-reference/endpoint/get-api-segments-user-externalid"},{"title":"Update Tenant Segment","openapi":"PATCH /api/segments/{id}","href":"/api-reference/endpoint/patch-api-segments-id"},{"title":"Create Tenant Segment","openapi":"POST /api/segments","href":"/api-reference/endpoint/post-api-segments"},{"title":"Enable Standard Google Ads Audiences","openapi":"POST /api/segments/audience-uploads/standard","href":"/api-reference/endpoint/post-api-segments-audience-uploads-standard"},{"title":"Get Count of Users in Include and Exclude Segment","openapi":"POST /api/segments/count","href":"/api-reference/endpoint/post-api-segments-count"}]},{"group":"Sending Domains","pages":[{"title":"List Sending Domains","openapi":"GET /api/sending-domains","href":"/api-reference/endpoint/get-api-sending-domains"},{"title":"Get Sending Domain","openapi":"GET /api/sending-domains/{id}","href":"/api-reference/endpoint/get-api-sending-domains-id"},{"title":"Create Sending Domain","openapi":"POST /api/sending-domains","href":"/api-reference/endpoint/post-api-sending-domains"},{"title":"Create Entri Token","openapi":"POST /api/sending-domains/entri-token","href":"/api-reference/endpoint/post-api-sending-domains-entri-token"},{"title":"Start Sending Domain Verification","openapi":"POST /api/sending-domains/{id}/verifications","href":"/api-reference/endpoint/post-api-sending-domains-id-verifications"}]},{"group":"Subscriptions","pages":[{"title":"List Subscriptions","openapi":"GET /api/subscriptions","href":"/api-reference/endpoint/get-api-subscriptions"},{"title":"Get Subscription by External ID","openapi":"GET /api/subscriptions/{externalId}","href":"/api-reference/endpoint/get-api-subscriptions-externalid"}]},{"group":"Tenant Automation","pages":[{"title":"Delete api automation categories id","href":"/api-reference/endpoint/delete-api-automation-categories-id"},{"title":"Get api automation categories","href":"/api-reference/endpoint/get-api-automation-categories"},{"title":"List Tenant Automations","openapi":"GET /api/automations","href":"/api-reference/endpoint/get-api-automations"},{"title":"Get Broadcast Experience","openapi":"GET /api/automations/has-broadcast-experience","href":"/api-reference/endpoint/get-api-automations-has-broadcast-experience"},{"title":"Get Tenant Automation","openapi":"GET /api/automations/{id}","href":"/api-reference/endpoint/get-api-automations-id"},{"title":"Get Recipients for Tenant Automation","openapi":"GET /api/automations/{id}/recipients","href":"/api-reference/endpoint/get-api-automations-id-recipients"},{"title":"Get Statistics for Tenant Automation","openapi":"GET /api/automations/{id}/statistics","href":"/api-reference/endpoint/get-api-automations-id-statistics"},{"title":"Get Statistics for All Tenant Automations","openapi":"GET /api/automations/statistics","href":"/api-reference/endpoint/get-api-automations-statistics"},{"title":"Patch api automation categories id","href":"/api-reference/endpoint/patch-api-automation-categories-id"},{"title":"Update Tenant Automation","openapi":"PATCH /api/automations/{id}","href":"/api-reference/endpoint/patch-api-automations-id"},{"title":"Post api automation categories","href":"/api-reference/endpoint/post-api-automation-categories"},{"title":"Create or Duplicate Tenant Automation","openapi":"POST /api/automations","href":"/api-reference/endpoint/post-api-automations"},{"title":"Put api automations id categories","href":"/api-reference/endpoint/put-api-automations-id-categories"}]},{"group":"Tenant Usage","pages":[{"title":"List tenant usage","openapi":"GET /partner/tenant-usage","href":"/api-reference/endpoint/get-partner-tenant-usage"},{"title":"Get usage for one tenant","openapi":"GET /partner/tenant-usage/{tenantId}","href":"/api-reference/endpoint/get-partner-tenant-usage-tenantid"}]},{"group":"Tenants","pages":[{"title":"Overview","href":"/api-reference/endpoint/tenants-introduction"},{"title":"Delete Tenant","openapi":"DELETE /partner/tenants/{id}","href":"/api-reference/endpoint/delete-partner-tenants-id"},{"title":"List Tenants","openapi":"GET /partner/tenants","href":"/api-reference/endpoint/get-partner-tenants"},{"title":"Get Tenant","openapi":"GET /partner/tenants/{id}","href":"/api-reference/endpoint/get-partner-tenants-id"},{"title":"Get Tenant Resource Statistics","openapi":"GET /partner/tenants/{id}/resource-stats","href":"/api-reference/endpoint/get-partner-tenants-id-resource-stats"},{"title":"Get SMS Registration Status","openapi":"GET /partner/tenants/{id}/sms-registration","href":"/api-reference/endpoint/get-partner-tenants-id-sms-registration"},{"title":"Update Tenant","openapi":"PATCH /partner/tenants/{id}","href":"/api-reference/endpoint/patch-partner-tenants-id"},{"title":"Create Tenant","openapi":"POST /partner/tenants","href":"/api-reference/endpoint/post-partner-tenants"},{"title":"Reactivate Tenant","openapi":"POST /partner/tenants/{id}/reactivate","href":"/api-reference/endpoint/post-partner-tenants-id-reactivate"}]}]}]}]},"basePath":"","title":"Patch Resource - Reach Marketing \u0026 Automation Documentation","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}