Skip to main content
DELETE
/
api
/
ext
/
v1
/
people
Delete People
curl --request DELETE \
  --url https://staging-api.covver.io/api/ext/v1/people \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "collectionId": "<string>",
  "emails": [
    "<string>"
  ],
  "companyId": "<string>"
}
'
import requests

url = "https://staging-api.covver.io/api/ext/v1/people"

payload = {
"collectionId": "<string>",
"emails": ["<string>"],
"companyId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'DELETE',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({collectionId: '<string>', emails: ['<string>'], companyId: '<string>'})
};

fetch('https://staging-api.covver.io/api/ext/v1/people', 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://staging-api.covver.io/api/ext/v1/people",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'collectionId' => '<string>',
'emails' => [
'<string>'
],
'companyId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://staging-api.covver.io/api/ext/v1/people"

payload := strings.NewReader("{\n \"collectionId\": \"<string>\",\n \"emails\": [\n \"<string>\"\n ],\n \"companyId\": \"<string>\"\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.delete("https://staging-api.covver.io/api/ext/v1/people")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"collectionId\": \"<string>\",\n \"emails\": [\n \"<string>\"\n ],\n \"companyId\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://staging-api.covver.io/api/ext/v1/people")

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"collectionId\": \"<string>\",\n \"emails\": [\n \"<string>\"\n ],\n \"companyId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "emails": [
    "<string>"
  ]
}
{
"message": "<string>",
"errorCode": "<string>",
"statusCode": 123,
"error": "<unknown>"
}
{
"message": "<string>",
"errorCode": "<string>",
"statusCode": 123,
"error": "<unknown>"
}
Deleting people removes them from the system, and withdraws all outstanding credits/gifts balance they have.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
collectionId
string
required
emails
string[]
required
companyId
string

Response

Default Response

emails
string[]
required