Skip to main content
POST
Add helpdesk domain

Authorizations

Authorization
string
header
required

Behalf of an Operator. The JWT issued by Talqui Core when an operator signs in. Send as Authorization: Bearer <jwt-token>.

Path Parameters

tenantID
string<uuid>
required

The tenant the help center belongs to.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
domainHostname
string
required

The full subdomain to register, such as help.yourcompany.com. Apex domains are rejected.

Required string length: 1 - 253

Response

Response for status 200.

cnameTarget
string
required
domain
object
required
statusReason
string
required