Endpoint: PUT/PATCH /integrations/apikeys/{seller_id}/apikeys/{id}/
Autenticação: token JWT obrigatório. Autenticação por chave de API não é aceita. Consulte Autenticação.
Atualiza uma chave de API existente. Os campos editáveis são name, description e active. O valor secreto (key) não pode ser rotacionado por este endpoint — para rotacionar, remova a chave e crie uma nova via Criar chave de API. O uso mais comum deste endpoint é a desativação suave de uma chave definindo active=false. Uma chave desativada é imediatamente rejeitada pela autenticação; é possível reativá-la depois definindo active=true.

Parâmetros de caminho

seller_id
string (uuid)
required
id
string (uuid)
required
ID da chave de API.

Corpo

name
string
Novo rótulo.
description
string
Nova descrição.
active
boolean
Liga/desliga. Quando false, o token correspondente é rejeitado pela autenticação.
PUT exige todos os campos graváveis (name, description, active). PATCH aceita qualquer subconjunto.

Resposta

A chave atualizada (sem o campo key).
{
  "id": "c4f1e8a3-7d92-4b6f-9e10-2a3b4c5d6e7f",
  "name": "Servidor de produção",
  "description": "Utilizada pelo backend de checkout do vendedor",
  "active": false
}

Erros

StatusQuando
400Corpo inválido ou seller_id não existe.
401JWT ausente ou inválido (ou tentativa de uso de chave de API).
404Não existe chave de API com id sob o seller_id informado.

Exemplos

curl -X PATCH https://api.dlpay.cloud/integrations/apikeys/9b1f0d2a-2b40-4f3e-9c11-c2c0a1b3e711/apikeys/c4f1e8a3-7d92-4b6f-9e10-2a3b4c5d6e7f/ \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"active": false}'