1. API
  2. SDK
  3. Cancelar inscrição do dispositivo
Ir para Dashboard
  • Visão geral da API
  • Erros
  • Limites
  • Paginação
  • GETListar campanhas
  • POSTCriar campanha
  • GETObter campanha
  • DELETEExcluir campanha
  • PATCHAtualizar campanha
  • POSTCancelar campanha
  • POSTCriar segmento
  • GETRelatório diário
  • GETListar assinantes
  • GETObter assinante
  • DELETEExcluir assinante
  • PATCHAtualizar assinante
  • GETObter configuração do site
  • POSTRegistrar inscrição
  • DELETECancelar inscrição do dispositivo
  • POSTRegistrar evento
  • GETObter preferências
  • PUTAtualizar preferências
DELETE/v1/sites/{pub}/subscriptions

Cancelar inscrição do dispositivo

Descadastra o dispositivo identificado por X-Pushwi-Endpoint. Ele para de receber push na hora e os dados da inscrição são apagados em 30 dias. O assinante continua existindo; para apagar a pessoa, use Excluir assinante pelo servidor.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Parameters

Values are applied to the request and the example on the right.

pubpath · stringrequired

ID público do site (pub_ seguido de 24 caracteres), o mesmo do atributo data-site do snippet.

X-Pushwi-Endpointheader · stringrequired

URL do endpoint de push do dispositivo (PushSubscription.endpoint), até 2048 caracteres. É assim que a API sabe de qual dispositivo se trata.

Responses

200application/json

Dispositivo descadastrado.

{
  "status": "ok"
}
statusenumoptional

Values: "accepted" · "ok"

403application/json

O cabeçalho Origin está ausente ou não consta nas origens permitidas do site.

{
  "message": "Origem não permitida."
}
messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.

404application/json

Site desconhecido, ou nenhuma inscrição com esse endpoint.

{
  "message": "Recurso não encontrado."
}
messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.

422application/json

Algum campo não passou na validação. errors traz a mensagem de cada campo.

{
  "message": "O campo content.title é obrigatório.",
  "errors": {
    "content.title": [
      "O campo content.title é obrigatório."
    ]
  }
}
messagestringoptional

Primeira mensagem de erro.

errorsobjectoptional

Mensagens por campo. A chave é o caminho do campo com pontos, como content.title ou definition.groups.0.rules.1.op.

429application/json

Limite de requisições excedido. Espere os segundos indicados em Retry-After.

{
  "message": "Muitas requisições. Tente novamente em instantes."
}
messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.

Registrar inscrição< PreviousRegistrar eventoNext >

Powered by heyo

curl --request DELETE \  'https://api.pushwi.com/v1/sites/pub_8fK2mQx7Lw3nRt5Yv9Bc1Dz4/subscriptions' \  --header 'X-Pushwi-Endpoint: string'
{  "status": "ok"}