Update Tenant - Reach Marketing & Automation Documentation

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>"
    ]
  }
}

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

Show child attributes

locations.addressLine1

string

required

locations.locality

string

required

The city or town of the business (e.g. New York)

locations.district

string

required

The State (e.g. NY, CA, etc.) of the business

locations.postalCode

string

required

The postal code of the business

locations.countryCode

string

required

The country code of the business (e.g. USA)

locations.addressLine2

string

locations.addressLine3

string

name

string

A friendly name for the business

branding

object

Optional branding information for the business

Show child attributes

branding.logoBase64

string | null

Base64 encoded logo image. We recommend 128px x 128px for best results. (either this or logoURL)

branding.logoURL

string | null

Absolute URL for the brand logo. We recommend 128px x 128px for best results. (either this or logoBase64)

branding.primaryColor

string | null

The primary color of the business.

branding.secondaryColors

string[] | null

Secondary brand colors.

branding.brandName

string | null

The name of the brand.

branding.primaryPhone

string | null

The primary phone of the business.

branding.primaryEmail

string<email> | null

The primary email of the business.

branding.brandTagline

string | null

The brand tagline or slogan.

branding.brandPersonality

object

Brand personality details.

Show child attributes

branding.brandPersonality.tone

string | null

Brand tone.

branding.brandPersonality.voice

string | null

Brand voice.

branding.brandPersonality.values

string[] | null

Brand values.

branding.colorPalette

object

Brand color palette.

Show child attributes

branding.colorPalette.primary

string | null

Primary color.

branding.colorPalette.secondary

string[] | null

Secondary colors.

branding.colorPalette.accent

string[] | null

Accent colors.

branding.colorPalette.background

string[] | null

Background colors.

branding.colorPalette.text

string[] | null

Text colors.

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

Show child attributes

uiDefaults.emailHelpDialogShow

boolean

default:false

Whether the email help dialog should be shown for this business

uiDefaults.engageOnboardingShow

boolean

default:true

Whether the onboarding engagement wizard should be shown for this business

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

data.id

string

required

The id of the business

data.name

string

required

A friendly name for the business

data.website

string | null

required

The website of the business

data.dataIntegrationComplete

boolean

required

Whether the business is fully ingested

data.locations

object[] | null

The locations of the business

Show child attributes

data.locations.addressLine1

string

required

data.locations.locality

string

required

The city or town of the business (e.g. New York)

data.locations.district

string

required

The State (e.g. NY, CA, etc.) of the business

data.locations.postalCode

string

required

The postal code of the business

data.locations.countryCode

string

required

The country code of the business (e.g. USA)

data.locations.addressLine2

string

data.locations.addressLine3

string

data.uiDefaults

object

Business-specific UI defaults for dialogs and feature toggles

Show child attributes

data.uiDefaults.emailHelpDialogShow

boolean

default:false

Whether the email help dialog should be shown for this business

data.uiDefaults.engageOnboardingShow

boolean

default:true

Whether the onboarding engagement wizard should be shown for this business

data.smsOptInImageUrls

string<uri>[] | null

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.

Get SMS Registration Status Create Tenant

⌘I

API Documentation

Body

Response