Saltar al contenido principal
PATCH
/
v3
/
organizations
/
{org_id}
/
schedules
/
{schedule_id}
Actualizar una programación
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",
  "enabled": true,
  "frequency": "<string>",
  "name": "<string>",
  "notify_on": "always",
  "playbook_id": "<string>",
  "prompt": "<string>",
  "schedule_type": "recurring",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "run_as_user_id": "<string>",
  "slack_channel_id": "<string>",
  "slack_team_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",
  "schedule_type": "recurring",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "slack_channel_id": "<string>",
  "slack_team_id": "<string>"
}

​
Permisos

Se requiere un usuario de servicio con el permiso ManageOrgSchedules a nivel de organización.

​
Notas

Todos los campos son opcionales. Solo se actualizarán los campos incluidos en el cuerpo de la solicitud. Para desactivar una programación, establece enabled en false. Establecer playbook_id en null eliminará el playbook asociado. Puedes cambiar el schedule_type entre recurring y one_time. Al cambiar a one_time, indica scheduled_at con una fecha y hora futura en formato ISO 8601. Al cambiar a recurring, indica frequency con una expresión cron válida.

​
Identidad de ejecución

El parámetro run_as_user_id controla con la identidad de qué usuario se ejecuta la programación. Cuando se activa una programación, las sesiones se crean bajo ese usuario: este recibe las notificaciones y la sesión aparece en su historial.
  • Establecer un usuario: Proporciona un ID de usuario válido para cambiar la identidad de ejecución. Esto requiere:
    1. El usuario de servicio debe tener el permiso ImpersonateOrgSessions
    2. El usuario de destino debe ser miembro de la organización
    3. El usuario de destino debe tener el permiso UseDevinSessions
  • Borrar (establecer en null): Hace que la programación vuelva a ejecutarse como el usuario bot predeterminado
  • Omitir el campo: Deja la identidad de ejecución actual sin cambios

Autorizaciones

​
Authorization
string
header
requerido

Credencial de usuario de servicio (prefijo: cog_)

Parámetros de ruta

​
schedule_id
string
requerido

Cuerpo

application/json
​
agent
enum<string> | null
Opciones disponibles:
devin,
data_analyst,
advanced
​
enabled
boolean | null
​
frequency
string | null
​
name
string | null
​
notify_on
enum<string> | null
Opciones disponibles:
always,
failure,
never
​
playbook_id
string | null
​
prompt
string | null
​
schedule_type
enum<string> | null
Opciones disponibles:
recurring,
one_time
​
scheduled_at
string<date-time> | null
​
run_as_user_id
string | null

Establece el ID de usuario con el que se ejecutará esta programación. Requiere el permiso ImpersonateOrgSessions. El usuario de destino debe ser miembro de la organización. Si se establece en null, se revierte al usuario bot predeterminado. Si se omite el campo, la identidad actual se mantiene sin cambios.

​
slack_channel_id
string | null
​
slack_team_id
string | null

Respuesta

Respuesta satisfactoria

​
agent
enum<string>
requerido
Opciones disponibles:
devin,
data_analyst,
advanced
​
consecutive_failures
integer
requerido
​
created_at
string<date-time>
requerido
​
created_by
string | null
requerido
​
enabled
boolean
requerido
​
frequency
string | null
requerido
​
last_error_at
string<date-time> | null
requerido
​
last_error_message
string | null
requerido
​
last_executed_at
string<date-time> | null
requerido
​
name
string
requerido
​
notify_on
enum<string>
requerido
Opciones disponibles:
always,
failure,
never
​
org_id
string
requerido
​
playbook
PlaybookInfo · object
requerido
​
prompt
string
requerido
​
scheduled_session_id
string
requerido
​
updated_at
string<date-time>
requerido
​
schedule_type
enum<string>
predeterminado:recurring
Opciones disponibles:
recurring,
one_time
​
scheduled_at
string<date-time> | null
​
slack_channel_id
string | null
​
slack_team_id
string | null