Hellou AI

Hellou AI Custom Attributes API

The Custom Attributes API from Hellou AI — 2 operation(s) for custom attributes.

GitHub OpenAPI

Operations 5

GET /api/v1/accounts/{account_id}/custom_attribute_definitions List all custom attributes in an account #
POST /api/v1/accounts/{account_id}/custom_attribute_definitions Add a new custom attribute #
GET /api/v1/accounts/{account_id}/custom_attribute_definitions/{id} Get a custom attribute details #
PATCH /api/v1/accounts/{account_id}/custom_attribute_definitions/{id} Update custom attribute in Account #
DELETE /api/v1/accounts/{account_id}/custom_attribute_definitions/{id} Remove a custom attribute from account #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/hellou-ai/openapi/hellou-ai-custom-attributes-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-ai-call-report-schema.json
📊
JSONSchema
https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-voice-campaign-schema.json
📊
JSONSchema
https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-voice-campaign-report-stats-schema.json
📊
JSONSchema
https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-inbox-schema.json
📊
JSONSchema
https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-voice-campaign-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-call-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/hellou-ai:hellou-ai-custom-attributes-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hellou-ai-custom-attributes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: HellouOne Custom Attributes 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: Custom Attributes
paths:
  /api/v1/accounts/{account_id}/custom_attribute_definitions:
    parameters:
    - $ref: '#/components/parameters/account_id'
    get:
      tags:
      - Custom Attributes
      operationId: get-account-custom-attribute
      summary: List all custom attributes in an account
      parameters:
      - name: attribute_model
        in: query
        description: conversation_attribute(0)/contact_attribute(1)
        required: true
        schema:
          type: string
          enum:
          - '0'
          - '1'
      description: Get details of custom attributes in an Account
      security:
      - userApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                description: Array of all custom attributes
                items:
                  $ref: '#/components/schemas/custom_attribute'
        '403':
          description: Access denied
    post:
      tags:
      - Custom Attributes
      operationId: add-new-custom-attribute-to-account
      summary: Add a new custom attribute
      description: Add a new custom attribute to account
      security:
      - userApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_attribute'
        '403':
          description: Access denied
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom_attribute_create_update_payload'
  /api/v1/accounts/{account_id}/custom_attribute_definitions/{id}:
    parameters:
    - $ref: '#/components/parameters/account_id'
    - name: id
      in: path
      schema:
        type: number
      description: ID of the custom attribute
      required: true
    get:
      tags:
      - Custom Attributes
      operationId: get-details-of-a-single-custom-attribute
      summary: Get a custom attribute details
      description: Get the details of a custom attribute in the account
      parameters:
      - $ref: '#/components/parameters/account_id'
      - in: path
        name: id
        required: true
        description: The ID of the custom attribute to be updated.
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_attribute'
        '401':
          description: Unauthorized
        '404':
          description: The given attribute ID does not exist in the account
    patch:
      tags:
      - Custom Attributes
      operationId: update-custom-attribute-in-account
      summary: Update custom attribute in Account
      description: Update a custom attribute in account
      security:
      - userApiKey: []
      parameters:
      - in: path
        name: id
        required: true
        description: The ID of the custom attribute to be updated.
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                description: The updated custom attribute
                $ref: '#/components/schemas/custom_attribute'
        '404':
          description: Agent not found
        '403':
          description: Access denied
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom_attribute_create_update_payload'
    delete:
      tags:
      - Custom Attributes
      operationId: delete-custom-attribute-from-account
      summary: Remove a custom attribute from account
      security:
      - userApiKey: []
      parameters:
      - $ref: '#/components/parameters/account_id'
      - in: path
        name: id
        required: true
        description: The ID of the custom attribute to be deleted
        schema:
          type: integer
      responses:
        '200':
          description: Success
        '404':
          description: Custom attribute not found
        '403':
          description: Access denied
components:
  parameters:
    account_id:
      in: path
      name: account_id
      required: true
      description: The numeric ID of the account
      schema:
        type: integer
  schemas:
    custom_attribute_create_update_payload:
      type: object
      properties:
        attribute_display_name:
          type: string
          description: Attribute display name
        attribute_display_type:
          type: integer
          description: Attribute display type (text- 0, number- 1, currency- 2, percent- 3, link- 4, date- 5, list- 6, checkbox- 7)
        attribute_description:
          type: string
          description: Attribute description
        attribute_key:
          type: string
          description: Attribute unique key value
        attribute_values:
          type: array
          description: Attribute values
          items:
            type: string
        attribute_model:
          type: integer
          description: Attribute type(conversation_attribute- 0, contact_attribute- 1)
    custom_attribute:
      type: object
      properties:
        id:
          type: integer
          description: Identifier
        attribute_display_name:
          type: string
          description: Attribute display name
        attribute_display_type:
          type: string
          description: Attribute display type (text, number, currency, percent, link, date, list, checkbox)
        attribute_description:
          type: string
          description: Attribute description
        attribute_key:
          type: string
          description: Attribute unique key value
        attribute_values:
          type: string
          description: Attribute values
        default_value:
          type: string
          description: Attribute default value
        attribute_model:
          type: string
          description: Attribute type(conversation_attribute/contact_attribute)
        account_id:
          type: integer
          description: Account Id
  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