Update Tenant

Update a tenant

PATCH /partner/tenants/{id}

Update Tenant

cURL

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": "[e-mail]",
    "brandTagline": "<string>",
    "brandPersonality": {
      "tone": "<string>",
      "voice": "<string>",
      "values": [
        "<string>"
      ]
    },
    "colorPalette": {
      "primary": "<string>",
      "secondary": [
        "<string>"
      ],
      "accent": [
        "<string>"
      ],
      "background": [
        "<string>"
      ],
      "text": [
        "<string>"
      ]
    }
  },
  "dataIntegrationCompletedAt": "<string>",
  "websiteTrackingCompletedAt": "<string>",
  "acquireActivatedAt": "<string>",
  "timezone": "<string>",
  "businessHours": {
    "monday": [
      {
        "open": "<string>",
        "close": "<string>"
      }
    ],
    "tuesday": [
      {
        "open": "<string>",
        "close": "<string>"
      }
    ],
    "wednesday": [
      {
        "open": "<string>",
        "close": "<string>"
      }
    ],
    "thursday": [
      {
        "open": "<string>",
        "close": "<string>"
      }
    ],
    "friday": [
      {
        "open": "<string>",
        "close": "<string>"
      }
    ],
    "saturday": [
      {
        "open": "<string>",
        "close": "<string>"
      }
    ],
    "sunday": [
      {
        "open": "<string>",
        "close": "<string>"
      }
    ]
  },
  "uiDefaults": {
    "emailHelpDialogShow": false,
    "engageOnboardingShow": true,
    "acquireLearningPhaseDisabled": true
  },
  "smsOptInImageUrls": [
    "<string>"
  ]
}
'

200

{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "website": "<string>",
    "dataIntegrationComplete": true,
    "timezone": "<string>",
    "businessHours": {
      "monday": [
        {
          "open": "<string>",
          "close": "<string>"
        }
      ],
      "tuesday": [
        {
          "open": "<string>",
          "close": "<string>"
        }
      ],
      "wednesday": [
        {
          "open": "<string>",
          "close": "<string>"
        }
      ],
      "thursday": [
        {
          "open": "<string>",
          "close": "<string>"
        }
      ],
      "friday": [
        {
          "open": "<string>",
          "close": "<string>"
        }
      ],
      "saturday": [
        {
          "open": "<string>",
          "close": "<string>"
        }
      ],
      "sunday": [
        {
          "open": "<string>",
          "close": "<string>"
        }
      ]
    },
    "locations": [
      {
        "addressLine1": "<string>",
        "locality": "<string>",
        "district": "<string>",
        "postalCode": "<string>",
        "countryCode": "<string>",
        "addressLine2": "<string>",
        "addressLine3": "<string>"
      }
    ],
    "uiDefaults": {
      "emailHelpDialogShow": false,
      "engageOnboardingShow": true,
      "acquireLearningPhaseDisabled": 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

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 | null

The date and time the business completed data integration

websiteTrackingCompletedAt · string | null

The date and time the business completed website tracking configuration

acquireActivatedAt · string | null

Acquire feature activation date. Null clears the activation. Auto-set on first reach-managed campaign submission; editable here for backdating.

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

200

application/json

Status 200 response

success · boolean · required

message · string

data · object

Show child attributes