Site Reactive Tab

A site's reactive tab visuals and behavior can be configured by means of the following endpoints:

PUT Tab Visuals

cURL
Untitled
Untitled
cURL
curl --request PUT \
--header "Authorization: Bearer $access_token" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.salemove.v1+json" \
--data-binary '{
"visible_operator_count": 3,
"text": "Let\u0027s Talk!",
"front_color": "#53a0fd"
}' \
"https://api.salemove.com/sites/$site_id/reactive_tab"
Untitled
var XMLHttpRequest = require('xmlhttprequest').XMLHttpRequest;
var xhr = new XMLHttpRequest();
xhr.open('PUT','https://api.salemove.com/sites/$site_id/reactive_tab',false);
xhr.setRequestHeader('authorization', `Bearer ${accessToken}`);
xhr.setRequestHeader('content-type', 'application/json');
xhr.setRequestHeader('accept', 'application/vnd.salemove.v1+json');
var data = {
"visible_operator_count": 3,
"text": "Let's Talk!",
"front_color": "#53a0fd"
}
};
var query = JSON.stringify(data);
xhr.send(query);
var response = JSON.parse(xhr.responseText);
console.log(response);
Untitled
require 'httparty'
ENDPOINT = 'https://api.salemove.com/sites'
token = ARGV[0].strip
site_id = ARGV[1].strip
headers = {
:authorization => "Bearer #{access_token}",
:content_type => "application/json",
:accept => "application/vnd.salemove.v1+json"
}
options = {
headers: headers,
query: {
"visible_operator_count": 3,
"text": "Let's Talk!",
"front_color": "#53a0fd"
}
}
raw_response = HTTParty.put(
"#{ENDPOINT}/#{site_id}/reactive_tab",
options
)
response = JSON.parse raw_response.body
puts response

Generates the Output

{
"visible_operator_count": 3,
"format": "mix",
"vertical_offset": 50,
"front_color": "#53a0fd",
"back_color": "#ffffff",
"hover_color": "#e6e6e6",
"text": "Let's Talk!",
"font_size": 20,
"icon_class": "ico-video",
"size": 100,
"placement": "left"
}

Action: PUT /sites/{site_id}/reactive_tab

This updates the reactive tab visuals and behavior for the site with ID site_id. The user updating the reactive tab must have the super_manager role on the site.

Parameter

Type

Required

Description

site_id

String

Yes

ID of the site to be updated.

visible_operator_count

Integer

No

The maximum number of operators to be displayed at any given time. Must be a positive integer.

text

String

No

The text displayed in the reactive tab.

front_color

String

No

The color of the text and icons present on the reactive tab in hex format.

Note: Several values relevant to v1 of the Visitor App are returned in the output, but are deprecated as of VA2. They may be disregarded for all practical purposes.