旅をアクティブにする

既存のジャーニーをアクティブ化または一時停止します。

POST/journeys/{id}/activatejourneys:write

行動

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

効果

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

繰り返し

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

リクエスト

idstring · pathリソース識別子。minLength 2 · maxLength 100必須

activeboolean · body望ましい状態。デフォルトは true。オプション

AuthorizationBearer ach_live_...

Acceptapplication/json

範囲journeys:write

実行ファイルの例

curl

curl -X POST 'https://achadu.com/api/v1/journeys/resource_id/activate' \
  -H 'Authorization: Bearer ach_live_...' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data '{
  "active": true
}'

応答とエラー

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

200 application/json

{
  "data": {
    "id": "jrn_01J...",
    "name": "Recover interest",
    "trigger": "conversation.updated",
    "blocks": [],
    "active": 1,
    "executions": 42
  },
  "request_id": "req_01J..."
}

200操作が完了しました。

400Invalid parameter, body or transition.

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

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

403A chave precisa do escopo journeys:write.

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

409The current state prevents this operation.

413The JSON body exceeds 128 KB.

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

旅をアクティブにする

リクエスト

実行ファイルの例

応答とエラー

関連する操作