Create Tenant

Create a new tenant

POST /partner/tenants

Create Tenant

cURL

curl --request POST \
  --url https://api.embedreach.com/partner/tenants \
  --header 'Content-Type: application/json' \
  --data '
{
  "locations": [
    {
      "addressLine1": "<string>",
      "locality": "<string>",
      "district": "<string>",
      "postalCode": "<string>",
      "countryCode": "<string>",
      "addressLine2": "<string>",
      "addressLine3": "<string>"
    }
  ],
  "name": "<string>",
  "externalId": "<string>",
  "external_id": "<string>",
  "website": "<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>",
  "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>"
      }
    ]
  },
  "smsOptInImageUrls": [
    "<string>"
  ]
}
'

200

{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "externalId": "<string>",
    "website": "<string>",
    "name": "<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>"
      }
    ],
    "smsOptInImageUrls": [
      "<string>"
    ]
  }
}

Body

application/json

locations · object[] · required

The locations of the business

Show child attributes

name · string · required

A friendly name for the business

externalId · string

Required. The external id of the business (e.g. the id you use to identify the business in your system)

external_id · string · deprecated

Deprecated: use externalId. Still accepted so existing integrations keep working.

website · string

The website of 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

measureDateAttributionStyle · enum<string>

The date attribution style to use when measuring metrics

Available options: click, transaction

timezone · string | null

The IANA timezone of the business (e.g. America/New_York). Null is treated the same as omitting the field.

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 is treated the same as omitting the field.

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