Skip to main content
PUT
/
projects
/
{project_id}
/
integrations
/
client_side
Update Magic Embed settings
curl --request PUT \
  --url https://api.beyondwords.io/v1/projects/{project_id}/integrations/client_side \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "enabled": true,
  "allowed_domains": [
    "<string>"
  ]
}
'
import requests

url = "https://api.beyondwords.io/v1/projects/{project_id}/integrations/client_side"

payload = {
    "enabled": True,
    "allowed_domains": ["<string>"]
}
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PUT',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({enabled: true, allowed_domains: ['<string>']})
};

fetch('https://api.beyondwords.io/v1/projects/{project_id}/integrations/client_side', 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.beyondwords.io/v1/projects/{project_id}/integrations/client_side",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => true,
    'allowed_domains' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <api-key>"
  ],
]);

$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.beyondwords.io/v1/projects/{project_id}/integrations/client_side"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"allowed_domains\": [\n    \"<string>\"\n  ]\n}")

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

	req.Header.Add("X-Api-Key", "<api-key>")
	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.put("https://api.beyondwords.io/v1/projects/{project_id}/integrations/client_side")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"allowed_domains\": [\n    \"<string>\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.beyondwords.io/v1/projects/{project_id}/integrations/client_side")

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

request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"allowed_domains\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "enabled": false,
  "allowed_domains": [
    "example.com",
    "m.example.com"
  ],
  "created": "2023-01-01 00:00:00 UTC",
  "updated": "2023-01-01 00:00:00 UTC"
}
Enable or update Magic Embed for a project. Set enabled and allowed_domains to control where the Magic Embed script can ingest content. See the Magic Embed guide for setup instructions.

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
project_id
string
required

The numeric ID of your project

Body

application/json
​
enabled
boolean
​
allowed_domains
string[]

Response

200 - application/json

successful

​
enabled
boolean

Whether or not the client side integration should be enabled. Disabled by default.

​
allowed_domains
string[]

The list of domains from which to import content into the BeyondWords platform.

​
created
string<date-time>

Time at which the object was created (ISO 8601)

​
updated
string<date-time>

Time at which the object was updated (ISO 8601)