Pular para o conteúdo principal
PATCH
/
v3
/
organizations
/
{org_id}
/
schedules
/
{schedule_id}
Atualizar agendamento
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>"
}

​
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

Corpo

application/json
​
agent
enum<string> | null
Opções disponíveis:
devin,
data_analyst,
advanced
​
enabled
boolean | null
​
frequency
string | null
​
name
string | null
​
notify_on
enum<string> | null
Opções disponíveis:
always,
failure,
never
​
playbook_id
string | null
​
prompt
string | null
​
schedule_type
enum<string> | null
Opções disponíveis:
recurring,
one_time
​
scheduled_at
string<date-time> | null
​
run_as_user_id
string | null

Defina o ID do usuário em nome do qual esta agenda será executada. Requer a permissão ImpersonateOrgSessions. O usuário de destino deve ser membro da organização. Definir como null faz com que a agenda volte para o usuário bot padrão. Omitir o campo mantém a identidade atual inalterada.

​
slack_channel_id
string | null
​
slack_team_id
string | null

Resposta

Resposta bem-sucedida

​
agent
enum<string>
obrigatório
Opções disponíveis:
devin,
data_analyst,
advanced
​
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
​
prompt
string
obrigatório
​
scheduled_session_id
string
obrigatório
​
updated_at
string<date-time>
obrigatório
​
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