EDeditalmd

Pauses, reactivates or changes the terms, state, filters, channel and destination of an alert.

Changed on

Returns: { alerta{id,nome,organizacao,destinatarios,resultados,termos,origem,uf,filtros,canal,destino,ativo,pago_ate,ultimo_check,falhas_seguidas,criado_em,alerta_url,compras_url,compras_total} }

patch/api/alertas/{id}

Request

  • Base URL
    https://editalmd.com
  • URL
    https://editalmd.com/api/alertas/{id}
  • Auth
    none declared

Path parameters

idstring required

Alert identifier.

Request body

nomestring

Alert name, up to 100 characters.

organizacao_idstring nullable

Organization from GET /api/me/empresas. Membership and MFA are checked. Null removes the label. This does not share alert ownership.

resultadosboolean

Also deliver the result of each matching purchase when PNCP publishes it, on the same channel: the purchase comes back once with resultado (awarded value, items, date and the three largest winners). It starts when turned on, without past results. abertas does not apply to results.

ativoboolean

false pauses without deleting; true reactivates.

termosstring

New object terms (3 to 200 letters; | = any one of the group).

ufstring

New state; empty removes the restriction.

canal'pull' | 'webhook' | 'email'

pull, webhook or email. Email requires a session. Without explicit recipients, it uses the account email.

destinostring

New https URL on port 443 (webhook). Ignored for pull and email.

Response

{ alerta{id,nome,organizacao,destinatarios,resultados,termos,origem,uf,filtros,canal,destino,ativo,pago_ate,ultimo_check,falhas_seguidas,criado_em,alerta_url,compras_url,compras_total} }

Changes

  • a8fa1096f28dRevision changes
    • breaking

      added the new required request property /////

    • breaking

      added the new required request property /////

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

  • 3c8b9fac0b09Revision changes
    • breaking

      added the new required request property /////

    • info

      added the new optional request property

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ///// to the response with the status