curl --request PUT \
--url https://api.exowpee.com/v1/template/company-templates/{companyTemplate}/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"settings": {}
}'import requests
url = "https://api.exowpee.com/v1/template/company-templates/{companyTemplate}/settings"
payload = { "settings": {} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({settings: {}})
};
fetch('https://api.exowpee.com/v1/template/company-templates/{companyTemplate}/settings', 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.exowpee.com/v1/template/company-templates/{companyTemplate}/settings",
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([
'settings' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.exowpee.com/v1/template/company-templates/{companyTemplate}/settings"
payload := strings.NewReader("{\n \"settings\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.exowpee.com/v1/template/company-templates/{companyTemplate}/settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"settings\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/template/company-templates/{companyTemplate}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"settings\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"company_id": "<string>",
"template_id": "<string>",
"template_version_id": "<string>",
"template_type": "<string>",
"name": "<string>",
"is_active": true,
"settings": {},
"purchased_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"template": {
"id": "<string>",
"type": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"thumbnail": "<string>",
"status": "<string>",
"source_type": "<string>"
},
"template_version": {
"id": "<string>",
"version": "<string>"
},
"update_available": true
}
}{
"message": "<string>",
"errors": {}
}Customize a template's settings
Replaces the customization settings (such as display options) of a template, checked against what its version allows.
curl --request PUT \
--url https://api.exowpee.com/v1/template/company-templates/{companyTemplate}/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"settings": {}
}'import requests
url = "https://api.exowpee.com/v1/template/company-templates/{companyTemplate}/settings"
payload = { "settings": {} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({settings: {}})
};
fetch('https://api.exowpee.com/v1/template/company-templates/{companyTemplate}/settings', 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.exowpee.com/v1/template/company-templates/{companyTemplate}/settings",
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([
'settings' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.exowpee.com/v1/template/company-templates/{companyTemplate}/settings"
payload := strings.NewReader("{\n \"settings\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.exowpee.com/v1/template/company-templates/{companyTemplate}/settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"settings\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/template/company-templates/{companyTemplate}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"settings\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"company_id": "<string>",
"template_id": "<string>",
"template_version_id": "<string>",
"template_type": "<string>",
"name": "<string>",
"is_active": true,
"settings": {},
"purchased_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"template": {
"id": "<string>",
"type": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"thumbnail": "<string>",
"status": "<string>",
"source_type": "<string>"
},
"template_version": {
"id": "<string>",
"version": "<string>"
},
"update_available": true
}
}{
"message": "<string>",
"errors": {}
}company_templates.update
Conditions
- settings must be an object. Every key must exist in the configuration schema of the pinned version and each value must match the declared type.
- The settings payload may not exceed 64 KB.
- Replaces the whole settings map; keys left out go back to the defaults of the configuration schema.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Identifier of the company template, the company's own copy of a template (27-character KSUID string).
Body
Structural validation only — key/type validation against the pinned version's config schema happens in CompanyTemplateSettingsService (D6), where the schema is loaded once with the instance.
The complete set of customization values, as an object keyed by setting name. Replaces the existing settings. Each key must exist in the pinned version's configuration schema and the value must match its type (string, text, boolean, integer or number). At most 64 KB. Required.
Response
CompanyTemplateResource
Items of this page.
Show child attributes
Show child attributes