Atualizar agendamento

Atualiza um agendamento existente.

PATCH /v3/organizations/{org_id}/schedules/{schedule_id}

Atualizar agendamento

cURL

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 '
{
  "bypass_approval": true,
  "enabled": true,
  "frequency": "<string>",
  "interval_count": 123,
  "name": "<string>",
  "platform": "<string>",
  "playbook_id": "<string>",
  "prompt": "<string>",
  "run_as_user_id": "<string>",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "slack_channel_id": "<string>",
  "slack_team_id": "<string>",
  "tags": [
    "<string>"
  ],
  "target_devin_id": "<string>"
}
'

200

{
  "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>",
  "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,
  "last_edited_by": "<string>",
  "platform": "<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>"
}

​

Permissões

Requer um usuário de serviço com a permissão ManageOrgSchedules no nível da organização.

​

Notas

Todos os campos são opcionais. Somente os campos fornecidos no corpo da requisição serão atualizados. Para desativar um agendamento, defina enabled como false.

Definir playbook_id como null removerá a associação com o playbook.

Você pode alterar o schedule_type entre recurring e one_time. Ao mudar para one_time, forneça scheduled_at com uma data e hora futuras no formato ISO 8601. Ao mudar para recurring, forneça frequency com uma expressão cron válida.

​

Identidade de execução

O parâmetro run_as_user_id controla com qual identidade de usuário o agendamento é executado. Quando um agendamento é acionado, as sessões são criadas com esse usuário — ele recebe notificações e a sessão aparece em seu histórico.

• Definir um usuário: Forneça um ID de usuário válido para alterar a identidade de execução. Isso requer:
  1. O usuário de serviço deve ter a permissão ImpersonateOrgSessions
  2. O usuário de destino deve ser membro da organização
  3. O usuário de destino deve ter a permissão UseDevinSessions
• Limpar (definir como null): Faz o agendamento voltar a ser executado como o usuário bot padrão
• Omitir o campo: Mantém a identidade de execução atual inalterada

Autorizações

Authorization · string · header · obrigatório

Credencial de usuário de serviço (prefixo: cog_)

Parâmetros de caminho

schedule_id · string · obrigatório

ID do agendamento (prefixo: sched-)

Exemplo:

"sched-abc123def456"

Corpo

application/json

agent · enum<string> | null

Opções disponíveis: devin, data_analyst

bypass_approval · boolean | null

enabled · boolean | null

frequency · string | null

interval_count · integer | null

name · string | null

notify_on · enum<string> | null

Opções disponíveis: always, failure, never

platform · string | null

Plataforma de VM para sessões iniciadas por esta programação (por exemplo, 'windows'). Quando omitido, a plataforma permanece inalterada. O valor deve corresponder a uma plataforma configurada para a organização (sem diferenciar maiúsculas de minúsculas); valores desconhecidos são rejeitados com um 400 que lista os rótulos de plataforma disponíveis.

playbook_id · string | null

prompt · string | null

run_as_user_id · string | null

Define o ID de usuário com o qual esta programação será executada. Requer a permissão ImpersonateOrgSessions. Definir como null reverte para o usuário bot padrão. Omitir o campo mantém a identidade atual inalterada.

schedule_type · enum<string> | null

Opções disponíveis: 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

Resposta

200

application/json

Resposta bem-sucedida

agent · enum<string> · obrigatório

Opções disponíveis: devin, data_analyst

consecutive_failures · integer · obrigatório

created_at · string<date-time> · obrigatório

created_by · string | null · obrigatório

enabled · boolean · obrigatório

frequency · string | null · obrigatório

last_error_at · string<date-time> | null · obrigatório

last_error_message · string | null · obrigatório

last_executed_at · string<date-time> | null · obrigatório

name · string · obrigatório

notify_on · enum<string> · obrigatório

Opções disponíveis: always, failure, never

org_id · string · obrigatório

playbook · PlaybookInfo · object · obrigatório

Show child attributes

prompt · string · obrigatório

scheduled_session_id · string · obrigatório

updated_at · string<date-time> · obrigatório

bypass_approval · boolean · padrão: false

interval_count · integer · padrão: 1

last_edited_by · string | null

platform · string | null

schedule_type · enum<string> · padrão: recurring

Opções disponíveis: 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