Pular para o conteúdo

Alterar uma fonte

PATCH
/v1/ingest/sources/{id}

Campo ausente fica como está.

  • status: enabled ou disabled. A fonte desabilitada continua respondendo 202 ao provedor e gravando o que chega, mas não repassa nada.
  • provider e providerConfig: o code de um provedor e a configuração que ele pede.
  • silenceAlertMinutes: avisa por e-mail quando a fonte passa este tempo sem receber nada. 0 desliga, e o máximo é 43.200 (30 dias).
  • alertEmails: até 5 endereços, separados por vírgula.
  • cronExpression, cronTimezone e cronPayload: só em fontes cron. O payload é um objeto JSON, e mudar a expressão reagenda a partir de agora.
id
obrigatório
string

Corpo da requisiçãoobrigatório

Seção intitulada “Request Bodyrequired”
Tipo de mídiaapplication/json
object
name
obrigatório
null | string
status
obrigatório
null | string
provider
obrigatório
null | string
providerConfig
obrigatório
null | object
cronExpression
obrigatório
null | string
cronTimezone
obrigatório
null | string
cronPayload
obrigatório
null | string
silenceAlertMinutes
obrigatório
null | integer | string formato: int32
/^-?(?:0|[1-9]\d*)$/
alertEmails
obrigatório
null | string
Exemplo
{
"provider": "mercadopago",
"silenceAlertMinutes": 1440,
"alertEmails": "financeiro@padariadoze.com.br"
}

Sucesso.

Tipo de mídiaapplication/json
object
id
obrigatório
string
name
obrigatório
string
type
obrigatório
string
status
obrigatório
string
url
obrigatório
string
provider
obrigatório
string
hasSecret
obrigatório
boolean
providerConfig
obrigatório
null | object
cronExpression
obrigatório
null | string
cronTimezone
obrigatório
null | string
cronPayload
obrigatório
null | string
nextRunAt
obrigatório
null | string formato: date-time
lastRunAt
obrigatório
null | string formato: date-time
lastMessageAt
obrigatório
null | string formato: date-time
silenceAlertMinutes
obrigatório
null | integer | string formato: int32
/^-?(?:0|[1-9]\d*)$/
alertEmails
obrigatório
null | string
destinations
obrigatório
integer | string formato: int32
/^-?(?:0|[1-9]\d*)$/
createdAt
obrigatório
string formato: date-time
Exemplogerado
{
"id": "example",
"name": "example",
"type": "example",
"status": "example",
"url": "example",
"provider": "example",
"hasSecret": true,
"providerConfig": "example",
"cronExpression": "example",
"cronTimezone": "example",
"cronPayload": "example",
"nextRunAt": "2026-04-15T12:00:00Z",
"lastRunAt": "2026-04-15T12:00:00Z",
"lastMessageAt": "2026-04-15T12:00:00Z",
"silenceAlertMinutes": 1,
"alertEmails": "example",
"destinations": 1,
"createdAt": "2026-04-15T12:00:00Z"
}

Chave de API ausente, inválida ou revogada.

A fonte não existe, ou não é deste ambiente.

Algum campo fora das regras acima: nome repetido, provedor desconhecido, e-mail inválido, expressão cron inválida.

Tipo de mídiaapplication/problem+json
object
type
null | string
title
null | string
status
null | integer | string formato: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
Exemplogerado
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Limite de requisições por segundo do plano, somado entre todas as chaves da organização.

Retry-After
integer

Segundos até a próxima janela.