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

# Save partial or completed answers

> Signed-session, immutable-version answer validation with stable 12–128 byte idempotency_key. Same completed key/body/session retries replay; changed completed requests conflict. Single-use invitations serialize consumption. Profile consent applies only explicit mappings; anonymous matching phone/email cannot claim an existing contact. New consented lead creation leaves identity_verified false.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v2/forms/{publicCode}/responses
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,
    Customer CDP, Sales CRM, forms, appointments, inboxes, teams, agents, AI
    agents and knowledge, WhatsApp templates and broadcasts, workflows and chat
    menus. Authenticate 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: Agents
    description: The human agents on your account and their availability.
  - 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: 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: Forms
    description: >-
      Form management, assets, delivery, respondent sessions, submissions,
      scheduling, reports and AI-assisted authoring in one group.
  - 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: Sales CRM
    description: >-
      The full tenant-scoped Sales workspace: Leads, Companies, Deals, tasks,
      products, price books, quotes, payments, forecasts, reports and settings.
  - 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: Workflows
    description: >-
      Automation flows built from triggers and steps: route, tag, reply, wait,
      hand off. Create, publish, version and toggle.
paths:
  /api/v2/forms/{publicCode}/responses:
    parameters:
      - $ref: '#/components/parameters/publicCode'
    post:
      tags:
        - Forms
      summary: Save partial or completed answers
      description: >-
        Signed-session, immutable-version answer validation with stable 12–128
        byte idempotency_key. Same completed key/body/session retries replay;
        changed completed requests conflict. Single-use invitations serialize
        consumption. Profile consent applies only explicit mappings; anonymous
        matching phone/email cannot claim an existing contact. New consented
        lead creation leaves identity_verified false.
      operationId: postApiV2FormsPubliccodeResponses
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitResponse'
            example:
              session_id: signed-session
              invite: opaque-token
              idempotency_key: 2b17a03d-respondent-visit-1
              status: completed
              device: mobile
              profile_consent: true
              answers:
                csat: 5
                name: Mona
      responses:
        '200':
          description: Saved response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  status:
                    type: string
                    enum:
                      - partial
                      - completed
                  completed:
                    type: boolean
                  score:
                    type: number
                    description: Only completed quiz forms; recalculated by the server.
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '410':
          $ref: '#/components/responses/Gone'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/Unavailable'
      security: []
components:
  parameters:
    publicCode:
      name: publicCode
      in: path
      required: true
      schema:
        type: string
        minLength: 8
        maxLength: 24
  schemas:
    SubmitResponse:
      type: object
      required:
        - session_id
        - idempotency_key
        - answers
      properties:
        session_id:
          type: string
        invite:
          type: string
        idempotency_key:
          type: string
          minLength: 12
          maxLength: 128
        status:
          type: string
          enum:
            - partial
            - completed
          default: completed
        device:
          $ref: '#/components/schemas/Device'
        profile_consent:
          type: boolean
          default: false
          description: >-
            Separate consent to apply mapped fill_empty changes or, when
            enabled, create a new unverified lead.
        answers:
          type: object
          additionalProperties: true
          description: >-
            Question ID to canonical answer. Ranking: ordered options; matrix:
            row to column; signature: typed name. Files/video_audio use
            AssetReceipt; scheduler uses BookingReceipt; AI uses AIAnswer, all
            unchanged from native endpoints. Server proves ownership and
            recomputes logic/score.
      additionalProperties: false
    Device:
      type: string
      enum:
        - desktop
        - mobile
        - tablet
        - other
    Error:
      type: object
      properties:
        error:
          type: string
  responses:
    BadRequest:
      description: Malformed request, invalid ID/filter or unknown top-level field.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Invitation, session, membership, or consent requirement not met.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Form not found in the account or not publicly available.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Conflict:
      description: Stale version, duplicate response, or already used invitation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Gone:
      description: Published expiry or response cap reached.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationError:
      description: The request or definition is invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: >-
        Public admission, upload or AI quota exceeded. Reserved AI failures
        count.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unavailable:
      description: Dependency/configuration unavailable; fail closed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your personal access token where supported, or a scoped API key (`hc_…`)
        created inside HueChat at Account → Developer API. Send it as
        `Authorization: Bearer <token>`.

````