メインコンテンツへスキップ
PATCH
/
v3
/
organizations
/
{org_id}
/
schedules
/
{schedule_id}
スケジュールを更新
curl --request PATCH \
  --url https://api.devin.ai/v3/organizations/{org_id}/schedules/{schedule_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent": "devin",
  "bypass_approval": true,
  "enabled": true,
  "frequency": "<string>",
  "interval_count": 123,
  "name": "<string>",
  "notify_on": "always",
  "playbook_id": "<string>",
  "prompt": "<string>",
  "run_as_user_id": "<string>",
  "schedule_type": "recurring",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "slack_channel_id": "<string>",
  "slack_team_id": "<string>",
  "tags": [
    "<string>"
  ],
  "target_devin_id": "<string>"
}
'
{
  "agent": "devin",
  "consecutive_failures": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "enabled": true,
  "frequency": "<string>",
  "last_error_at": "2023-11-07T05:31:56Z",
  "last_error_message": "<string>",
  "last_executed_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "notify_on": "always",
  "org_id": "<string>",
  "playbook": {
    "playbook_id": "<string>",
    "title": "<string>"
  },
  "prompt": "<string>",
  "scheduled_session_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "bypass_approval": false,
  "interval_count": 1,
  "schedule_type": "recurring",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "slack_channel_id": "<string>",
  "slack_team_id": "<string>",
  "tags": [
    "<string>"
  ],
  "target_devin_id": "<string>"
}

​
権限

組織レベルで ManageOrgSchedules 権限を持つサービスユーザーが必要です。

​
注意事項

すべてのフィールドは任意入力です。リクエストボディで指定したフィールドのみが更新されます。スケジュールを無効化するには、enabled を false に設定します。 playbook_id を null に設定すると、関連付けられているプレイブックが解除されます。 schedule_type は recurring と one_time の間で変更できます。one_time に変更する場合は、将来の日時を表す ISO 8601 形式の値を scheduled_at に指定してください。recurring に変更する場合は、有効な cron 式を frequency に指定してください。

​
実行アイデンティティ

run_as_user_id パラメータは、スケジュールをどのユーザーのアイデンティティとして実行するかを制御します。スケジュールがトリガーされると、そのユーザーのセッションとして作成され、そのユーザーに通知が送信され、そのセッションが当該ユーザーの履歴に表示されます。
  • ユーザーを設定する: 実行アイデンティティを変更するには、有効なユーザー ID を指定します。これには以下が必要です:
    1. サービスユーザーが ImpersonateOrgSessions 権限を持っていること
    2. 対象ユーザーがその組織のメンバーであること
    3. 対象ユーザーが UseDevinSessions 権限を持っていること
  • クリア (null に設定) : スケジュールはデフォルトのボットユーザーとして実行される状態に戻ります
  • フィールドを省略する: 現在の実行アイデンティティは変更されません

承認

​
Authorization
string
header
必須

サービスユーザーの認証情報（接頭辞: cog_）

パスパラメータ

​
schedule_id
string
必須

Schedule ID（プレフィックス: sched-）

例:

"sched-abc123def456"

ボディ

application/json
​
agent
enum<string> | null
利用可能なオプション:
devin,
data_analyst,
advanced
​
bypass_approval
boolean | null
​
enabled
boolean | null
​
frequency
string | null
​
interval_count
integer | null
​
name
string | null
​
notify_on
enum<string> | null
利用可能なオプション:
always,
failure,
never
​
playbook_id
string | null
​
prompt
string | null
​
run_as_user_id
string | null

この schedule をどの user ID で実行するかを設定します。ImpersonateOrgSessions permission が必要です。null に設定すると、デフォルトの bot user に戻ります。フィールドを省略すると、現在の identity は変更されません。

​
schedule_type
enum<string> | null
利用可能なオプション:
recurring,
one_time
​
scheduled_at
string<date-time> | null
​
slack_channel_id
string | null
​
slack_team_id
string | null
​
tags
string[] | null
​
target_devin_id
string | null

レスポンス

成功時のレスポンス

​
agent
enum<string>
必須
利用可能なオプション:
devin,
data_analyst,
advanced
​
consecutive_failures
integer
必須
​
created_at
string<date-time>
必須
​
created_by
string | null
必須
​
enabled
boolean
必須
​
frequency
string | null
必須
​
last_error_at
string<date-time> | null
必須
​
last_error_message
string | null
必須
​
last_executed_at
string<date-time> | null
必須
​
name
string
必須
​
notify_on
enum<string>
必須
利用可能なオプション:
always,
failure,
never
​
org_id
string
必須
​
playbook
PlaybookInfo · object
必須
​
prompt
string
必須
​
scheduled_session_id
string
必須
​
updated_at
string<date-time>
必須
​
bypass_approval
boolean
デフォルト:false
​
interval_count
integer
デフォルト:1
​
schedule_type
enum<string>
デフォルト:recurring
利用可能なオプション:
recurring,
one_time
​
scheduled_at
string<date-time> | null
​
slack_channel_id
string | null
​
slack_team_id
string | null
​
tags
string[] | null
​
target_devin_id
string | null