Skip to content

APIトリガーキャンペーンをスケジュールする

post

/campaigns/trigger/schedule/create

core endpoint

このエンドポイントを使用すると、ダッシュボードで作成されたキャンペーン メッセージを API トリガー配信経由で送信し、メッセージを送信するトリガーとなるアクションを決定できます。

通行できます trigger_properties メッセージ自体にテンプレート化されます。

このエンドポイントを使用してメッセージを送信するには、API トリガー キャンペーンを作成するときに作成された キャンペーン ID が必要であることに注意してください。

See me in Postman

前提条件

このエンドポイント を 使用するには、 campaigns.trigger.schedule.create 許可。

レート制限

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

Braze endpoints support batching API requests. A single request to the messaging endpoints can reach any of the following:

  • Up to 50 specific external_ids, each with individual message parameters
  • A segment of any size created in the Braze dashboard, specified by its segment_id
  • An audience segment of any size, defined in the request as a connected audience object

リクエスト本文

1
2

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

{
  "campaign_id": (required, string) see campaign identifier,
  "send_id": (optional, string) see send identifier,
  // Including 'recipients' will send only to the provided user ids if they are in the campaign's segment
  "recipients": (optional, array of recipients object),
  // for any keys that conflict between these trigger properties and those in a Recipients Object, the value from the Recipients Object will be used
  "audience": (optional, connected audience object) see connected audience,
  // Including 'audience' will only send to users in the audience
  // If 'recipients' and 'audience' are not provided and broadcast is not set to 'false',
  // the message will send to entire segment targeted by the campaign
  "broadcast": (optional, boolean) see broadcast -- defaults to false on 8/31/17, must be set to true if "recipients" object is omitted,
  "trigger_properties": (optional, object) personalization key-value pairs for all users in this send; see trigger properties,
  "schedule": {
    "time": (required, datetime as ISO 8601 string) time to send the message,
    "in_local_time": (optional, bool),
    "at_optimal_time": (optional, bool),
  }
}

リクエストパラメータ

パラメータ 必須 データ型 説明
campaign_id 必須 文字列 キャンペーン識別子を参照
send_id オプション 文字列 送信識別子を参照してください。
recipients オプション 受信者オブジェクトの配列 受信者オブジェクトを参照してください。
audience オプション 接続されたオーディエンス オブジェクト 接続されたオーディエンスを参照してください。
broadcast オプション ブール値 設定する必要があります broadcast キャンペーンまたはキャンバスがターゲットとするセグメント全体にメッセージを送信する場合は true に設定します。このパラメータのデフォルトは false です (2017 年 8 月 31 日現在)。

もし broadcast がtrueに設定されている場合、 recipients リストを含めることはできません。ただし、設定する際には注意してください broadcast: true意図せずにこのフラグを設定すると、予想よりも多くの対象者にメッセージが送信される可能性があります。
trigger_properties オプション オブジェクト この送信内のすべてのユーザーのパーソナライズ キーと値のペア。トリガーのプロパティを参照してください。
schedule 必須 スケジュール オブジェクト スケジュール オブジェクトを参照してください。

リクエスト例

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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

curl --location --request POST 'https://rest.iad-01.braze.com/campaigns/trigger/schedule/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "campaign_id": "campaign_identifier",
  "send_id": "send_identifier",
  "recipients": [
    {
      "user_alias": "example_alias",
      "external_user_id": "external_user_identifier",
      "trigger_properties": {}
    }
  ],
  "audience": {
    "AND": [
      {
        "custom_attribute": {
          "custom_attribute_name": "eye_color",
          "comparison": "equals",
          "value": "blue"
        }
      },
      {
        "custom_attribute": {
          "custom_attribute_name": "favorite_foods",
          "comparison": "includes_value",
          "value": "pizza"
        }
      },
      {
        "OR": [
          {
            "custom_attribute": {
              "custom_attribute_name": "last_purchase_time",
              "comparison": "less_than_x_days_ago",
              "value": 2
            }
          },
          {
            "push_subscription_status": {
              "comparison": "is",
              "value": "opted_in"
            }
          }
        ]
      },
      {
        "email_subscription_status": {
          "comparison": "is_not",
          "value": "subscribed"
        }
      },
      {
        "last_used_app": {
          "comparison": "after",
          "value": "2019-07-22T13:17:55+0000"
        }
      }
    ]
  },
  "broadcast": false,
  "trigger_properties": {},
  "schedule": {
    "time": "",
    "in_local_time": false,
    "at_optimal_time": false
  }
}'

応答

成功レスポンスの例

1
2
3
4
5
6
7
8

Content-Type: application/json
Authorization: Bearer YOUR-API-KEY-HERE
{
{
    "dispatch_id": "dispatch_identifier",
    "schedule_id": "schedule_identifier",
    "message": "success"
}
  Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?
New Stuff!