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

Respond.io Conversations API

Open, close, status, and assign conversations.

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

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

This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

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

2 operations 2 paths 2 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://api.respond.io/v2
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • bearerAuth — API Access Token from Settings Integrations Developer API, sent in the Authorization header as Bearer {token}.

Paths & Operations 2

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

Conversations 2

Open, close, status, and assign conversations.

POST
/contact/{identifier}/conversation
Open or close a conversation
updateConversationStatus 1 param body → 200429
POST
/contact/{identifier}/conversation/assignee
Assign or unassign a conversation
assignConversation 1 param body → 200429

Schemas 2

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

Conversation
object
5 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

respond-conversations-api-openapi.yml Raw ↑

Other APIs Respond.io publishes across the network.

Respond.io Comments API
Respond.io Contacts API
Respond.io Custom Fields API
Respond.io Messages API
Respond.io Tags API