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

Kustomer Conversations API

Conversation threads with customers

Kustomer Conversations API is one of 2 APIs that Kustomer publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Conversations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an AsyncAPI specification.

This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://api.kustomerapp.com.

1 operations 1 paths 2 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.kustomerapp.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Kustomer Conversations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Provide an API key issued from Settings Security API Keys in the Kustomer console. Header format: Authorization: Bearer {APIKEY}.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Conversations 1

Conversation threads with customers

POST
/v1/conversations
Create a conversation
createConversation body → 200401422

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ConversationCreate (4 properties), ConversationResponse (3 properties). Each schema is shown below with its type and property counts.

ConversationResponse
object
3 properties
ConversationCreate
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kustomer-conversations-api-openapi.yml Raw ↑

Other APIs Kustomer publishes across the network.

Kustomer Customers API