deleteConfig

Delete

Permanently deletes a configuration object.

Endpoint

DELETE /keys/{key}/configs/{config}

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 { deleteConfig } from "@ideal-postcodes/sdk";

Path Parameters

Name	Type	Required	Description
key	string	yes	API Key The API Key to retrieve. Begins ak_.
config	string	yes	Configuration Name User-provided configuration object name.

Query Parameters

None.

Response Type

import type { DeleteConfigResponse } 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-config.tsts

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

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