Hellou AI Help Center API

openapi: 3.2.0
info:
  title: HellouOne Help Center API
  version: 1.0.0
  description: 'The HellouOne REST API: everything the dashboard does, available to your

    own systems — CRMs, bots, BI tools and back-office automation.'
  termsOfService: https://hellou.ai/en/legal/terms/
  contact:
    name: HellouOne support
    email: support@hellou.ai
servers:
- url: https://one.hellou.ai
  description: HellouOne cloud
security:
- userApiKey: []
tags:
- name: Help Center
paths:
  /api/v1/accounts/{account_id}/portals:
    parameters:
    - $ref: '#/components/parameters/account_id'
    post:
      tags:
      - Help Center
      operationId: add-new-portal-to-account
      summary: Add a new portal
      description: 'Add a new portal to account


        **Requires feature:** `help_center`'
      x-required-feature: help_center
      security:
      - userApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portal'
        '403':
          $ref: '#/components/responses/forbidden'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/portal_create_update_payload'
    get:
      tags:
      - Help Center
      operationId: get-portal
      summary: List all portals in an account
      parameters:
      - $ref: '#/components/parameters/account_id'
      description: 'Get details of portals in an Account


        **Requires feature:** `help_center`'
      x-required-feature: help_center
      security:
      - userApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                description: Array of all portals
                items:
                  $ref: '#/components/schemas/portal'
        '403':
          $ref: '#/components/responses/forbidden'
  /api/v1/accounts/{account_id}/portals/{portal_slug}:
    parameters:
    - $ref: '#/components/parameters/account_id'
    - $ref: '#/components/parameters/portal_slug'
    patch:
      tags:
      - Help Center
      operationId: update-portal
      summary: Update a portal
      description: 'Update a help center portal: its name, slug, header, colour, custom domain or locales.


        **Requires feature:** `help_center`'
      x-required-feature: help_center
      security:
      - userApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portal'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          description: Portal not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/portal_create_update_payload'
    delete:
      tags:
      - Help Center
      operationId: delete-portal
      summary: Delete a portal
      description: 'Deletes a help center portal with its categories and articles.


        **Requires feature:** `help_center`'
      x-required-feature: help_center
      security:
      - userApiKey: []
      responses:
        '200':
          description: Success
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          description: Portal not found
  /api/v1/accounts/{account_id}/portals/{portal_id}/categories:
    parameters:
    - $ref: '#/components/parameters/account_id'
    - $ref: '#/components/parameters/portal_id'
    post:
      tags:
      - Help Center
      operationId: add-new-category-to-account
      summary: Add a new category
      description: 'Add a new category to portal


        **Requires feature:** `help_center`'
      x-required-feature: help_center
      security:
      - userApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/category'
        '403':
          $ref: '#/components/responses/forbidden'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/category_create_update_payload'
  /api/v1/accounts/{account_id}/portals/{portal_slug}/categories/{category_id}:
    parameters:
    - $ref: '#/components/parameters/account_id'
    - $ref: '#/components/parameters/portal_slug'
    - $ref: '#/components/parameters/category_id'
    patch:
      tags:
      - Help Center
      operationId: update-category
      summary: Update a category
      description: 'Update a category of a portal


        **Requires feature:** `help_center`'
      x-required-feature: help_center
      security:
      - userApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  payload:
                    $ref: '#/components/schemas/category'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          description: Category not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/category_create_update_payload'
    delete:
      tags:
      - Help Center
      operationId: delete-category
      summary: Delete a category
      description: 'Deletes a category of a portal.


        **Requires feature:** `help_center`'
      x-required-feature: help_center
      security:
      - userApiKey: []
      responses:
        '200':
          description: Success
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          description: Category not found
  /api/v1/accounts/{account_id}/portals/{portal_id}/articles:
    parameters:
    - $ref: '#/components/parameters/account_id'
    - $ref: '#/components/parameters/portal_id'
    post:
      tags:
      - Help Center
      operationId: add-new-article-to-account
      summary: Add a new article
      description: 'Add a new article to portal


        **Requires feature:** `help_center`'
      x-required-feature: help_center
      security:
      - userApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/article'
        '403':
          $ref: '#/components/responses/forbidden'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/article_create_update_payload'
components:
  parameters:
    category_id:
      in: path
      name: category_id
      required: true
      description: The ID of the category
      schema:
        type: integer
    account_id:
      in: path
      name: account_id
      required: true
      description: The numeric ID of the account
      schema:
        type: integer
    portal_id:
      in: path
      name: portal_id
      required: true
      description: The slug of the portal, as it appears in its help center link (the parameter keeps its historical name)
      schema:
        type: string
    portal_slug:
      in: path
      name: portal_slug
      required: true
      description: The slug of the portal, as it appears in its help center link
      schema:
        type: string
  schemas:
    article_create_update_payload:
      type: object
      properties:
        content:
          type: string
          description: The text content.
        meta:
          type: object
          description: Use for search
          example:
            tags:
            - article_name
            title: article title
            description: article description
        position:
          type: integer
          description: article position in category
        status:
          type: integer
          example:
          - draft
          - published
          - archived
        title:
          type: string
        slug:
          type: string
        views:
          type: integer
        author_id:
          type: integer
        category_id:
          type: integer
        folder_id:
          type: integer
        associated_article_id:
          type: integer
          description: To associate similar articles to each other, e.g to provide the link for the reference.
    portal:
      type: object
      properties:
        id:
          type: integer
        archived:
          type: boolean
        color:
          type: string
        config:
          type: object
          description: Save information about locales, allowed_locales and default portal/help-center locale
        custom_domain:
          type: string
        header_text:
          type: string
          description: The text content.
        homepage_link:
          type: string
        name:
          type: string
        slug:
          type: string
        page_title:
          type: string
        account_id:
          type: integer
        categories:
          type: array
          items:
            $ref: '#/components/schemas/category'
        articles:
          type: array
          items:
            $ref: '#/components/schemas/article'
    portal_create_update_payload:
      type: object
      properties:
        archived:
          type: boolean
          description: Status to check if portal is live
        color:
          type: string
          description: Header color for help-center
          example: add color HEX string, "#fffff"
        config:
          type: object
          description: Configuration about supporting locales
          example:
            allowed_locales:
            - en
            - es
            default_locale: en
        custom_domain:
          type: string
          description: Custom domain to  display help center.
          example: https://help.example.com
        header_text:
          type: string
          description: Help center header
          example: Handbook
        homepage_link:
          type: string
          description: link to main dashboard
          example: https://www.example.com
        name:
          type: string
          description: Name for the portal
        slug:
          type: string
          description: Slug for the portal to display in link
        page_title:
          type: string
          description: Page title for the portal
        account_id:
          type: integer
    error_message:
      type: object
      description: An error with a human-readable message.
      properties:
        error:
          type: string
          description: What went wrong.
        reason:
          type: string
          description: Machine-readable cause, when there is one (for example `feature_disabled`).
      required:
      - error
    category:
      type: object
      properties:
        id:
          type: integer
        description:
          type: string
          description: The text content.
        locale:
          type: string
        name:
          type: string
        slug:
          type: string
        position:
          type: integer
        portal_id:
          type: integer
        account_id:
          type: integer
        associated_category_id:
          type: integer
          description: To associate similar categories to each other, e.g same category of product documentation in different languages
        parent_category_id:
          type: integer
          description: To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.
    category_create_update_payload:
      type: object
      properties:
        description:
          type: string
          description: Category description
        locale:
          type: string
          description: Category locale
          example: en/es
        name:
          type: string
          description: Category name
        slug:
          type: string
          description: Category slug
        position:
          type: integer
          description: Category position in the portal list to sort
        associated_category_id:
          type: integer
          description: To associate similar categories to each other, e.g same category of product documentation in different languages
        parent_category_id:
          type: integer
          description: To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.
    article:
      type: object
      properties:
        id:
          type: integer
        content:
          type: string
          description: The text content.
        meta:
          type: object
        position:
          type: integer
        status:
          type: integer
          enum:
          - draft
          - published
          - archived
        title:
          type: string
        slug:
          type: string
        views:
          type: integer
        portal_id:
          type: integer
        account_id:
          type: integer
        author_id:
          type: integer
        category_id:
          type: integer
        folder_id:
          type: integer
        associated_article_id:
          type: integer
          description: To associate similar articles to each other, e.g to provide the link for the reference.
  responses:
    forbidden:
      description: 'Not allowed: the user''s role does not permit it, the feature is not enabled

        for the account (`reason: feature_disabled`), or the account is read-only.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_message'
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: 'A user''s access token, from **Profile settings → Access token** in the dashboard.

        Requests act with that user''s role: administrators reach everything in their

        account, agents only what their role and visibility settings allow.

        '
    agentBotApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: 'An agent bot''s access token, shown to administrators on the bot''s settings page.

        Bot tokens reach a limited set of conversation and message endpoints.

        '
    platformAppApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: 'A platform app token, issued by the installation operator. Used to provision

        accounts, users, account memberships and agent bots.

        '
    connectorInvokeToken:
      type: http
      scheme: bearer
      description: 'A connector''s invoke token (`hci_…`), sent as `Authorization: Bearer <token>`.

        Each connector install has its own; it is rotated whenever the connector is

        reconnected or disconnected, so a stale copy stops working.

        '
x-tagGroups:
- name: Guides
  tags:
  - Introduction
  - Authentication
  - Errors
  - Pagination
  - Rate limits
  - Webhook events
- name: Webhook payloads
  tags:
  - Event payloads
- name: Platform
  tags:
  - Accounts
  - Account Users
  - AgentBots
  - Users
- name: Application
  tags:
  - Account AgentBots
  - Agents
  - Automation Rule
  - Campaigns
  - Canned Responses
  - Contacts
  - Contact Labels
  - Conversation Assignment
  - Conversation Labels
  - Conversations
  - Custom Attributes
  - Custom Filters
  - Help Center
  - Inboxes
  - Integrations
  - Macros
  - Messages
  - Profile
  - Reports
  - Security Settings
  - Teams
  - Webhooks
- name: Business tools
  tags:
  - AI Classifications
  - Assignment Settings
  - Calls
  - AI Phone Lines
  - Connectors
  - ElevenLabs Integration
  - Facebook Marketing
  - HellouAI Integration
  - Knowledge Base
  - Marketing Consent
  - Plan Upgrades
  - Voice Campaigns
  - WhatsApp Campaigns
  - WhatsApp Flows
  - WhatsApp Templates
- name: Client
  tags:
  - Inbox API
  - Contacts API
  - Conversations API
  - Messages API
- name: Others
  tags:
  - CSAT Survey Page