Skip to main content
POST
コンタクトの全ての配信をバッチで停止

Supported products

承認

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

クエリパラメータ

channel
enum<string>
必須

登録読者が配信停止されるコミュニケーションチャネル。このパラメーターは必須であり、現在「EMAIL」のみをサポートしています。

利用可能なオプション:
EMAIL
businessUnitId
integer<int64>

処理が実行されているビジネスユニットIDを表す任意の整数。

verbose
boolean
デフォルト:false

レスポンスに詳細情報を含めるかどうかを示すブール値。デフォルトはfalseです。

ボディ

application/json
inputs
string[]
必須

バッチ処理の入力を表す文字列のリスト。

レスポンス

successful operation

completedAt
string<date-time>
必須

一括オプトアウト処理が完了した日時。

results
object[]
必須

全てのコミュニケーション処理からの一括オプトアウトの結果を含む配列。

startedAt
string<date-time>
必須

一括オプトアウト処理が始まった日時。

status
enum<string>
必須

一括オプトアウト処理の現在のステータス(PENDING、PROCESSING、CANCELED、COMPLETEを取り得る)。

利用可能なオプション:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

一括オプトアウト処理中に発生した問題について詳述するエラーオブジェクトの配列。

関連するリソースやドキュメントにリンクしているURLのコレクション。

numErrors
integer<int32>

一括オプトアウト中に発生したエラー数の合計。

requestedAt
string<date-time>

一括オプトアウトのリクエストが行われた日時。

最終更新日 2026年4月10日