Skip to main content
PUT
Replace portal settings

Authorizations

X-Initdesk-Token
string
header
required

Path Parameters

organization_id
integer
required

Body

name
string
required
Required string length: 1 - 255
meta_description
string
Maximum string length: 160
allow_robots
boolean
template
enum<string>
  • sidebar - Sidebar
  • list - List
Available options:
sidebar,
list
logo
file | null
write-only
favicon
file | null
write-only
primary_color
string
Maximum string length: 7
is_active
boolean
enable_ticket_creation_form
boolean

Response

200 - application/json
id
integer
required
read-only
name
string
required
Maximum string length: 255
custom_domain
string
required
read-only

Optional custom domain for the portal (e.g. docs.example.com).

organization
object
required
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
meta_description
string
Maximum string length: 160
allow_robots
boolean
template
enum<string>
  • sidebar - Sidebar
  • list - List
Available options:
sidebar,
list
primary_color
string
Maximum string length: 7
is_active
boolean
enable_ticket_creation_form
boolean