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>",
  "uiDefaults": {
    "emailHelpDialogShow": false,
    "engageOnboardingShow": true,
    "acquireLearningPhaseDisabled": true
  },
  "smsOptInImageUrls": [
    "<string>"
  ]
}
'

import requests

url = "https://api.embedreach.com/partner/tenants/{id}"

payload = {
    "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>",
    "uiDefaults": {
        "emailHelpDialogShow": False,
        "engageOnboardingShow": True,
        "acquireLearningPhaseDisabled": True
    },
    "smsOptInImageUrls": ["<string>"]
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>',
    uiDefaults: {
      emailHelpDialogShow: false,
      engageOnboardingShow: true,
      acquireLearningPhaseDisabled: true
    },
    smsOptInImageUrls: ['<string>']
  })
};

fetch('https://api.embedreach.com/partner/tenants/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.embedreach.com/partner/tenants/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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>',
    'uiDefaults' => [
        'emailHelpDialogShow' => false,
        'engageOnboardingShow' => true,
        'acquireLearningPhaseDisabled' => true
    ],
    'smsOptInImageUrls' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.embedreach.com/partner/tenants/{id}"

	payload := strings.NewReader("{\n  \"externalId\": \"<string>\",\n  \"website\": \"<string>\",\n  \"locations\": [\n    {\n      \"addressLine1\": \"<string>\",\n      \"locality\": \"<string>\",\n      \"district\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"countryCode\": \"<string>\",\n      \"addressLine2\": \"<string>\",\n      \"addressLine3\": \"<string>\"\n    }\n  ],\n  \"name\": \"<string>\",\n  \"branding\": {\n    \"logoBase64\": \"<string>\",\n    \"logoURL\": \"<string>\",\n    \"primaryColor\": \"<string>\",\n    \"secondaryColors\": [\n      \"<string>\"\n    ],\n    \"brandName\": \"<string>\",\n    \"primaryPhone\": \"<string>\",\n    \"primaryEmail\": \"[e-mail]\",\n    \"brandTagline\": \"<string>\",\n    \"brandPersonality\": {\n      \"tone\": \"<string>\",\n      \"voice\": \"<string>\",\n      \"values\": [\n        \"<string>\"\n      ]\n    },\n    \"colorPalette\": {\n      \"primary\": \"<string>\",\n      \"secondary\": [\n        \"<string>\"\n      ],\n      \"accent\": [\n        \"<string>\"\n      ],\n      \"background\": [\n        \"<string>\"\n      ],\n      \"text\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"dataIntegrationCompletedAt\": \"<string>\",\n  \"websiteTrackingCompletedAt\": \"<string>\",\n  \"acquireActivatedAt\": \"<string>\",\n  \"uiDefaults\": {\n    \"emailHelpDialogShow\": false,\n    \"engageOnboardingShow\": true,\n    \"acquireLearningPhaseDisabled\": true\n  },\n  \"smsOptInImageUrls\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.embedreach.com/partner/tenants/{id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalId\": \"<string>\",\n  \"website\": \"<string>\",\n  \"locations\": [\n    {\n      \"addressLine1\": \"<string>\",\n      \"locality\": \"<string>\",\n      \"district\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"countryCode\": \"<string>\",\n      \"addressLine2\": \"<string>\",\n      \"addressLine3\": \"<string>\"\n    }\n  ],\n  \"name\": \"<string>\",\n  \"branding\": {\n    \"logoBase64\": \"<string>\",\n    \"logoURL\": \"<string>\",\n    \"primaryColor\": \"<string>\",\n    \"secondaryColors\": [\n      \"<string>\"\n    ],\n    \"brandName\": \"<string>\",\n    \"primaryPhone\": \"<string>\",\n    \"primaryEmail\": \"[e-mail]\",\n    \"brandTagline\": \"<string>\",\n    \"brandPersonality\": {\n      \"tone\": \"<string>\",\n      \"voice\": \"<string>\",\n      \"values\": [\n        \"<string>\"\n      ]\n    },\n    \"colorPalette\": {\n      \"primary\": \"<string>\",\n      \"secondary\": [\n        \"<string>\"\n      ],\n      \"accent\": [\n        \"<string>\"\n      ],\n      \"background\": [\n        \"<string>\"\n      ],\n      \"text\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"dataIntegrationCompletedAt\": \"<string>\",\n  \"websiteTrackingCompletedAt\": \"<string>\",\n  \"acquireActivatedAt\": \"<string>\",\n  \"uiDefaults\": {\n    \"emailHelpDialogShow\": false,\n    \"engageOnboardingShow\": true,\n    \"acquireLearningPhaseDisabled\": true\n  },\n  \"smsOptInImageUrls\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.embedreach.com/partner/tenants/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"externalId\": \"<string>\",\n  \"website\": \"<string>\",\n  \"locations\": [\n    {\n      \"addressLine1\": \"<string>\",\n      \"locality\": \"<string>\",\n      \"district\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"countryCode\": \"<string>\",\n      \"addressLine2\": \"<string>\",\n      \"addressLine3\": \"<string>\"\n    }\n  ],\n  \"name\": \"<string>\",\n  \"branding\": {\n    \"logoBase64\": \"<string>\",\n    \"logoURL\": \"<string>\",\n    \"primaryColor\": \"<string>\",\n    \"secondaryColors\": [\n      \"<string>\"\n    ],\n    \"brandName\": \"<string>\",\n    \"primaryPhone\": \"<string>\",\n    \"primaryEmail\": \"[e-mail]\",\n    \"brandTagline\": \"<string>\",\n    \"brandPersonality\": {\n      \"tone\": \"<string>\",\n      \"voice\": \"<string>\",\n      \"values\": [\n        \"<string>\"\n      ]\n    },\n    \"colorPalette\": {\n      \"primary\": \"<string>\",\n      \"secondary\": [\n        \"<string>\"\n      ],\n      \"accent\": [\n        \"<string>\"\n      ],\n      \"background\": [\n        \"<string>\"\n      ],\n      \"text\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"dataIntegrationCompletedAt\": \"<string>\",\n  \"websiteTrackingCompletedAt\": \"<string>\",\n  \"acquireActivatedAt\": \"<string>\",\n  \"uiDefaults\": {\n    \"emailHelpDialogShow\": false,\n    \"engageOnboardingShow\": true,\n    \"acquireLearningPhaseDisabled\": true\n  },\n  \"smsOptInImageUrls\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "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,
      "acquireLearningPhaseDisabled": true
    },
    "smsOptInImageUrls": [
      "<string>"
    ]
  }
}

{
  "message": "<string>",
  "success": false,
  "errors": [
    "<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.

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