> ## Documentation Index > Fetch the complete documentation index at: https://docs.talqui.chat/llms.txt > Use this file to discover all available pages before exploring further. # Add helpdesk domain > Registers a branded custom domain for the help center: pre-registers the hostname as a Cloudflare custom hostname and stores it as `pending`. The response carries the fixed CNAME target the customer must point the domain's DNS at — the target is a constant of this API, identical for every domain — plus a human-readable `statusReason` in pt-BR. Follow up with the refresh endpoint after the CNAME is in place. ## OpenAPI ````yaml /api/helpdesk.yaml post /v1/tenants/{tenantID}/helpdesk/domains openapi: 3.0.3 info: description: >- Help center API for the Talqui Helpdesk plugin. Two surfaces with different audiences: authenticated authoring routes under /v1/tenants/:tenantID, and anonymous public reads under /v1/public resolved from the request hostname. license: name: ISC url: https://opensource.org/license/isc-license-txt title: Talqui Helpdesk API version: 0.9.0 servers: - description: Production url: https://plugins-api.talqui.chat/helpdesk security: [] tags: - name: Install - name: Public - name: Helpdesk - name: Categories - name: Articles paths: /v1/tenants/{tenantID}/helpdesk/domains: post: tags: - Helpdesk summary: Add helpdesk domain description: |- Registers a branded custom domain for the help center: pre-registers the hostname as a Cloudflare custom hostname and stores it as `pending`. The response carries the fixed CNAME target the customer must point the domain's DNS at — the target is a constant of this API, identical for every domain — plus a human-readable `statusReason` in pt-BR. Follow up with the refresh endpoint after the CNAME is in place. operationId: AddHelpdeskDomainController parameters: - in: path name: tenantID required: true schema: description: The tenant the help center belongs to. format: uuid 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)$ type: string requestBody: content: application/json: schema: properties: domainHostname: description: >- The full subdomain to register, such as help.yourcompany.com. Apex domains are rejected. maxLength: 253 minLength: 1 type: string required: - domainHostname type: object required: true responses: '200': content: application/json: schema: additionalProperties: false properties: cnameTarget: type: string domain: additionalProperties: false properties: domainCloudflareID: nullable: true type: string domainHostname: type: string domainStatus: enum: - pending - active - failed type: string lastCheckedAt: format: date-time nullable: true pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ type: string verifiedAt: format: date-time nullable: true pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ type: string required: - domainHostname - domainStatus - domainCloudflareID - verifiedAt - lastCheckedAt type: object statusReason: type: string required: - domain - statusReason - cnameTarget type: object description: Response for status 200. '400': content: application/json: schema: properties: errors: items: oneOf: - $ref: '#/components/schemas/MissingTenantIDError' - $ref: '#/components/schemas/RequestValidationError' - $ref: '#/components/schemas/InvalidDomainHostnameError' maxItems: 1 minItems: 1 type: array required: - errors type: object description: >- MissingTenantIDError (error_code 1001): tenantID absent from the URL. | RequestValidationError (error_code 1002): body or params fail schema validation. | InvalidDomainHostnameError (error_code 1118): not a valid subdomain (apex, malformed, or a talqui.chat address). '404': content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/HelpdeskNotFoundError' maxItems: 1 minItems: 1 type: array required: - errors type: object description: >- HelpdeskNotFoundError (error_code 1107): the tenant has no help center yet. '409': content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/DomainAlreadyExistsError' maxItems: 1 minItems: 1 type: array required: - errors type: object description: >- DomainAlreadyExistsError (error_code 1119): the hostname is already registered on a help center. '422': content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/TenantNotConnectedError' maxItems: 1 minItems: 1 type: array required: - errors type: object description: >- TenantNotConnectedError (error_code 1000): the tenant is not connected to the plugin. '500': content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/UnknownError' maxItems: 1 minItems: 1 type: array required: - errors type: object description: >- UnknownError (error_code 5999): Unexpected internal error not otherwise documented for this endpoint. '502': content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/DomainProvisioningError' maxItems: 1 minItems: 1 type: array required: - errors type: object description: >- DomainProvisioningError (error_code 1122): Cloudflare refused or failed the registration. security: - operatorAuth: [] - pluginConnectionAuth: [] - pluginAuth: [] components: schemas: MissingTenantIDError: additionalProperties: false properties: error: enum: - MissingTenantIDError type: string error_code: enum: - 1001 type: number message: example: tenantID is required. type: string statusCode: enum: - 400 type: number required: - statusCode - error - error_code - message type: object RequestValidationError: additionalProperties: false properties: error: enum: - RequestValidationError type: string error_code: enum: - 1002 type: number fields: items: additionalProperties: false properties: allowed: type: string field: type: string received: type: string required: - field - received - allowed type: object type: array message: example: Invalid request data. type: string statusCode: enum: - 400 type: number required: - statusCode - error - error_code - message - fields type: object InvalidDomainHostnameError: additionalProperties: false properties: error: enum: - InvalidDomainHostnameError type: string error_code: enum: - 1118 type: number message: example: >- This is not a valid custom domain. Use a full subdomain such as help.yourcompany.com. type: string statusCode: enum: - 400 type: number required: - statusCode - error - error_code - message type: object HelpdeskNotFoundError: additionalProperties: false properties: error: enum: - HelpdeskNotFoundError type: string error_code: enum: - 1107 type: number message: example: No help center answers on this address. type: string statusCode: enum: - 404 type: number required: - statusCode - error - error_code - message type: object DomainAlreadyExistsError: additionalProperties: false properties: error: enum: - DomainAlreadyExistsError type: string error_code: enum: - 1119 type: number message: example: This domain is already registered. type: string statusCode: enum: - 409 type: number required: - statusCode - error - error_code - message type: object TenantNotConnectedError: additionalProperties: false properties: error: enum: - TenantNotConnectedError type: string error_code: enum: - 1000 type: number message: example: This tenant is not connected to the plugin. type: string statusCode: enum: - 422 type: number required: - statusCode - error - error_code - message type: object UnknownError: additionalProperties: false properties: error: enum: - UnknownError type: string error_code: enum: - 5999 type: number message: example: For some unknown reason your request has not succeeded. type: string statusCode: enum: - 500 type: number required: - statusCode - error - error_code - message type: object DomainProvisioningError: additionalProperties: false properties: error: enum: - DomainProvisioningError type: string error_code: enum: - 1122 type: number message: example: >- The domain provisioning provider failed to answer. Try again in a moment. type: string statusCode: enum: - 502 type: number required: - statusCode - error - error_code - message type: object securitySchemes: operatorAuth: bearerFormat: JWT description: >- Behalf of an Operator. The JWT issued by Talqui Core when an operator signs in. Send as `Authorization: Bearer `. scheme: bearer type: http pluginConnectionAuth: description: >- Behalf of a Plugin Connection. Issued when the Helpdesk plugin is installed on a tenant; scoped strictly to that one tenant. Send as `Authorization: PluginConnection base64(pluginConnectionID:pluginConnectionToken)`. in: header name: Authorization type: apiKey pluginAuth: description: >- Behalf of the Helpdesk plugin itself, reaching every tenant that installed it. Send as `Authorization: Plugin base64(pluginID:pluginToken)`. in: header name: Authorization type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.