The external id of the business (e.g. the id you use to identify the business in your system)
website
string
The website of the business
locations
object[]
The locations of the business
Show child attributes
name
string
A friendly name for the business
branding
object | null
Optional branding information for the business
Show child attributes
dataIntegrationCompletedAt
string<date-time> | null
The date and time the business completed data integration
websiteTrackingCompletedAt
string<date-time> | null
The date and time the business completed website tracking configuration
acquireActivatedAt
string<date-time> | null
deprecated
No longer writable. Acquire activation is recorded when a tenant creates their first Reach-managed campaign; a value sent here is accepted and ignored. Still returned by Get Tenant.
timezone
string | null
The IANA timezone of the business (e.g. America/New_York). Null clears it.
businessHours
object | null
Weekly business hours. All seven weekday keys are required, and an update replaces the whole schedule. Each weekday is either null or an empty list (closed) or one opening interval with 24-hour HH:MM local times, where the opening time is inclusive and the closing time is exclusive. Null clears the schedule.
Show child attributes
uiDefaults
object
Business-specific UI defaults for dialogs and feature toggles
Show child attributes
smsOptInImageUrls
string<uri>[]
Array of URLs that demonstrate how SMS consent is obtained. Can be image URLs (screenshots) or URLs to ordering/checkout pages where consent is captured.
Response
Status 200 response
success
boolean
required
message
string
data
object
Show child attributes
{"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":"6afcc09b5cde0944f3433fb9","clientVersion":"0.0.4177","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":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","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-partner-tenants-id","slug":"/api-reference/endpoint/patch-partner-tenants-id","pageMetadata":{"title":"Update Tenant","openapi":"PATCH /partner/tenants/{id}","description":"Update a tenant","href":"/api-reference/endpoint/patch-partner-tenants-id"},"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: \"Update a tenant\"\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":"Update Tenant","openapi":"PATCH /partner/tenants/{id}","description":"Update a tenant","href":"/api-reference/endpoint/patch-partner-tenants-id"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Update Tenant","description":"Update a tenant","tags":["Tenants"],"parameters":[],"requestBody":"56a18ae4-3f1d-4b95-8d26-f5221c46f44b","responses":{"200":"cada8609-505f-4e35-b0dd-c469e687689f","400":"4b66ef1d-ee92-4c22-8eac-a20a4f5e8507"},"method":"patch","type":"path","servers":["b6698960-0146-4778-93c2-3770261e8dee"],"security":[],"path":"/partner/tenants/{id}","baseUrlOptions":["https://api.embedreach.com"],"title":"Update Tenant","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"externalId":{"type":"string","description":"The external id of the business (e.g. the id you use to identify the business in your system)","uniqueKey":"externalId","typeLabel":"string"},"website":{"type":"string","description":"The website of the business","uniqueKey":"website","typeLabel":"string"},"locations":{"type":"array","items":{"type":"object","properties":{"addressLine1":{"type":"string","isRequired":true,"uniqueKey":"locations.items.[INDEX].addressLine1","typeLabel":"string"},"locality":{"type":"string","description":"The city or town of the business (e.g. New York)","isRequired":true,"uniqueKey":"locations.items.[INDEX].locality","typeLabel":"string"},"district":{"type":"string","description":"The State (e.g. NY, CA, etc.) of the business","isRequired":true,"uniqueKey":"locations.items.[INDEX].district","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code of the business","isRequired":true,"uniqueKey":"locations.items.[INDEX].postalCode","typeLabel":"string"},"countryCode":{"type":"string","description":"The country code of the business (e.g. USA)","isRequired":true,"uniqueKey":"locations.items.[INDEX].countryCode","typeLabel":"string"},"addressLine2":{"type":"string","uniqueKey":"locations.items.[INDEX].addressLine2","typeLabel":"string"},"addressLine3":{"type":"string","uniqueKey":"locations.items.[INDEX].addressLine3","typeLabel":"string"}},"required":["addressLine1","locality","district","postalCode","countryCode"],"uniqueKey":"locations.items.[INDEX]","typeLabel":"object"},"description":"The locations of the business","uniqueKey":"locations","typeLabel":"object[]"},"name":{"type":"string","description":"A friendly name for the business","uniqueKey":"name","typeLabel":"string"},"branding":{"oneOf":[{"type":"object","properties":{"logoBase64":{"oneOf":[{"type":"string","description":"Base64 encoded logo image. We recommend 128px x 128px for best results. (either this or logoURL)","uniqueKey":"branding.oneOf.0.logoBase64.oneOf.0","typeLabel":"string"},{"type":"null","description":"Base64 encoded logo image. We recommend 128px x 128px for best results. (either this or logoURL)","uniqueKey":"branding.oneOf.0.logoBase64.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.logoBase64","typeLabel":"string | null"},"logoURL":{"oneOf":[{"type":"string","description":"Absolute URL for the brand logo. We recommend 128px x 128px for best results. (either this or logoBase64)","uniqueKey":"branding.oneOf.0.logoURL.oneOf.0","typeLabel":"string"},{"type":"null","description":"Absolute URL for the brand logo. We recommend 128px x 128px for best results. (either this or logoBase64)","uniqueKey":"branding.oneOf.0.logoURL.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.logoURL","typeLabel":"string | null"},"primaryColor":{"oneOf":[{"type":"string","description":"The primary color of the business.","uniqueKey":"branding.oneOf.0.primaryColor.oneOf.0","typeLabel":"string"},{"type":"null","description":"The primary color of the business.","uniqueKey":"branding.oneOf.0.primaryColor.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.primaryColor","typeLabel":"string | null"},"secondaryColors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"branding.oneOf.0.secondaryColors.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Secondary brand colors.","uniqueKey":"branding.oneOf.0.secondaryColors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Secondary brand colors.","uniqueKey":"branding.oneOf.0.secondaryColors.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.secondaryColors","typeLabel":"string[] | null"},"brandName":{"oneOf":[{"type":"string","description":"The name of the brand.","uniqueKey":"branding.oneOf.0.brandName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the brand.","uniqueKey":"branding.oneOf.0.brandName.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.brandName","typeLabel":"string | null"},"primaryPhone":{"oneOf":[{"type":"string","description":"The primary phone of the business.","uniqueKey":"branding.oneOf.0.primaryPhone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The primary phone of the business.","uniqueKey":"branding.oneOf.0.primaryPhone.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.primaryPhone","typeLabel":"string | null"},"primaryEmail":{"oneOf":[{"type":"string","format":"email","description":"The primary email of the business.","uniqueKey":"branding.oneOf.0.primaryEmail.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"The primary email of the business.","uniqueKey":"branding.oneOf.0.primaryEmail.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.primaryEmail","typeLabel":"string\u003cemail> | null"},"brandTagline":{"oneOf":[{"type":"string","description":"The brand tagline or slogan.","uniqueKey":"branding.oneOf.0.brandTagline.oneOf.0","typeLabel":"string"},{"type":"null","description":"The brand tagline or slogan.","uniqueKey":"branding.oneOf.0.brandTagline.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.brandTagline","typeLabel":"string | null"},"brandPersonality":{"oneOf":[{"type":"object","properties":{"tone":{"oneOf":[{"type":"string","description":"Brand tone.","uniqueKey":"branding.oneOf.0.brandPersonality.oneOf.0.tone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Brand tone.","uniqueKey":"branding.oneOf.0.brandPersonality.oneOf.0.tone.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.brandPersonality.oneOf.0.tone","typeLabel":"string | null"},"voice":{"oneOf":[{"type":"string","description":"Brand voice.","uniqueKey":"branding.oneOf.0.brandPersonality.oneOf.0.voice.oneOf.0","typeLabel":"string"},{"type":"null","description":"Brand voice.","uniqueKey":"branding.oneOf.0.brandPersonality.oneOf.0.voice.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.brandPersonality.oneOf.0.voice","typeLabel":"string | null"},"values":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"branding.oneOf.0.brandPersonality.oneOf.0.values.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Brand values.","uniqueKey":"branding.oneOf.0.brandPersonality.oneOf.0.values.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Brand values.","uniqueKey":"branding.oneOf.0.brandPersonality.oneOf.0.values.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.brandPersonality.oneOf.0.values","typeLabel":"string[] | null"}},"description":"Brand personality details.","uniqueKey":"branding.oneOf.0.brandPersonality.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"tone":{"oneOf":[{"type":"string","description":"Brand tone."},{"type":"null","description":"Brand tone."}]},"voice":{"oneOf":[{"type":"string","description":"Brand voice."},{"type":"null","description":"Brand voice."}]},"values":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Brand values."},{"type":"null","items":{"type":"string"},"description":"Brand values."}]}},"description":"Brand personality details.","uniqueKey":"branding.oneOf.0.brandPersonality.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.brandPersonality","typeLabel":"object | null"},"colorPalette":{"oneOf":[{"type":"object","properties":{"primary":{"oneOf":[{"type":"string","description":"Primary color.","uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.primary.oneOf.0","typeLabel":"string"},{"type":"null","description":"Primary color.","uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.primary.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.primary","typeLabel":"string | null"},"secondary":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.secondary.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Secondary colors.","uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.secondary.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Secondary colors.","uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.secondary.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.secondary","typeLabel":"string[] | null"},"accent":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.accent.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Accent colors.","uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.accent.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Accent colors.","uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.accent.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.accent","typeLabel":"string[] | null"},"background":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.background.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Background colors.","uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.background.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Background colors.","uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.background.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.background","typeLabel":"string[] | null"},"text":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.text.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Text colors.","uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.text.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Text colors.","uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.text.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0.text","typeLabel":"string[] | null"}},"description":"Brand color palette.","uniqueKey":"branding.oneOf.0.colorPalette.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"primary":{"oneOf":[{"type":"string","description":"Primary color."},{"type":"null","description":"Primary color."}]},"secondary":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Secondary colors."},{"type":"null","items":{"type":"string"},"description":"Secondary colors."}]},"accent":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Accent colors."},{"type":"null","items":{"type":"string"},"description":"Accent colors."}]},"background":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Background colors."},{"type":"null","items":{"type":"string"},"description":"Background colors."}]},"text":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Text colors."},{"type":"null","items":{"type":"string"},"description":"Text colors."}]}},"description":"Brand color palette.","uniqueKey":"branding.oneOf.0.colorPalette.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding.oneOf.0.colorPalette","typeLabel":"object | null"}},"description":"Optional branding information for the business","uniqueKey":"branding.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"logoBase64":{"oneOf":[{"type":"string","description":"Base64 encoded logo image. We recommend 128px x 128px for best results. (either this or logoURL)"},{"type":"null","description":"Base64 encoded logo image. We recommend 128px x 128px for best results. (either this or logoURL)"}]},"logoURL":{"oneOf":[{"type":"string","description":"Absolute URL for the brand logo. We recommend 128px x 128px for best results. (either this or logoBase64)"},{"type":"null","description":"Absolute URL for the brand logo. We recommend 128px x 128px for best results. (either this or logoBase64)"}]},"primaryColor":{"oneOf":[{"type":"string","description":"The primary color of the business."},{"type":"null","description":"The primary color of the business."}]},"secondaryColors":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Secondary brand colors."},{"type":"null","items":{"type":"string"},"description":"Secondary brand colors."}]},"brandName":{"oneOf":[{"type":"string","description":"The name of the brand."},{"type":"null","description":"The name of the brand."}]},"primaryPhone":{"oneOf":[{"type":"string","description":"The primary phone of the business."},{"type":"null","description":"The primary phone of the business."}]},"primaryEmail":{"oneOf":[{"type":"string","format":"email","description":"The primary email of the business."},{"type":"null","format":"email","description":"The primary email of the business."}]},"brandTagline":{"oneOf":[{"type":"string","description":"The brand tagline or slogan."},{"type":"null","description":"The brand tagline or slogan."}]},"brandPersonality":{"oneOf":[{"type":"object","properties":{"tone":{"oneOf":[{"type":"string","description":"Brand tone."},{"type":"null","description":"Brand tone."}]},"voice":{"oneOf":[{"type":"string","description":"Brand voice."},{"type":"null","description":"Brand voice."}]},"values":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Brand values."},{"type":"null","items":{"type":"string"},"description":"Brand values."}]}},"description":"Brand personality details."},{"type":"null","properties":{"tone":{"oneOf":[{"type":"string","description":"Brand tone."},{"type":"null","description":"Brand tone."}]},"voice":{"oneOf":[{"type":"string","description":"Brand voice."},{"type":"null","description":"Brand voice."}]},"values":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Brand values."},{"type":"null","items":{"type":"string"},"description":"Brand values."}]}},"description":"Brand personality details."}]},"colorPalette":{"oneOf":[{"type":"object","properties":{"primary":{"oneOf":[{"type":"string","description":"Primary color."},{"type":"null","description":"Primary color."}]},"secondary":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Secondary colors."},{"type":"null","items":{"type":"string"},"description":"Secondary colors."}]},"accent":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Accent colors."},{"type":"null","items":{"type":"string"},"description":"Accent colors."}]},"background":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Background colors."},{"type":"null","items":{"type":"string"},"description":"Background colors."}]},"text":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Text colors."},{"type":"null","items":{"type":"string"},"description":"Text colors."}]}},"description":"Brand color palette."},{"type":"null","properties":{"primary":{"oneOf":[{"type":"string","description":"Primary color."},{"type":"null","description":"Primary color."}]},"secondary":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Secondary colors."},{"type":"null","items":{"type":"string"},"description":"Secondary colors."}]},"accent":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Accent colors."},{"type":"null","items":{"type":"string"},"description":"Accent colors."}]},"background":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Background colors."},{"type":"null","items":{"type":"string"},"description":"Background colors."}]},"text":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Text colors."},{"type":"null","items":{"type":"string"},"description":"Text colors."}]}},"description":"Brand color palette."}]}},"description":"Optional branding information for the business","uniqueKey":"branding.oneOf.1","typeLabel":"null"}],"uniqueKey":"branding","typeLabel":"object | null"},"dataIntegrationCompletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the business completed data integration","uniqueKey":"dataIntegrationCompletedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the business completed data integration","uniqueKey":"dataIntegrationCompletedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"dataIntegrationCompletedAt","typeLabel":"string\u003cdate-time> | null"},"websiteTrackingCompletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the business completed website tracking configuration","uniqueKey":"websiteTrackingCompletedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the business completed website tracking configuration","uniqueKey":"websiteTrackingCompletedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"websiteTrackingCompletedAt","typeLabel":"string\u003cdate-time> | null"},"acquireActivatedAt":{"oneOf":[{"type":"string","format":"date-time","description":"No longer writable. Acquire activation is recorded when a tenant creates their first Reach-managed campaign; a value sent here is accepted and ignored. Still returned by Get Tenant.","deprecated":true,"uniqueKey":"acquireActivatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"No longer writable. Acquire activation is recorded when a tenant creates their first Reach-managed campaign; a value sent here is accepted and ignored. Still returned by Get Tenant.","deprecated":true,"uniqueKey":"acquireActivatedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"acquireActivatedAt","typeLabel":"string\u003cdate-time> | null"},"timezone":{"oneOf":[{"type":"string","description":"The IANA timezone of the business (e.g. America/New_York). Null clears it.","uniqueKey":"timezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The IANA timezone of the business (e.g. America/New_York). Null clears it.","uniqueKey":"timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"timezone","typeLabel":"string | null"},"businessHours":{"oneOf":[{"type":"object","properties":{"monday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"businessHours.oneOf.0.monday.oneOf.0.items.[INDEX].open","typeLabel":"string"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"businessHours.oneOf.0.monday.oneOf.0.items.[INDEX].close","typeLabel":"string"}},"required":["open","close"],"uniqueKey":"businessHours.oneOf.0.monday.oneOf.0.items.[INDEX]","typeLabel":"object"},"maxItems":1,"isRequired":true,"uniqueKey":"businessHours.oneOf.0.monday.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1,"isRequired":true,"uniqueKey":"businessHours.oneOf.0.monday.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"businessHours.oneOf.0.monday","typeLabel":"object[] | null"},"tuesday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"businessHours.oneOf.0.tuesday.oneOf.0.items.[INDEX].open","typeLabel":"string"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"businessHours.oneOf.0.tuesday.oneOf.0.items.[INDEX].close","typeLabel":"string"}},"required":["open","close"],"uniqueKey":"businessHours.oneOf.0.tuesday.oneOf.0.items.[INDEX]","typeLabel":"object"},"maxItems":1,"isRequired":true,"uniqueKey":"businessHours.oneOf.0.tuesday.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1,"isRequired":true,"uniqueKey":"businessHours.oneOf.0.tuesday.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"businessHours.oneOf.0.tuesday","typeLabel":"object[] | null"},"wednesday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"businessHours.oneOf.0.wednesday.oneOf.0.items.[INDEX].open","typeLabel":"string"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"businessHours.oneOf.0.wednesday.oneOf.0.items.[INDEX].close","typeLabel":"string"}},"required":["open","close"],"uniqueKey":"businessHours.oneOf.0.wednesday.oneOf.0.items.[INDEX]","typeLabel":"object"},"maxItems":1,"isRequired":true,"uniqueKey":"businessHours.oneOf.0.wednesday.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1,"isRequired":true,"uniqueKey":"businessHours.oneOf.0.wednesday.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"businessHours.oneOf.0.wednesday","typeLabel":"object[] | null"},"thursday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"businessHours.oneOf.0.thursday.oneOf.0.items.[INDEX].open","typeLabel":"string"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"businessHours.oneOf.0.thursday.oneOf.0.items.[INDEX].close","typeLabel":"string"}},"required":["open","close"],"uniqueKey":"businessHours.oneOf.0.thursday.oneOf.0.items.[INDEX]","typeLabel":"object"},"maxItems":1,"isRequired":true,"uniqueKey":"businessHours.oneOf.0.thursday.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1,"isRequired":true,"uniqueKey":"businessHours.oneOf.0.thursday.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"businessHours.oneOf.0.thursday","typeLabel":"object[] | null"},"friday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"businessHours.oneOf.0.friday.oneOf.0.items.[INDEX].open","typeLabel":"string"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"businessHours.oneOf.0.friday.oneOf.0.items.[INDEX].close","typeLabel":"string"}},"required":["open","close"],"uniqueKey":"businessHours.oneOf.0.friday.oneOf.0.items.[INDEX]","typeLabel":"object"},"maxItems":1,"isRequired":true,"uniqueKey":"businessHours.oneOf.0.friday.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1,"isRequired":true,"uniqueKey":"businessHours.oneOf.0.friday.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"businessHours.oneOf.0.friday","typeLabel":"object[] | null"},"saturday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"businessHours.oneOf.0.saturday.oneOf.0.items.[INDEX].open","typeLabel":"string"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"businessHours.oneOf.0.saturday.oneOf.0.items.[INDEX].close","typeLabel":"string"}},"required":["open","close"],"uniqueKey":"businessHours.oneOf.0.saturday.oneOf.0.items.[INDEX]","typeLabel":"object"},"maxItems":1,"isRequired":true,"uniqueKey":"businessHours.oneOf.0.saturday.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1,"isRequired":true,"uniqueKey":"businessHours.oneOf.0.saturday.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"businessHours.oneOf.0.saturday","typeLabel":"object[] | null"},"sunday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"businessHours.oneOf.0.sunday.oneOf.0.items.[INDEX].open","typeLabel":"string"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"businessHours.oneOf.0.sunday.oneOf.0.items.[INDEX].close","typeLabel":"string"}},"required":["open","close"],"uniqueKey":"businessHours.oneOf.0.sunday.oneOf.0.items.[INDEX]","typeLabel":"object"},"maxItems":1,"isRequired":true,"uniqueKey":"businessHours.oneOf.0.sunday.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1,"isRequired":true,"uniqueKey":"businessHours.oneOf.0.sunday.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"businessHours.oneOf.0.sunday","typeLabel":"object[] | null"}},"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"description":"Weekly business hours. All seven weekday keys are required, and an update replaces the whole schedule. Each weekday is either null or an empty list (closed) or one opening interval with 24-hour HH:MM local times, where the opening time is inclusive and the closing time is exclusive. Null clears the schedule.","uniqueKey":"businessHours.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"monday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1}]},"tuesday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1}]},"wednesday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1}]},"thursday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1}]},"friday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1}]},"saturday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1}]},"sunday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1}]}},"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"description":"Weekly business hours. All seven weekday keys are required, and an update replaces the whole schedule. Each weekday is either null or an empty list (closed) or one opening interval with 24-hour HH:MM local times, where the opening time is inclusive and the closing time is exclusive. Null clears the schedule.","uniqueKey":"businessHours.oneOf.1","typeLabel":"null"}],"uniqueKey":"businessHours","typeLabel":"object | null"},"uiDefaults":{"type":"object","properties":{"emailHelpDialogShow":{"type":"boolean","default":false,"description":"Whether the email help dialog should be shown for this business","uniqueKey":"uiDefaults.emailHelpDialogShow","typeLabel":"boolean"},"engageOnboardingShow":{"type":"boolean","default":true,"description":"Whether the onboarding engagement wizard should be shown for this business","uniqueKey":"uiDefaults.engageOnboardingShow","typeLabel":"boolean"},"acquireLearningPhaseDisabled":{"type":"boolean","uniqueKey":"uiDefaults.acquireLearningPhaseDisabled","typeLabel":"boolean"}},"description":"Business-specific UI defaults for dialogs and feature toggles","uniqueKey":"uiDefaults","typeLabel":"object"},"smsOptInImageUrls":{"type":"array","items":{"type":"string","format":"uri","uniqueKey":"smsOptInImageUrls.items.[INDEX]","typeLabel":"string\u003curi>"},"description":"Array of URLs that demonstrate how SMS consent is obtained. Can be image URLs (screenshots) or URLs to ordering/checkout pages where consent is captured.","uniqueKey":"smsOptInImageUrls","typeLabel":"string\u003curi>[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"externalId":"\u003cstring>","website":"\u003cstring>","locations":[{"addressLine1":"\u003cstring>","locality":"\u003cstring>","district":"\u003cstring>","postalCode":"\u003cstring>","countryCode":"\u003cstring>","addressLine2":"\u003cstring>","addressLine3":"\u003cstring>"}],"name":"\u003cstring>","branding":{"logoBase64":"\u003cstring>","logoURL":"\u003cstring>","primaryColor":"\u003cstring>","secondaryColors":["\u003cstring>"],"brandName":"\u003cstring>","primaryPhone":"\u003cstring>","primaryEmail":"jsmith@example.com","brandTagline":"\u003cstring>","brandPersonality":{"tone":"\u003cstring>","voice":"\u003cstring>","values":["\u003cstring>"]},"colorPalette":{"primary":"\u003cstring>","secondary":["\u003cstring>"],"accent":["\u003cstring>"],"background":["\u003cstring>"],"text":["\u003cstring>"]}},"dataIntegrationCompletedAt":"2023-11-07T05:31:56Z","websiteTrackingCompletedAt":"2023-11-07T05:31:56Z","acquireActivatedAt":"2023-11-07T05:31:56Z","timezone":"\u003cstring>","businessHours":{"monday":[{"open":"\u003cstring>","close":"\u003cstring>"}],"tuesday":[{"open":"\u003cstring>","close":"\u003cstring>"}],"wednesday":[{"open":"\u003cstring>","close":"\u003cstring>"}],"thursday":[{"open":"\u003cstring>","close":"\u003cstring>"}],"friday":[{"open":"\u003cstring>","close":"\u003cstring>"}],"saturday":[{"open":"\u003cstring>","close":"\u003cstring>"}],"sunday":[{"open":"\u003cstring>","close":"\u003cstring>"}]},"uiDefaults":{"emailHelpDialogShow":false,"engageOnboardingShow":true,"acquireLearningPhaseDisabled":true},"smsOptInImageUrls":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"cada8609-505f-4e35-b0dd-c469e687689f":{"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","description":"The id of the business","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"name":{"type":"string","description":"A friendly name for the business","isRequired":true,"uniqueKey":"data.name","typeLabel":"string"},"website":{"oneOf":[{"type":"string","description":"The website of the business","isRequired":true,"uniqueKey":"data.website.oneOf.0","typeLabel":"string"},{"type":"null","description":"The website of the business","isRequired":true,"uniqueKey":"data.website.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.website","typeLabel":"string | null"},"dataIntegrationComplete":{"type":"boolean","description":"Whether the business is fully ingested","isRequired":true,"uniqueKey":"data.dataIntegrationComplete","typeLabel":"boolean"},"timezone":{"oneOf":[{"type":"string","description":"The IANA timezone of the business","isRequired":true,"uniqueKey":"data.timezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The IANA timezone of the business","isRequired":true,"uniqueKey":"data.timezone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.timezone","typeLabel":"string | null"},"businessHours":{"oneOf":[{"type":"object","properties":{"monday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.monday.oneOf.0.items.[INDEX].open","typeLabel":"string"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.monday.oneOf.0.items.[INDEX].close","typeLabel":"string"}},"required":["open","close"],"uniqueKey":"data.businessHours.oneOf.0.monday.oneOf.0.items.[INDEX]","typeLabel":"object"},"maxItems":1,"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.monday.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1,"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.monday.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.monday","typeLabel":"object[] | null"},"tuesday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.tuesday.oneOf.0.items.[INDEX].open","typeLabel":"string"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.tuesday.oneOf.0.items.[INDEX].close","typeLabel":"string"}},"required":["open","close"],"uniqueKey":"data.businessHours.oneOf.0.tuesday.oneOf.0.items.[INDEX]","typeLabel":"object"},"maxItems":1,"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.tuesday.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1,"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.tuesday.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.tuesday","typeLabel":"object[] | null"},"wednesday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.wednesday.oneOf.0.items.[INDEX].open","typeLabel":"string"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.wednesday.oneOf.0.items.[INDEX].close","typeLabel":"string"}},"required":["open","close"],"uniqueKey":"data.businessHours.oneOf.0.wednesday.oneOf.0.items.[INDEX]","typeLabel":"object"},"maxItems":1,"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.wednesday.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1,"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.wednesday.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.wednesday","typeLabel":"object[] | null"},"thursday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.thursday.oneOf.0.items.[INDEX].open","typeLabel":"string"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.thursday.oneOf.0.items.[INDEX].close","typeLabel":"string"}},"required":["open","close"],"uniqueKey":"data.businessHours.oneOf.0.thursday.oneOf.0.items.[INDEX]","typeLabel":"object"},"maxItems":1,"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.thursday.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1,"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.thursday.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.thursday","typeLabel":"object[] | null"},"friday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.friday.oneOf.0.items.[INDEX].open","typeLabel":"string"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.friday.oneOf.0.items.[INDEX].close","typeLabel":"string"}},"required":["open","close"],"uniqueKey":"data.businessHours.oneOf.0.friday.oneOf.0.items.[INDEX]","typeLabel":"object"},"maxItems":1,"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.friday.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1,"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.friday.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.friday","typeLabel":"object[] | null"},"saturday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.saturday.oneOf.0.items.[INDEX].open","typeLabel":"string"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.saturday.oneOf.0.items.[INDEX].close","typeLabel":"string"}},"required":["open","close"],"uniqueKey":"data.businessHours.oneOf.0.saturday.oneOf.0.items.[INDEX]","typeLabel":"object"},"maxItems":1,"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.saturday.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1,"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.saturday.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.saturday","typeLabel":"object[] | null"},"sunday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.sunday.oneOf.0.items.[INDEX].open","typeLabel":"string"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.sunday.oneOf.0.items.[INDEX].close","typeLabel":"string"}},"required":["open","close"],"uniqueKey":"data.businessHours.oneOf.0.sunday.oneOf.0.items.[INDEX]","typeLabel":"object"},"maxItems":1,"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.sunday.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1,"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.sunday.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.businessHours.oneOf.0.sunday","typeLabel":"object[] | null"}},"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"description":"Weekly business hours; null when not configured","isRequired":true,"uniqueKey":"data.businessHours.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"monday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1}]},"tuesday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1}]},"wednesday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1}]},"thursday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1}]},"friday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1}]},"saturday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1}]},"sunday":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1},{"type":"null","items":{"type":"object","properties":{"open":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"close":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}},"required":["open","close"]},"maxItems":1}]}},"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"description":"Weekly business hours; null when not configured","isRequired":true,"uniqueKey":"data.businessHours.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.businessHours","typeLabel":"object | null"},"locations":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"addressLine1":{"type":"string","isRequired":true,"uniqueKey":"data.locations.oneOf.0.items.[INDEX].addressLine1","typeLabel":"string"},"locality":{"type":"string","description":"The city or town of the business (e.g. New York)","isRequired":true,"uniqueKey":"data.locations.oneOf.0.items.[INDEX].locality","typeLabel":"string"},"district":{"type":"string","description":"The State (e.g. NY, CA, etc.) of the business","isRequired":true,"uniqueKey":"data.locations.oneOf.0.items.[INDEX].district","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code of the business","isRequired":true,"uniqueKey":"data.locations.oneOf.0.items.[INDEX].postalCode","typeLabel":"string"},"countryCode":{"type":"string","description":"The country code of the business (e.g. USA)","isRequired":true,"uniqueKey":"data.locations.oneOf.0.items.[INDEX].countryCode","typeLabel":"string"},"addressLine2":{"type":"string","uniqueKey":"data.locations.oneOf.0.items.[INDEX].addressLine2","typeLabel":"string"},"addressLine3":{"type":"string","uniqueKey":"data.locations.oneOf.0.items.[INDEX].addressLine3","typeLabel":"string"}},"required":["addressLine1","locality","district","postalCode","countryCode"],"uniqueKey":"data.locations.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"The locations of the business","uniqueKey":"data.locations.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"addressLine3":{"type":"string"},"locality":{"type":"string","description":"The city or town of the business (e.g. New York)"},"district":{"type":"string","description":"The State (e.g. NY, CA, etc.) of the business"},"postalCode":{"type":"string","description":"The postal code of the business"},"countryCode":{"type":"string","description":"The country code of the business (e.g. USA)"}},"required":["addressLine1","locality","district","postalCode","countryCode"]},"description":"The locations of the business","uniqueKey":"data.locations.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.locations","typeLabel":"object[] | null"},"uiDefaults":{"oneOf":[{"type":"object","properties":{"emailHelpDialogShow":{"type":"boolean","default":false,"description":"Whether the email help dialog should be shown for this business","uniqueKey":"data.uiDefaults.oneOf.0.emailHelpDialogShow","typeLabel":"boolean"},"engageOnboardingShow":{"type":"boolean","default":true,"description":"Whether the onboarding engagement wizard should be shown for this business","uniqueKey":"data.uiDefaults.oneOf.0.engageOnboardingShow","typeLabel":"boolean"},"acquireLearningPhaseDisabled":{"type":"boolean","uniqueKey":"data.uiDefaults.oneOf.0.acquireLearningPhaseDisabled","typeLabel":"boolean"}},"description":"Business-specific UI defaults for dialogs and feature toggles","uniqueKey":"data.uiDefaults.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"emailHelpDialogShow":{"type":"boolean","default":false,"description":"Whether the email help dialog should be shown for this business"},"engageOnboardingShow":{"type":"boolean","default":true,"description":"Whether the onboarding engagement wizard should be shown for this business"},"acquireLearningPhaseDisabled":{"type":"boolean"}},"description":"Business-specific UI defaults for dialogs and feature toggles","uniqueKey":"data.uiDefaults.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.uiDefaults","typeLabel":"object | null"},"smsOptInImageUrls":{"oneOf":[{"type":"array","items":{"type":"string","format":"uri","uniqueKey":"data.smsOptInImageUrls.oneOf.0.items.[INDEX]","typeLabel":"string\u003curi>"},"description":"Array of URLs that demonstrate how SMS consent is obtained. Can be image URLs (screenshots) or URLs to ordering/checkout pages where consent is captured.","uniqueKey":"data.smsOptInImageUrls.oneOf.0","typeLabel":"string\u003curi>[]"},{"type":"null","items":{"type":"string","format":"uri"},"description":"Array of URLs that demonstrate how SMS consent is obtained. Can be image URLs (screenshots) or URLs to ordering/checkout pages where consent is captured.","uniqueKey":"data.smsOptInImageUrls.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.smsOptInImageUrls","typeLabel":"string\u003curi>[] | null"}},"required":["id","name","website","dataIntegrationComplete","timezone","businessHours"],"uniqueKey":"data","typeLabel":"object"}},"required":["success"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","data":{"id":"\u003cstring>","name":"\u003cstring>","website":"\u003cstring>","dataIntegrationComplete":true,"timezone":"\u003cstring>","businessHours":{"monday":[{"open":"\u003cstring>","close":"\u003cstring>"}],"tuesday":[{"open":"\u003cstring>","close":"\u003cstring>"}],"wednesday":[{"open":"\u003cstring>","close":"\u003cstring>"}],"thursday":[{"open":"\u003cstring>","close":"\u003cstring>"}],"friday":[{"open":"\u003cstring>","close":"\u003cstring>"}],"saturday":[{"open":"\u003cstring>","close":"\u003cstring>"}],"sunday":[{"open":"\u003cstring>","close":"\u003cstring>"}]},"locations":[{"addressLine1":"\u003cstring>","locality":"\u003cstring>","district":"\u003cstring>","postalCode":"\u003cstring>","countryCode":"\u003cstring>","addressLine2":"\u003cstring>","addressLine3":"\u003cstring>"}],"uiDefaults":{"emailHelpDialogShow":false,"engageOnboardingShow":true,"acquireLearningPhaseDisabled":true},"smsOptInImageUrls":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"4b66ef1d-ee92-4c22-8eac-a20a4f5e8507":{"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"}},"security":{},"servers":{"b6698960-0146-4778-93c2-3770261e8dee":{"url":"https://api.embedreach.com","description":"Production server"}}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"reach","siteName":"Reach Marketing \u0026 Automation Documentation","title":"Update Tenant - Reach Marketing \u0026 Automation Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-28T21:44:11.391Z","originalFileLocation":"api-reference/endpoint/patch-partner-tenants-id.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=\"Update a tenant\">\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=\"Update Tenant - Reach Marketing \u0026amp; Automation Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update a tenant\">\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-partner-tenants-id\">\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=Tenants\u0026amp;title=Update+Tenant\u0026amp;description=Update+a+tenant\u0026amp;theme=8f2be3aa00eff555d7076746\u0026amp;signature=e5bf1e3f577aa89673edf9d77ec09584046b4803dea0571499f31a8c90f6afab\">\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=\"Update Tenant - Reach Marketing \u0026amp; Automation Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update a tenant\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://reach.mintlify.site/_mintlify/api/og/v2?division=Tenants\u0026amp;title=Update+Tenant\u0026amp;description=Update+a+tenant\u0026amp;theme=8f2be3aa00eff555d7076746\u0026amp;signature=e5bf1e3f577aa89673edf9d77ec09584046b4803dea0571499f31a8c90f6afab\">\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-partner-tenants-id\">\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-partner-tenants-id.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-partner-tenants-id#webpage\",\"url\":\"https://docs.embedreach.com/api-reference/endpoint/patch-partner-tenants-id\",\"name\":\"Update Tenant\",\"description\":\"Update a tenant\",\"dateModified\":\"2026-01-28T21:44:11.391Z\",\"isPartOf\":{\"@id\":\"https://docs.embedreach.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.embedreach.com/api-reference/endpoint/patch-partner-tenants-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.embedreach.com/api-reference/endpoint/patch-partner-tenants-id#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Documentation\",\"item\":\"https://docs.embedreach.com/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Tenants\",\"item\":\"https://docs.embedreach.com/api-reference/endpoint/tenants-introduction\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update Tenant\",\"item\":\"https://docs.embedreach.com/api-reference/endpoint/patch-partner-tenants-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.embedreach.com/api-reference/endpoint/patch-partner-tenants-id#apireference\",\"headline\":\"Update Tenant\",\"name\":\"Update Tenant\",\"description\":\"Update a tenant\",\"url\":\"https://docs.embedreach.com/api-reference/endpoint/patch-partner-tenants-id\",\"mainEntityOfPage\":{\"@id\":\"https://docs.embedreach.com/api-reference/endpoint/patch-partner-tenants-id#webpage\"},\"dateModified\":\"2026-01-28T21:44:11.391Z\",\"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\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Reach Marketing \u0026 Automation Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/patch-partner-tenants-id.md","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","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}","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","description":"Get SMS registration application status for a tenant. Returns null if no application exists.","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","description":"Create a new tenant","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":"Update Tenant - Reach Marketing \u0026 Automation Documentation","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}