Delete a push installationMenu

Delete a push installation

DELETE/v1/contacts/{id}/installations/{externalInstallationId}

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

Works with integration and partner keys, not agent keys.

Safe to retry: a repeat sets the same values again. About idempotency

Stops push to the device you registered as externalInstallationId for this contact, in every push app it registered with, as the SDK does on sign-out. Use it on sign-out, or when the device reports its token is no longer valid. The record is kept, marked active: false, so listPushInstallations still shows it; registering the device again turns it back on. To delete a person's data, delete the contact (deleteContact). A device the contact never registered is a 404.

Path parameters

idstringrequired

Kirora's id for the contact, your own with idType=externalId, or its email address with idType=email, URL-encoded (@ as %40).

1–255 characters

externalInstallationIdstringrequired

Your own id for the device, as registered, URL-encoded.

1–128 characters

Query parameters

idTypestringoptional

What {id} is: Kirora's id for the contact (id, the default), your own (externalId, as set with identify) or its email address (email, matched trimmed and without case).

one of id, externalId, email · default "id"

Header parameters

Kirora-Workspacestringoptional

Partner keys only: the child workspace to act in, by the external id the partner gave it. Without it, a partner key acts in its own workspace. Any other key that sends it is refused with 403, and an unknown workspace is 404.

pattern ^[A-Za-z0-9._:-]{1,128}$

Returns

Returns 204 No Content with an empty body. It can also return 409 Conflict; see the statuses below. Otherwise returns an error; Errors lists every code and which to retry.

204 No ContentThe installation was deleted.
409 ConflictThe request conflicts with current state — a duplicate unique value, or a resource whose status does not allow this operation.

curl -X DELETE https://api.kirora.io/v1/contacts/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/installations/018f2a4e-6b1c-7d3e-9f40-145120bf5a6b \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/contacts/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/installations/018f2a4e-6b1c-7d3e-9f40-145120bf5a6b', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
if (!response.ok) throw new Error(`Kirora API ${response.status}: ${await response.text()}`);

import os

import requests

response = requests.delete(
    "https://api.kirora.io/v1/contacts/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/installations/018f2a4e-6b1c-7d3e-9f40-145120bf5a6b",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
)
response.raise_for_status()

package main

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

func main() {
	req, err := http.NewRequest("DELETE", "https://api.kirora.io/v1/contacts/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/installations/018f2a4e-6b1c-7d3e-9f40-145120bf5a6b", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	if res.StatusCode >= 300 {
		msg, _ := io.ReadAll(res.Body)
		panic(fmt.Sprintf("Kirora API %d: %s", res.StatusCode, msg))
	}
}

using System.Net.Http.Headers;

using var http = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Delete, "https://api.kirora.io/v1/contacts/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/installations/018f2a4e-6b1c-7d3e-9f40-145120bf5a6b");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("KIRORA_API_KEY"));

using var response = await http.SendAsync(request);
if (!response.IsSuccessStatusCode)
    throw new HttpRequestException($"Kirora API {(int)response.StatusCode}: {await response.Content.ReadAsStringAsync()}");