API Docs
Message API
Management API
Message API
Management API
xID for Developers
SmartPOST 管理画面
  1. Message API
  • SmartPOST Message API 概要
  • listAccountSubscriptions
    GET
  • healthcheck
    GET
  • listMessages
    GET
  • getMessage
    GET
  • getImageUrls
    GET
  • updateMessageStatusToRead
    POST
  • getPdfUrl
    GET
  1. Message API

updateMessageStatusToRead

POST
/v1/messages/{id}/read
getMessageのリクエストの際にchange-read-status: falseでレスポンスを取得する場合、クライアントサービスにおいてユーザーがメッセージを開くタイミングで本APIのリクエストをお願いします。対象のメッセージのmessage_idを使用してリクエストすると、SmartPOSTサービス上における当メッセージの既読時刻(api_read_at)が入力されます。

リクエストパラメータ

Authorization
Headerにパラメータ
Authorization
を追加し、その値にはBearerの後にTokenを連結します
例:
Authorization: Bearer ********************
パスパラメータ

Headerパラメータ

リクエストコードサンプル

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
リクエストリクエストExample
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.smartpost.jp/v1/messages/00000000-0000-0000-0000-acc000000001_00000000-0000-0000-0000-acc000000002/read' \
--header 'Accept: application/json' \
--header 'Host: api.smartpost.jp' \
--header 'User-Agent: Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion' \
--header 'Authorization: Bearer <token>'

レスポンス

🟢200Success
text/plain
🟠400Bad Request
🟠401Unauthorized
更新日時 2026-05-14 04:54:45
前へ
getImageUrls
次へ
getPdfUrl
Built with