Skip to content

スケジュールされたメッセージを更新する

post

/messages/schedule/update

core endpoint

このエンドポイントを使用して、スケジュールされたメッセージを更新します。

このエンドポイントは、or messages パラメーターのいずれかscheduleまたは両方の更新を受け入れます。要求には、これら 2 つのキーのうち少なくとも 1 つが含まれている必要があります。

See me in Postman

前提 条件

このエンドポイントを使用するには、アクセス許可を持つ messages.schedule.update API キーが必要です。

レート制限

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

リクエスト本文

1
2

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
4
5
6
7
8
9

{
  "schedule_id": (required, string) the `schedule_id` to update (obtained from the response to create schedule),
  "schedule": {
    // optional, see create schedule documentation
  },
  "messages": {
    // optional, see available messaging objects documentation
  }
}

要求パラメーター

パラメータ 必須項目 データ型 説明
schedule_id 必須項目 文字列 更新する( schedule_id スケジュールを作成する応答から取得)。
schedule オプション オブジェクト スケジュール・オブジェクト (schedule object) を参照。
messages オプション オブジェクト 使用可能なメッセージング・オブジェクトを参照してください。

要求の例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

curl --location --request POST 'https://rest.iad-01.braze.com/messages/schedule/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "schedule_id": "schedule_identifier",
  "schedule": {
    "time": "2017-05-24T20:30:36Z"
   },
  "messages": {
    "apple_push": {
      "alert": "Updated Message!",
      "badge": 1
    },
    "android_push": {
      "title": "Updated title!",
      "alert": "Updated message!"
    },
    "sms": {  
      "subscription_group_id": "subscription_group_identifier",
      "message_variation_id": "message_variation_identifier",
      "body": "This is my SMS body.",
      "app_id": "app_identifier"
    }
  }
}'
  Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?
New Stuff!