グループ宛先の作成

アカウントコネクタによってすでに承認されているグループを登録します。

POST/groupsgroups:write

行動

変更は検証され、応答する前にキーアカウントに保存されます。返されたリソースを信頼できる情報源としてクエリします。

効果

リソースを変更し、対応するドメインイベントを発行できます。

繰り返し

ネットワーク障害が発生した場合は、リソースの状態を確認してから再試行してください。バックオフとジッターを使用して 429 と 5xx のみを自動的にやり直します。

リクエスト

namestring · bodyグループ名。minLength 2 · maxLength 160必須

external_idstring · bodyコネクタによって返される識別子。決して返事が返ってこない。minLength 2 · maxLength 240必須

connection_idstring · bodyグループを管理する接続。オプション

segment_idstring · body初期セグメント。オプション

rolestring · bodyRole: shipping, monitor, or both.オプション

capacityinteger · body運用能力。min 1 · max 1000000オプション

automationboolean · body自動化を有効にします。オプション

AuthorizationBearer ach_live_...

Acceptapplication/json

範囲groups:write

実行ファイルの例

curl

curl -X POST 'https://achadu.com/api/v1/groups' \
  -H 'Authorization: Bearer ach_live_...' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data '{
  "name": "My integration",
  "external_id": "string",
  "connection_id": "string",
  "segment_id": "string",
  "role": "string"
}'

応答とエラー

すべての応答には request_id が含まれます。リストにはページネーションが追加されます。可変リソースは、操作後に永続化された状態を返します。

201 application/json

{
  "data": {
    "id": "grp_01J...",
    "name": "Home deals",
    "members": 842,
    "active": 1,
    "capacity": 1024,
    "segment_id": "seg_01J..."
  },
  "created": true,
  "request_id": "req_01J..."
}

201Resource created and persisted.

400Invalid parameter, body or transition.

401キーが見つからない、無効、期限切れ、または取り消されています。

402アカウントプランでは、このインターフェイスはリリースされません。

403A chave precisa do escopo groups:write.

404このアカウントには機能が存在しません。

409The current state prevents this operation.

413The JSON body exceeds 128 KB.

4291 分あたり 120 リクエストのウィンドウを超えました。

グループ宛先の作成

リクエスト

実行ファイルの例

応答とエラー

関連する操作