...
As variáveis serão passadas como parâmetros do POST DELETE (payload) e seguir todas as convenções da montagem deste tipo de requisição.
...
- O nome do assinante, podendo conter espaço em caso de nome e sobrenome.
campaign_id
Id da campanha.
- external_id
Esse campo representa ID ou identificação de sistema externo ao Evolux (por exemplo, CRM do cliente, número do chamado em outra plataforma, etc). Caso já exista um sistema ou banco de dados que atrele o cliente a um número, esse número deverá ser colocado nesse campo.numberUm número pertencente ao cliente. - token
Para gerar um token, basta seguir os passos em Tokens de API.
Definição
Code Block |
---|
curl -s -X DELETE "https://$HOST/api/v1/remove_subscriber/$CAMPAIGN_ID/subscriber/$EXTERNAL_ID?token=$TOKEN" |
Possíveis retornos
Não encontrado
Code Block |
---|
{
"meta": {
"status": 404, "message": "Subscriber not found." }
}
} |
Ocupado
Code Block |
---|
{
"meta": {
"status": 422, "message": "Subscriber is busy with status: <status>" }
}
} |
Deletado com sucesso
Code Block |
---|
{
"meta": {
"status": 200, "message": "The subscriber was successfully removed"
}
} |
Exemplos de Chamada
Exemplo com CURL:
Code Block |
---|
curl -s -X GETDELETE "https://cliente.evolux.net.br/api/v1/remove_subscriber/659/subscriber/8?number=666&name=teste1&external_id=567899990&token=<TOKEN>$TOKEN" |
Retorno do Exemplo:
Code Block | ||
---|---|---|
| ||
{ "meta": { "status": 200, "message": "The subscriber was successfully removed" } } |
...