> ## Documentation Index
> Fetch the complete documentation index at: https://developers.huechat.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create or safely replay an appointment

> Requires appointments:write. Select the appointment type by service_id or exact service_name; select a resource by resource_id/resource_name or omit it to use an eligible available resource. Supply starts_at in RFC3339 or local date plus time. The configured service duration determines ends_at, so ends_at is optional. Supplying contact_id also requires contacts:read; supplying deal_id also requires deals:write and UUID selectors. API-key callers must provide external_id; retrying the identical request returns the existing appointment without creating a duplicate.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments
openapi: 3.0.3
info:
  contact:
    name: HueChat support
    email: support@huechat.ai
    url: https://huechat.ai/contact
  description: >-
    Account-scoped REST API for HueChat: conversations, messages, contacts,
    inboxes, teams, agents, AI agents and knowledge, WhatsApp templates and
    broadcasts, workflows, chat menus, appointments and webhooks, authenticated
    with account-scoped API keys. Every route is scoped to your own account.
  license:
    name: Proprietary
    url: https://huechat.ai/terms
  termsOfService: https://huechat.ai/terms
  title: HueChat API
  version: 2.0.0
servers:
  - url: https://app.huechat.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: AI Agents
    description: >-
      Assistants you build to answer customers on their own: persona, language,
      guardrails, tools and a knowledge base, published to inboxes, replying in
      Arabic or English until they hand off to a human. Create, publish, test,
      monitor quality and roll back versions.
  - name: Agents
    description: The human agents on your account and their availability.
  - name: Broadcasts
    description: >-
      Send a WhatsApp template to a list of contacts from a CSV or saved
      audience, with scheduling, pause and resume, and delivery reports.
  - name: Chat Menus
    description: >-
      Numbered or button-driven menus a customer sees at the start of a
      conversation.
  - name: Contacts
    description: >-
      The people your team talks to: phone, email, name, custom attributes,
      labels and notes. One contact can have conversations on several channels.
  - name: Conversations
    description: >-
      A conversation is one thread between a contact and your team on one
      channel, with status, assignee, team, labels, priority and custom
      attributes. List, filter, search, assign, resolve and annotate them.
  - name: Inboxes
    description: >-
      Connected channels: a WhatsApp Business number, an Instagram or Messenger
      page, an email address or a website live-chat widget. Inboxes decide where
      a conversation comes from and who can see it.
  - name: Knowledge
    description: >-
      Documents, web pages and text that ground an AI agent's answers. Upload,
      point at a URL or paste text; HueChat indexes it and the agent cites it.
  - name: Messages
    description: >-
      Everything said inside a conversation: text, attachments, WhatsApp
      templates and interactive replies. Sending through the API delivers on the
      conversation's channel and shows in the inbox like any agent reply.
  - name: Outbound Webhooks
    description: >-
      Signed webhooks (v2): HMAC-SHA256 signature on every delivery, test
      events, delivery logs and secret rotation.
  - name: Teams
    description: Groups of agents used for assignment and reporting.
  - name: Templates
    description: >-
      Pre-approved WhatsApp message formats required by Meta for
      business-initiated messages. Create, sync from Meta, AI-generate,
      test-send and read analytics.
  - name: Webhooks
    description: >-
      Account webhooks (v1): a URL plus event subscriptions, as configured in
      the dashboard. Unsigned; prefer Outbound Webhooks for new integrations.
  - name: Workflows
    description: >-
      Automation flows built from triggers and steps: route, tag, reply, wait,
      hand off. Create, publish, version and toggle.
paths:
  /api/v2/accounts/{accountId}/appointments:
    post:
      tags:
        - Appointments
      summary: Create or safely replay an appointment
      description: >-
        Requires appointments:write. Select the appointment type by service_id
        or exact service_name; select a resource by resource_id/resource_name or
        omit it to use an eligible available resource. Supply starts_at in
        RFC3339 or local date plus time. The configured service duration
        determines ends_at, so ends_at is optional. Supplying contact_id also
        requires contacts:read; supplying deal_id also requires deals:write and
        UUID selectors. API-key callers must provide external_id; retrying the
        identical request returns the existing appointment without creating a
        duplicate.
      parameters:
        - description: HueChat account ID
          name: accountId
          in: path
          required: true
          schema:
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/huechat.appointmentCreateRequest'
        description: Appointment
        required: true
      responses:
        '200':
          description: OK
          headers:
            X-Idempotent-Replayed:
              description: true when an identical request returns the existing appointment
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.AppointmentResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.AppointmentAPIError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.AppointmentAPIError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.AppointmentAPIError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.AppointmentAPIError'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.AppointmentAPIError'
        '413':
          description: Request Entity Too Large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.AppointmentAPIError'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.AppointmentAPIError'
        '429':
          description: Too Many Requests
          headers:
            Retry-After:
              description: 60 seconds before retrying after the API key quota is exceeded
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.AppointmentAPIError'
        '503':
          description: Service Unavailable
          headers:
            Retry-After:
              description: >-
                0 when an interrupted deal-link reconciliation can be retried
                immediately; absent on other 503 responses
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.AppointmentAPIError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    huechat.appointmentCreateRequest:
      type: object
      properties:
        contact_id:
          type: integer
          example: 42
        customer_email:
          type: string
          example: customer@example.com
        customer_name:
          type: string
          example: Example Customer
        customer_phone:
          type: string
          example: '+966500000000'
        date:
          type: string
          example: '2026-09-15'
        deal_id:
          type: string
          format: uuid
          example: 00000000-0000-4000-8000-000000000003
        ends_at:
          type: string
          example: '2026-09-15T09:30:00Z'
        external_id:
          type: string
          maxLength: 128
          minLength: 1
          example: erp-appointment-10492
        notes:
          type: string
          example: Created from ERP
        resource_id:
          type: string
          example: 00000000-0000-4000-8000-000000000001
        resource_name:
          type: string
          example: Dr. Sara
        service_id:
          type: string
          example: 00000000-0000-4000-8000-000000000002
        service_name:
          type: string
          example: Initial consultation
        starts_at:
          type: string
          example: '2026-09-15T09:00:00Z'
        status:
          type: string
          enum:
            - tentative
            - booked
            - confirmed
          example: booked
        time:
          type: string
          example: '12:00'
    huechat.AppointmentResponse:
      type: object
      properties:
        account_id:
          type: integer
        buffer_after_minutes:
          type: integer
        buffer_before_minutes:
          type: integer
        busy_ends_at:
          type: string
          format: date-time
        busy_starts_at:
          type: string
          format: date-time
        cancellation_reason:
          type: string
        cancelled_at:
          type: string
          format: date-time
        completed_at:
          type: string
          format: date-time
        confirmed_at:
          type: string
          format: date-time
        contact_id:
          type: integer
        conversation_id:
          type: integer
        created_at:
          type: string
          format: date-time
        created_by_ai_agent_id:
          type: string
          format: uuid
        created_by_user_id:
          type: integer
        customer_email:
          type: string
        customer_name:
          type: string
        customer_phone:
          type: string
        duration_minutes:
          type: integer
        ends_at:
          type: string
          format: date-time
        external_id:
          type: string
        id:
          type: string
          format: uuid
        notes:
          type: string
        public_id:
          type: string
        resource_color:
          type: string
        resource_id:
          type: string
          format: uuid
        resource_name:
          type: string
        resource_type:
          type: string
        service_color:
          type: string
        service_currency:
          type: string
        service_description:
          type: string
        service_id:
          type: string
          format: uuid
        service_name:
          type: string
        service_price:
          type: number
        source:
          type: string
        starts_at:
          type: string
          format: date-time
        status:
          type: string
        updated_at:
          type: string
          format: date-time
        version:
          type: integer
    huechat.AppointmentAPIError:
      type: object
      properties:
        error:
          type: string
        limit:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your personal access token from Settings → Profile, or a scoped API key
        (`hc_…`) created at Settings → Developer → API keys. Send it as
        `Authorization: Bearer <token>`.

````