Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hilos Conversation API

The Conversation API from Hilos — 2 operation(s) for conversation.

Hilos Conversation API is one of 6 APIs that Hilos publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Conversation. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 2 paths, and defines 15 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.hilos.io.

3 operations 2 paths 15 schemas 1 GET1 PATCH1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.hilos.io/api/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Hilos Conversation API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (tokenAuth). By default, every request must be authenticated.

  • tokenAuth — Token-based authentication with required prefix "Token"

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 GET, 1 PATCH, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Conversation 3
GET
/api/inbox/conversation
List Conversations
List Conversations 4 params → 200
PATCH
/api/inbox/conversation/{id}/update
Partially Update a Conversation
Partially update a Conversation 1 param body → 200
PUT
/api/inbox/conversation/{id}/update
Update a conversation
Update a Conversation 1 param body → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are WhatsAppMessageSimple (26 properties), ConversationReadSimple (10 properties), ConversationEdit (9 properties), PatchedConversationEdit (9 properties). Each schema is shown below with its type and property counts.

ConversationEdit
object
9 properties 5 required
MessageTypeEnum
string
ConversationTag
object
2 properties 2 required
UserRoleEnum
string
MessageStatusEnum
string
PatchedConversationEdit
object
9 properties
AccountMemberUserBasicEdit
object
1 property 1 required
MessageSourceEnum
string
ConversationSourceEnum
string
WhatsAppMessageSimple
object
26 properties 23 required
ConversationReadSimple
object
10 properties 7 required
ConversationStatusEnum
string
PaginatedConversationReadSimpleList
object
4 properties
SimpleUser
object
6 properties 1 required
AccountMemberUserBasicRead
object
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hilos-conversation-api-openapi.yml Raw ↑

Other APIs Hilos publishes across the network.

Hilos Contact API
Hilos Flow Execution API
Hilos Flow Execution Contact API
Hilos User API
Hilos WhatsApp API