取消 Automation 執行

cURL

curl --request POST 'https://api.brightalk.ai/automation-runs/run_demo_001/cancel' \
  --header "Authorization: Bearer $BRIGHTALK_API_KEY" \
  --header "Brightalk-Version: 2026-07-16" \
  --header "Content-Type: application/json" \
  --data '{}'

const response = await fetch("https://api.brightalk.ai/automation-runs/run_demo_001/cancel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`,
    "Brightalk-Version": "2026-07-16",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.json());

import os
import requests

response = requests.request(
    "POST",
    "https://api.brightalk.ai/automation-runs/run_demo_001/cancel",
    headers={
    "Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
    "Brightalk-Version": "2026-07-16",
    "Content-Type": "application/json",
    },
    json={},
)
print(response.status_code, response.json())

{
  "id": "run_demo_001",
  "automation_id": "atm_demo_001",
  "contact_id": "con_demo_001",
  "input": {},
  "queued_at": "2026-07-20T01:00:00Z",
  "created_at": "2026-07-20T01:00:00Z",
  "updated_at": "2026-07-20T01:00:00Z",
  "failure_code": "step_failed",
  "started_at": "2026-07-20T01:00:00Z",
  "completed_at": "2026-07-20T01:00:00Z",
  "cancelled_at": "2026-07-20T01:00:00Z"
}

POST

automation-runs

{run_id}

cancel

cURL

curl --request POST 'https://api.brightalk.ai/automation-runs/run_demo_001/cancel' \
  --header "Authorization: Bearer $BRIGHTALK_API_KEY" \
  --header "Brightalk-Version: 2026-07-16" \
  --header "Content-Type: application/json" \
  --data '{}'

const response = await fetch("https://api.brightalk.ai/automation-runs/run_demo_001/cancel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`,
    "Brightalk-Version": "2026-07-16",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.json());

import os
import requests

response = requests.request(
    "POST",
    "https://api.brightalk.ai/automation-runs/run_demo_001/cancel",
    headers={
    "Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
    "Brightalk-Version": "2026-07-16",
    "Content-Type": "application/json",
    },
    json={},
)
print(response.status_code, response.json())

{
  "id": "run_demo_001",
  "automation_id": "atm_demo_001",
  "contact_id": "con_demo_001",
  "input": {},
  "queued_at": "2026-07-20T01:00:00Z",
  "created_at": "2026-07-20T01:00:00Z",
  "updated_at": "2026-07-20T01:00:00Z",
  "failure_code": "step_failed",
  "started_at": "2026-07-20T01:00:00Z",
  "completed_at": "2026-07-20T01:00:00Z",
  "cancelled_at": "2026-07-20T01:00:00Z"
}

授權

Authorization

string

header

必填

Use a private-beta server credential in the Authorization header.

標頭

Brightalk-Version

string

預設值:2026-07-16

選擇以日期為基礎的 API 版本。省略時會使用組織鎖定的私人測試版預設值。

Allowed value: "2026-07-16"

X-Request-Id

string

由呼叫端產生且符合 [A-Za-z0-9._:-]{1,64} 的關聯值。無效值會被取代。

Maximum string length: 64

Pattern: ^[A-Za-z0-9._:-]{1,64}$

Idempotency-Key

string

可選擇讓此狀態轉換在 24 小時內重播。

Required string length: 1 - 255

Pattern: ^(?=.{1,255}$)[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$

路徑參數

run_id

string

必填

不透明的 Automation 執行識別碼。不透明的資源識別碼。

Required string length: 1 - 255

範例:

"run_demo_001"

主體

application/json

JSON request body. The raw encoded body is limited to 1 MiB and unknown fields are rejected.

The body is of type object.

回應

已傳回目前的 Automation 執行。

string

必填

不透明的資源識別碼。

Required string length: 1 - 255

範例:

"run_demo_001"

status

enum<string>

必填

可用選項:

queued,

running,

waiting,

completed,

failed,

cancelled

automation_id

string

必填

不透明的資源識別碼。

Required string length: 1 - 255

範例:

"atm_demo_001"

contact_id

string

必填

不透明的資源識別碼。

Required string length: 1 - 255

範例:

"con_demo_001"

input

object

必填

只能提供所選 Automation 宣告的名稱。輸入的序列化 JSON 上限為 32 KiB，巢狀深度上限為 10。目前合約未公開任何已宣告名稱，因此請省略 input 或傳送空物件。

queued_at

string<date-time>

必填

執行進入持久佇列的時間。

範例:

"2026-07-20T01:00:00Z"

created_at

string<date-time>

必填

執行資源的建立時間。

範例:

"2026-07-20T01:00:00Z"

updated_at

string<date-time>

必填

執行資源上次更新的時間。

範例:

"2026-07-20T01:00:00Z"

failure_code

string

執行失敗時的穩定失敗分類。

範例:

"step_failed"

started_at

string<date-time>

開始執行的時間。

範例:

"2026-07-20T01:00:00Z"

completed_at

string<date-time>

執行完成的時間。

範例:

"2026-07-20T01:00:00Z"

cancelled_at

string<date-time>

取消完成的時間。

範例:

"2026-07-20T01:00:00Z"

取得 Automation 執行

⌘I

開始使用

API 基礎

核心概念

操作指南

發布資訊

API 參考

授權

標頭

路徑參數

主體

回應