Delete Campaign Contact

Elimina un contacto de una Campaña. Solo se pueden eliminar contactos en estado queue o failed; cualquier otro estado devuelve CONTACT_NOT_DELETABLE (409).

DELETE /campaigns/{id}/contacts/{contact_id}

cURL

cURL

curl --request DELETE \
  --url https://api.altur.io/api/v1.0/campaigns/{id}/contacts/{contact_id} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.altur.io/api/v1.0/campaigns/{id}/contacts/{contact_id}"

headers = {"Authorization": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};

fetch('https://api.altur.io/api/v1.0/campaigns/{id}/contacts/{contact_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.altur.io/api/v1.0/campaigns/{id}/contacts/{contact_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.altur.io/api/v1.0/campaigns/{id}/contacts/{contact_id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://api.altur.io/api/v1.0/campaigns/{id}/contacts/{contact_id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.altur.io/api/v1.0/campaigns/{id}/contacts/{contact_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

401

{
  "error": 123,
  "message": "<string>"
}

{
  "success": false,
  "message": "<string>",
  "field": "<string>"
}

{
  "success": false,
  "message": "<string>",
  "field": "<string>"
}

Rate Limit: 12 requests per second

Only contacts in queue or failed status can be deleted. Anything further along the lifecycle (sending, sent, answered, etc.) returns 409 CONTACT_NOT_DELETABLE.

Examples

cURL

curl -X DELETE "https://api.altur.io/api/v1.0/campaigns/1234/contacts/42" \
  -H "Authorization: api-key YOUR_API_SECRET_KEY"

import requests

response = requests.delete(
    "https://api.altur.io/api/v1.0/campaigns/1234/contacts/42",
    headers={"Authorization": "api-key YOUR_API_SECRET_KEY"},
)
response.raise_for_status()  # 204 No Content

const res = await fetch(
  "https://api.altur.io/api/v1.0/campaigns/1234/contacts/42",
  {
    method: "DELETE",
    headers: { Authorization: "api-key YOUR_API_SECRET_KEY" },
  },
);
if (!res.ok) throw new Error(`Delete failed: ${res.status}`);

Authorizations

Authorization · string · header · required

Add api-key YOUR_API_SECRET_KEY as the value of the Authorization header.

Path Parameters

id · integer · required

The identifier of the Campaign

contact_id · integer · required

The identifier of the contact within the Campaign

Response

204

Contact deleted successfully