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

Chatwork Messages API

The Messages API from Chatwork — 4 operation(s) for messages.

Chatwork Messages API is one of 9 APIs that Chatwork publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 7 operations across 4 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2.

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

7 operations 4 paths 1 schemas 1 DELETE2 GET1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2
Base URL
https://api.chatwork.com/v2
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Chatwork Messages API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-ChatWorkToken (chatworkToken). By default, every request must be authenticated.

  • chatworkToken — API token issued from your Chatwork account settings.

Paths & Operations 7

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

Messages 7
GET
/rooms/{room_id}/messages
List messages in a room
listRoomMessages 2 params → 200
POST
/rooms/{room_id}/messages
Post a new message in a room
postRoomMessage 1 param body → 200
PUT
/rooms/{room_id}/messages/read
Mark messages in a room as read
markRoomRead 1 param → 200
PUT
/rooms/{room_id}/messages/unread
Mark messages in a room as unread from a message
markRoomUnread 1 param → 200
GET
/rooms/{room_id}/messages/{message_id}
Retrieve a message
getMessage 2 params → 200
PUT
/rooms/{room_id}/messages/{message_id}
Update a message
updateMessage 2 params body → 200
DELETE
/rooms/{room_id}/messages/{message_id}
Delete a message
deleteMessage 2 params → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Message (5 properties). Each schema is shown below with its type and property counts.

Message
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chatwork-messages-api-openapi.yml Raw ↑

Other APIs Chatwork publishes across the network.

Chatwork Contacts API
Chatwork Files API
Chatwork Incoming Requests API
Chatwork Link API
Chatwork Me API
Chatwork Members API
Chatwork Rooms API
Chatwork Tasks API