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

Charthop message API

The message API from Charthop — 7 operation(s) for message.

Charthop message API is one of 87 APIs that Charthop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 7 operations across 7 paths, and defines 6 schemas. It is described by OpenAPI 2.0, at version V1.0.0.

Requests are made against the base URL https://api.charthop.com.

7 operations 7 paths 6 schemas 3 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
V1.0.0
Base URL
https://api.charthop.com
Contact
Resource Areas
1

Paths & Operations 7

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

message 7
POST
/v1/org/{orgId}/message
Create a new message
createMessage 2 params → 201400401403
POST
/v1/org/{orgId}/message/bulk/read
Sets each of the designated message's readAt property
bulkMarkAsRead 2 params → 401
POST
/v1/org/{orgId}/message/bulk/seen
Marks each message as seen
bulkMarkAsSeen 2 params → 401
GET
/v1/org/{orgId}/message/me
Return all messages for a particular user
me 5 params → 200401
GET
/v1/org/{orgId}/message/me/{messageKey}
Return a particular message by key
getMessageByKey 2 params → 200401
GET
/v1/org/{orgId}/message/{messageId}
Return a particular message by id
getMessage 2 params → 200401
POST
/v1/org/{orgId}/message/{messageId}/read
Sets the designated message's readAt property
markAsRead 2 params → 401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are PartialMessage (15 properties), Message (15 properties), Attribution (6 properties), ResultsMessage (3 properties). Each schema is shown below with its type and property counts.

AccessAction
object
3 properties 1 required
ResultsAccess
object
2 properties 1 required
Message
object
15 properties 6 required
Attribution
object
6 properties
ResultsMessage
object
3 properties 1 required
PartialMessage
object
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-message-api-openapi.yml Raw ↑

Other APIs Charthop publishes across the network.

Charthop access API
Charthop action API
Charthop ai API
Charthop ai-credit-limit API
Charthop ai-hint API
Charthop ai-prompt API
Charthop app API
Charthop appConfig API
Charthop approval API
Charthop approval-delegate API
Charthop approval-request API
Charthop assessment API