Alterar um endpoint

PATCH

/v1/endpoints/{id}

Troca a URL, os tipos inscritos ou a situação do endpoint. Campo ausente fica como está.

Em events, a lista substitui a inscrição inteira, e a lista vazia [] passa a receber todos os tipos. A URL nova passa pela mesma validação do cadastro.

Em status, disabled desliga o endpoint e enabled o religa. Religar um endpoint desativado automaticamente zera a contagem de falhas seguidas; as entregas que ficaram exhausted ou cancelled enquanto ele esteve desligado continuam assim, e cada uma pode ser reenviada com retry. Na resposta, o status vem como Enabled ou DisabledManually.

Autorização

• Bearer

Parâmetros

Parâmetros de caminho

id

obrigatório

string

Corpo da requisição^obrigatório

Tipo de mídiaapplication/json

object

url

obrigatório

null | string

events

obrigatório

Array<string> | null

status

obrigatório

null | string

Exemplo

{
  "events": [
    "pedido.pago",
    "pedido.cancelado"
  ]
}

Respostas

200

Sucesso.

Tipo de mídiaapplication/json

object

id

obrigatório

string

consumer

obrigatório

string

url

obrigatório

string

description

obrigatório

null | string

status

obrigatório

string

events

obrigatório

Array<string>

customHeaders

obrigatório

object

key

propriedades adicionais

string

createdAt

obrigatório

string formato: date-time

Exemplo^gerado

{
  "id": "example",
  "consumer": "example",
  "url": "example",
  "description": "example",
  "status": "example",
  "events": [
    "example"
  ],
  "customHeaders": {
    "additionalProperty": "example"
  },
  "createdAt": "2026-04-15T12:00:00Z"
}

401

Chave de API ausente, inválida ou revogada.

404

O endpoint não existe, ou não é deste ambiente.

422

URL recusada pela validação, tipo de evento não cadastrado, ou status diferente de enabled e disabled.

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

Exemplo^gerado

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

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

Headers

Retry-After

integer

Segundos até a próxima janela.