Cancel Licensee

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

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

Path parameters

key string

API Key

The API Key to retrieve. Begins ak_.

Example ak_test

licensee string

Licensee Key

Uniquely identifies a licensee.

Example sl_hk71kco54zGSGvF9eXXrvvnMOLLNh

Query parameters

user_token string optional

Private User Token

A secret key used for sensitive operations on your account and API Keys.

Your user token can be retrieved and managed from your accounts page.

Typically begins uk_...

Example uk_B59ScW1p1HHouf1VqclEPZUx

Response

result contains a deleted count indicating whether the deletion was successful.

• result object

  • deleted number

    Format

    int32

    Example

    1

The result sits inside the standard { result, code, message } envelope — see the API reference for the wrapper format.

Request

curl

curl -X DELETE 'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94?user_token=uk_secret'

JavaScript

const response = await fetch('https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94?user_token=uk_secret', {
  method: 'DELETE',
});

Python

import requests

response = requests.delete(
    "https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94",
    params={"user_token": "uk_secret"},
)
response.raise_for_status()

Ruby

require "net/http"

uri = URI("https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94?user_token=uk_secret")
Net::HTTP.start(uri.host, use_ssl: true) do |http|
  http.delete(uri.request_uri)
end

PHP

<?php
$ch = curl_init("https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94?user_token=uk_secret");
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_RETURNTRANSFER => true,
]);
curl_exec($ch);

Response

200 OK

response.json

{
  "result": {
    "deleted": 1
  },
  "code": 2000,
  "message": "Success"
}