限定クーポン配布API

概要

限定クーポンをユーザに配布します。

URL

/cmapi/v2/coupons/${uuid}/distribute/

メソッド

POST

リクエスト

リクエストパラメータ

なし

リクエストボディ

基底オブジェクト

キー	型	必須	デフォルト	許容値	説明	詳細	備考
android_uuid	文字列配列	o	-	-	配布対象のユーザID (android)	ユーザID は基本的には「popinfo ID」を指定します。	android, iOS 合わせて 5000 件まで1度にリクエスト可能。
ios_uuid	文字列配列	o	-	-	配布対象のユーザID (iOS)	ユーザID は基本的には「popinfo ID」を指定します。	android, iOS 合わせて 5000 件まで1度にリクエスト可能。

リクエストのサンプル

curl \
    -X POST \
    -H "X-POPINFO-MAPI-TOKEN: ${AUTH_TOKEN}" \
    -H 'Content-Type: application/json' \
    -d '{
            "android_uuid": ["1201a906-3b80-40fe-aeed-e5576670bed6", "01201a96-3b80-401e-addd-e56670be57d6"],
            "ios_uuid": []
        }'  \
    https://${domain}/cmapi/v2/coupons/${uuid}/distribute/

レスポンス

メディアタイプ

application/json

成功時レスポンス

基底オブジェクト

キー	型	説明	詳細	備考
sent	オブジェクト	「"sent" オブジェクト」を参照。	-	-
not_sent	オブジェクト	「"not_sent" オブジェクト」を参照。	-	-

sentオブジェクト

キー	型	説明	詳細	備考
android_uuid	文字列配列	配布に成功したユーザID (android)	リクエストで指定した android_uuid の内、配信に成功したユーザの android_uuid が入ります。	-
ios_uuid	文字列配列	配布に成功したユーザID (iOS)	リクエストで指定した ios_uuid の内、配信に成功したユーザの ios_uuid が入ります。	-

not_sentオブジェクト

キー	型	説明	詳細	備考
android_uuid	文字列配列	配布に失敗したユーザID (android)	リクエストで指定した android_uuid の内、配信に失敗したユーザの android_uuid が入ります。	-
ios_uuid	文字列配列	配布に失敗したユーザID (iOS)	リクエストで指定した ios_uuid の内、配信に失敗したユーザの ios_uuid が入ります。	-

レスポンスのサンプル

{
  "sent": {
    "android_uuid":  ["1201a906-3b80-40fe-aeed-e5576670bed6", "01201a96-3b80-401e-addd-e56670be57d6"],
    "ios_uuid":  [],
  },
  "not_sent": {
    "android_uuid":  ["119062a0-30b8-4f0e-aede-bee5570d6766"],
    "ios_uuid":  [],
  }
}