Help Center
Replace portal settings
Replace all portal settings for the organization (full update).
PUT
/
organizations
/
{organization_id}
/
portal
/
Replace portal settings
curl --request PUT \
--url https://api.initdesk.com/organizations/{organization_id}/portal/ \
--header 'Content-Type: application/json' \
--header 'X-Initdesk-Token: <api-key>' \
--data '
{
"name": "<string>",
"meta_description": "<string>",
"allow_robots": true,
"logo": "<string>",
"favicon": "<string>",
"primary_color": "<string>",
"is_active": true,
"enable_ticket_creation_form": true
}
'import requests
url = "https://api.initdesk.com/organizations/{organization_id}/portal/"
payload = {
"name": "<string>",
"meta_description": "<string>",
"allow_robots": True,
"logo": "<string>",
"favicon": "<string>",
"primary_color": "<string>",
"is_active": True,
"enable_ticket_creation_form": True
}
headers = {
"X-Initdesk-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Initdesk-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
meta_description: '<string>',
allow_robots: true,
logo: '<string>',
favicon: '<string>',
primary_color: '<string>',
is_active: true,
enable_ticket_creation_form: true
})
};
fetch('https://api.initdesk.com/organizations/{organization_id}/portal/', 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.initdesk.com/organizations/{organization_id}/portal/",
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([
'name' => '<string>',
'meta_description' => '<string>',
'allow_robots' => true,
'logo' => '<string>',
'favicon' => '<string>',
'primary_color' => '<string>',
'is_active' => true,
'enable_ticket_creation_form' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Initdesk-Token: <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.initdesk.com/organizations/{organization_id}/portal/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"allow_robots\": true,\n \"logo\": \"<string>\",\n \"favicon\": \"<string>\",\n \"primary_color\": \"<string>\",\n \"is_active\": true,\n \"enable_ticket_creation_form\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Initdesk-Token", "<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.initdesk.com/organizations/{organization_id}/portal/")
.header("X-Initdesk-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"allow_robots\": true,\n \"logo\": \"<string>\",\n \"favicon\": \"<string>\",\n \"primary_color\": \"<string>\",\n \"is_active\": true,\n \"enable_ticket_creation_form\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.initdesk.com/organizations/{organization_id}/portal/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Initdesk-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"allow_robots\": true,\n \"logo\": \"<string>\",\n \"favicon\": \"<string>\",\n \"primary_color\": \"<string>\",\n \"is_active\": true,\n \"enable_ticket_creation_form\": true\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"custom_domain": "<string>",
"organization": {
"id": 123,
"public_id": "<string>",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": 123,
"email": "jsmith@example.com",
"name": "<string>"
},
"support_email": "jsmith@example.com",
"deletion_plan": {
"inactivity_detected_at": "2023-11-07T05:31:56Z",
"deletion_at": "2023-11-07T05:31:56Z"
},
"subscription": {
"plan_name": "<string>",
"plan_metric": "<string>",
"renews_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"trial_ends_at": "2023-11-07T05:31:56Z",
"trial_days_remaining": 123,
"has_access_enabled": true
},
"customer_max_inactivity_period": 0,
"customer_inactivity_reminder_period": 0,
"site_url": "<string>",
"description": "<string>",
"email_from_name": "<string>",
"email_subject_prefix": "<string>",
"enable_csat": true,
"enable_auto_tagging": true,
"enable_cc_email_routing": true
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"meta_description": "<string>",
"allow_robots": true,
"primary_color": "<string>",
"is_active": true,
"enable_ticket_creation_form": true
}Authorizations
Path Parameters
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Required string length:
1 - 255Maximum string length:
160sidebar- Sidebarlist- List
Available options:
sidebar, list Maximum string length:
7Response
200 - application/json
Maximum string length:
255Optional custom domain for the portal (e.g. docs.example.com).
Show child attributes
Show child attributes
Maximum string length:
160sidebar- Sidebarlist- List
Available options:
sidebar, list Maximum string length:
7Was this page helpful?
⌘I
Replace portal settings
curl --request PUT \
--url https://api.initdesk.com/organizations/{organization_id}/portal/ \
--header 'Content-Type: application/json' \
--header 'X-Initdesk-Token: <api-key>' \
--data '
{
"name": "<string>",
"meta_description": "<string>",
"allow_robots": true,
"logo": "<string>",
"favicon": "<string>",
"primary_color": "<string>",
"is_active": true,
"enable_ticket_creation_form": true
}
'import requests
url = "https://api.initdesk.com/organizations/{organization_id}/portal/"
payload = {
"name": "<string>",
"meta_description": "<string>",
"allow_robots": True,
"logo": "<string>",
"favicon": "<string>",
"primary_color": "<string>",
"is_active": True,
"enable_ticket_creation_form": True
}
headers = {
"X-Initdesk-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Initdesk-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
meta_description: '<string>',
allow_robots: true,
logo: '<string>',
favicon: '<string>',
primary_color: '<string>',
is_active: true,
enable_ticket_creation_form: true
})
};
fetch('https://api.initdesk.com/organizations/{organization_id}/portal/', 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.initdesk.com/organizations/{organization_id}/portal/",
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([
'name' => '<string>',
'meta_description' => '<string>',
'allow_robots' => true,
'logo' => '<string>',
'favicon' => '<string>',
'primary_color' => '<string>',
'is_active' => true,
'enable_ticket_creation_form' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Initdesk-Token: <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.initdesk.com/organizations/{organization_id}/portal/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"allow_robots\": true,\n \"logo\": \"<string>\",\n \"favicon\": \"<string>\",\n \"primary_color\": \"<string>\",\n \"is_active\": true,\n \"enable_ticket_creation_form\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Initdesk-Token", "<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.initdesk.com/organizations/{organization_id}/portal/")
.header("X-Initdesk-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"allow_robots\": true,\n \"logo\": \"<string>\",\n \"favicon\": \"<string>\",\n \"primary_color\": \"<string>\",\n \"is_active\": true,\n \"enable_ticket_creation_form\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.initdesk.com/organizations/{organization_id}/portal/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Initdesk-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"allow_robots\": true,\n \"logo\": \"<string>\",\n \"favicon\": \"<string>\",\n \"primary_color\": \"<string>\",\n \"is_active\": true,\n \"enable_ticket_creation_form\": true\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"custom_domain": "<string>",
"organization": {
"id": 123,
"public_id": "<string>",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": 123,
"email": "jsmith@example.com",
"name": "<string>"
},
"support_email": "jsmith@example.com",
"deletion_plan": {
"inactivity_detected_at": "2023-11-07T05:31:56Z",
"deletion_at": "2023-11-07T05:31:56Z"
},
"subscription": {
"plan_name": "<string>",
"plan_metric": "<string>",
"renews_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"trial_ends_at": "2023-11-07T05:31:56Z",
"trial_days_remaining": 123,
"has_access_enabled": true
},
"customer_max_inactivity_period": 0,
"customer_inactivity_reminder_period": 0,
"site_url": "<string>",
"description": "<string>",
"email_from_name": "<string>",
"email_subject_prefix": "<string>",
"enable_csat": true,
"enable_auto_tagging": true,
"enable_cc_email_routing": true
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"meta_description": "<string>",
"allow_robots": true,
"primary_color": "<string>",
"is_active": true,
"enable_ticket_creation_form": true
}