Contacts

Erase contacts

POST/v1/contacts/erase

Requires an API key with the contacts:delete scope. About keys and scopes

Deletes up to 100 contacts by contactId, email or externalId, with their events, memberships, consent history and journey enrollments, and reports an outcome per identifier. Journey messages go with the enrollments; campaign and transactional messages are kept for campaign totals but anonymised: the address, content and provider ids are removed and nothing links them to the person. Address suppressions are kept, so an erased address that is imported again is still not mailed. sendInProgress means a message was being handed to the provider; retry that one shortly. Requires contacts:delete; agent keys are refused.

Request body

contactsobject[]required

at least 1 item · at most 100 items

One of 3 shapes

By contact id

1 child attribute

contactIdstringrequired: uuid

By email

1 child attribute

emailstringrequired

By external id

1 child attribute

externalIdstringrequired: 1–255 characters

Returns

Returns 200 OK with a EraseContactsResult in data. Otherwise returns an error; Errors lists every code and which to retry.

resultsobject[]required

2 child attributes

contactobjectrequired

The identifier as sent.

outcomestringrequired

send_in_progress: a message is being handed to the provider; retry shortly.

one of erased, not_found, send_in_progress

curl -X POST https://api.kirora.io/v1/contacts/erase \
  -H "Authorization: Bearer $KIRORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contacts": [
      {
        "contactId": "018f2a4e-6b1c-7d3e-9f40-4db757ce5a6b"
      }
    ]
  }'

const response = await fetch('https://api.kirora.io/v1/contacts/erase', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "contacts": [
      {
        "contactId": "018f2a4e-6b1c-7d3e-9f40-4db757ce5a6b"
      }
    ]
  }),
});
const { data } = await response.json();

import os

import requests

response = requests.post(
    "https://api.kirora.io/v1/contacts/erase",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
    json={
        "contacts": [
            {
                "contactId": "018f2a4e-6b1c-7d3e-9f40-4db757ce5a6b",
            },
        ],
    },
)
data = response.json()["data"]

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
	"os"
)

func main() {
	body := []byte(`{
	  "contacts": [
	    {
	      "contactId": "018f2a4e-6b1c-7d3e-9f40-4db757ce5a6b"
	    }
	  ]
	}`)
	req, err := http.NewRequest("POST", "https://api.kirora.io/v1/contacts/erase", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

Response · 200

{
  "data": {
    "results": [
      {
        "contact": {},
        "outcome": "erased"
      }
    ]
  }
}

Example values are generated from the schema.