メッセージを登録

POST

/messages

指定したキャンペーンに紐づくメッセージを登録します。

• isDraft: true の場合、ステータスは DRAFT になり配信対象は作成されません。
• isDraft: false の場合、ステータスは SCHEDULED になり、キャンペーンを購読中の顧客に対して配信対象（Delivery）が作成されます。
  sendTiming: IMMEDIATE であればバッチ処理により即座に、SCHEDULED であれば sendsAt の日時に配信されます。
• method: EMAIL の場合、subject・senderId・type は必須です。
• sendTiming: SCHEDULED かつ isDraft: false の場合、sendsAt（未来日時）は必須です。
• method: EMAIL かつ isPromotional: true（デフォルト）の場合、本文に配信停止URLのプレースホルダー
  {{ 配信停止URL }} を含める必要があります（type に応じて bodyText／bodyHtml を検証します）。
  含まれない場合は 422 を返します。
• 送信元ドメインが公式ドメインの場合、本文に規定のフッター文言を含める必要があります（同様に 422）。
• method: LINE の場合、bodyText の内容がテキストメッセージとして送信されます。

Authorizations

bearerAuth

テナントに発行された個人アクセストークン（Laravel Sanctum）を
Authorization: Bearer {token} ヘッダーで送信してください。

Type

HTTP (bearer)

Request Body

application/json

{

  

"campaignId": "string",

  

"method": "string",

  

"isDraft": true,

  

"type": "string",

  

"subject": "string",

  

"bodyText": "string",

  

"bodyHtml": "string",

  

"senderId": "string",

  

"lineChannelId": "string",

  

"sendTiming": "IMMEDIATE",

  

"sendsAt": "string",

  

"urlTrackingEnabled": true,

  

"isPromotional": true

}

Responses

登録したメッセージ

Content-Type

application/json

{

  

"id": "string",

  

"tenantId": "string",

  

"campaignId": "string",

  

"method": "string",

  

"type": "string",

  

"status": "string",

  

"subject": "string",

  

"bodyText": "string",

  

"bodyHtml": "string",

  

"senderId": "string",

  

"domainId": "string",

  

"lineChannelId": "string",

  

"sendTiming": "string",

  

"sendsAt": "string",

  

"urlTrackingEnabled": true,

  

"isPromotional": true,

  

"createdAt": "string",

  

"updatedAt": "string",

  

"deletedAt": "string"

}

POST

/messages

Playground

Authorization

bearerAuth

Body

Samples

Powered by VitePress OpenAPI