> ## 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.

# Refresh helpdesk domain

> Re-checks the domain's provisioning state against Cloudflare on demand —
the "Verify again" button. Idempotent: while the CNAME is not in place the
domain stays `pending` with a pt-BR `statusReason` explaining what is
missing; once Cloudflare reports the hostname and its certificate active,
the domain turns `active` and `verifiedAt` is stamped. Throttled
server-side to one check per domain every 10 seconds.



## OpenAPI

````yaml /api/helpdesk.yaml post /v1/tenants/{tenantID}/helpdesk/domains/{domainHostname}/refresh
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.10.0
servers:
  - description: Production
    url: https://plugins-api.talqui.chat/helpdesk
security: []
tags:
  - name: Install
  - name: Public
  - name: Helpdesk
  - name: Helpdesk/Domains
  - name: Categories
  - name: Articles
paths:
  /v1/tenants/{tenantID}/helpdesk/domains/{domainHostname}/refresh:
    post:
      tags:
        - Helpdesk/Domains
      summary: Refresh helpdesk domain
      description: >-
        Re-checks the domain's provisioning state against Cloudflare on demand —

        the "Verify again" button. Idempotent: while the CNAME is not in place
        the

        domain stays `pending` with a pt-BR `statusReason` explaining what is

        missing; once Cloudflare reports the hostname and its certificate
        active,

        the domain turns `active` and `verifiedAt` is stamped. Throttled

        server-side to one check per domain every 10 seconds.
      operationId: RefreshHelpdeskDomainController
      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
        - in: path
          name: domainHostname
          required: true
          schema:
            description: The custom domain hostname, exactly as it was registered.
            maxLength: 253
            minLength: 1
            type: string
      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'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            MissingTenantIDError (error_code 1001): tenantID absent from the
            URL. | RequestValidationError (error_code 1002): params fail schema
            validation.
        '404':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      oneOf:
                        - $ref: '#/components/schemas/HelpdeskNotFoundError'
                        - $ref: '#/components/schemas/DomainNotFoundError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            HelpdeskNotFoundError (error_code 1107): the tenant has no help
            center yet. | DomainNotFoundError (error_code 1120): the hostname is
            not registered on this 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.
        '429':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/DomainRefreshThrottledError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            DomainRefreshThrottledError (error_code 1121): a verification for
            this domain ran less than 10 seconds ago.
        '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 failed to
            answer the check.
      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
    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
    DomainNotFoundError:
      additionalProperties: false
      properties:
        error:
          enum:
            - DomainNotFoundError
          type: string
        error_code:
          enum:
            - 1120
          type: number
        message:
          example: This domain is not registered on this help center.
          type: string
        statusCode:
          enum:
            - 404
          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
    DomainRefreshThrottledError:
      additionalProperties: false
      properties:
        error:
          enum:
            - DomainRefreshThrottledError
          type: string
        error_code:
          enum:
            - 1121
          type: number
        message:
          example: >-
            This domain was verified a moment ago. Wait a few seconds and try
            again.
          type: string
        statusCode:
          enum:
            - 429
          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 <jwt-token>`.
      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.