Skip to main content
PATCH
/
partner
/
tenants
/
{id}
Update Tenant
curl --request PATCH \
  --url https://api.embedreach.com/partner/tenants/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalId": "<string>",
  "website": "<string>",
  "locations": [
    {
      "addressLine1": "<string>",
      "locality": "<string>",
      "district": "<string>",
      "postalCode": "<string>",
      "countryCode": "<string>",
      "addressLine2": "<string>",
      "addressLine3": "<string>"
    }
  ],
  "name": "<string>",
  "branding": {
    "logoBase64": "<string>",
    "logoURL": "<string>",
    "primaryColor": "<string>",
    "secondaryColors": [
      "<string>"
    ],
    "brandName": "<string>",
    "primaryPhone": "<string>",
    "primaryEmail": "[email protected]",
    "brandTagline": "<string>",
    "brandPersonality": {
      "tone": "<string>",
      "voice": "<string>",
      "values": [
        "<string>"
      ]
    },
    "colorPalette": {
      "primary": "<string>",
      "secondary": [
        "<string>"
      ],
      "accent": [
        "<string>"
      ],
      "background": [
        "<string>"
      ],
      "text": [
        "<string>"
      ]
    }
  },
  "dataIntegrationCompletedAt": "<string>",
  "websiteTrackingCompletedAt": "<string>",
  "uiDefaults": {
    "emailHelpDialogShow": false,
    "engageOnboardingShow": true
  },
  "smsOptInImageUrls": [
    "<string>"
  ]
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "website": "<string>",
    "dataIntegrationComplete": true,
    "locations": [
      {
        "addressLine1": "<string>",
        "locality": "<string>",
        "district": "<string>",
        "postalCode": "<string>",
        "countryCode": "<string>",
        "addressLine2": "<string>",
        "addressLine3": "<string>"
      }
    ],
    "uiDefaults": {
      "emailHelpDialogShow": false,
      "engageOnboardingShow": true
    },
    "smsOptInImageUrls": [
      "<string>"
    ]
  }
}

Body

application/json
​
externalId
string

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

​
name
string

A friendly name for the business

​
branding
object

Optional branding information for the business

​
dataIntegrationCompletedAt
string | null

The date and time the business completed data integration

​
websiteTrackingCompletedAt
string | null

The date and time the business completed website tracking configuration

​
uiDefaults
object

Business-specific UI defaults for dialogs and feature toggles

​
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