deleteLicensee

Cancel

Cancels a licensee. Its key stops working and it drops out of the licensee list. Contact us to reverse it.

Endpoint

DELETE /keys/{key}/licensees/{licensee}

See the API reference for this endpoint.

This operation needs a Management Key. Set it as userToken on the client, which sends it in the Authorization header. See setup.

Import

import { deleteLicensee } from "@ideal-postcodes/sdk";

Path Parameters

Name	Type	Required	Description
key	string	yes	API Key The API Key to retrieve. Begins ak_.
licensee	string	yes	Licensee Key Uniquely identifies a licensee.

Query Parameters

None.

Response Type

import type { DeleteLicenseeResponse } from "@ideal-postcodes/sdk";

Errors

HTTP errors throw an ApiError with the HTTP status and the API error code and message. Network failures and aborts reject with the runtime's native error. Pass throwOnError: false to get { data, error } instead. See error handling.

Example

delete-licensee.tsts

import { createIdpcClient, deleteLicensee } from "@ideal-postcodes/sdk";

export const example = async () => {
  const client = createIdpcClient({
    apiKey: "ak_test",
    userToken: "uk_example",
  });
  const { data } = await deleteLicensee({
    client,
    path: { key: "ak_test", licensee: "sl_example" },
  });
  return data;
};