Skip to main content
PATCH
Update custom domain for a help center

Authorizations

x-api-key
string
header
required

Enter your API key

Path Parameters

helpCenterId
string
required

Help Center ID in MongoDB ObjectId format

Example:

"507f1f77bcf86cd799439011"

Body

application/json

Custom domain update payload

defaultDomain
string
required

Default subdomain

Pattern: ^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$
Example:

"support"

customDomain
string
required

Custom domain

Pattern: ^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.(?:[a-zA-Z0-9-]{1,63}\.)+[a-zA-Z]{2,}$
Example:

"help.thena.ai"

Response

200 - application/json

Custom domain updated successfully

data
object
required

Help center data

message
string
required

Response message

Example:

"Help center updated successfully."