Create Configuration

POST/v1/keys/{key}/configs

Creates a named configuration on a key and returns it.

Path parameters

key string

API Key

The API Key to retrieve. Begins ak_.

Example ak_test

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

Request body

The request body must contain a JSON object with:

• body ConfigNewParam

  Required configuration object parameters

  • name string required

    A unique name to identify the configuration payload

    Example

    woocommerce

  • payload string required

    A serialised payload of up to 65536 characters

    Example

    { "removeOrganisation": false }

Response

Returns the created configuration object with timestamps and assigned name.

• result Config

  • updatedAt string

    Timestamp for when the config was created

    Example

    2016-01-21T17:14:49.971Z

  • createdAt string

    Timestamp for when the config was updated

    Example

    2016-01-21T17:14:49.971Z

  • name string

    A unique name to identify the configuration payload

    Example

    woocommerce

  • payload string

    A serialised payload of up to 65536 characters

    Example

    { "removeOrganisation": false }

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

Request

curl

curl -X POST 'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs?user_token=uk_secret' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "woocommerce",
    "payload": "{\"removeOrganisation\": false}"
  }'

JavaScript

const response = await fetch('https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs?user_token=uk_secret', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    name: 'woocommerce',
    payload: '{"removeOrganisation": false}',
  }),
});

const { result } = await response.json();

Python

import requests

response = requests.post(
    "https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs",
    params={"user_token": "uk_secret"},
    json={
        "name": "woocommerce",
        "payload": "{\"removeOrganisation\": false}",
    },
)
result = response.json()["result"]

Ruby

require "net/http"
require "json"

uri = URI("https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs?user_token=uk_secret")
body = {
  name: "woocommerce",
  payload: '{"removeOrganisation": false}',
}
response = Net::HTTP.post(uri, body.to_json, "Content-Type" => "application/json")
result = JSON.parse(response.body)["result"]

PHP

<?php
$ch = curl_init("https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs?user_token=uk_secret");
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_HTTPHEADER => ["Content-Type: application/json"],
  CURLOPT_POSTFIELDS => json_encode([
    "name" => "woocommerce",
    "payload" => '{"removeOrganisation": false}',
  ]),
  CURLOPT_RETURNTRANSFER => true,
]);
$result = json_decode(curl_exec($ch), true)["result"];

Body

{
  "name": "woocommerce",
  "payload": "{\n  \"removeOrganisation\": false\n}\n"
}

Response

200 OK

{
  "result": {
    "updatedAt": "2016-01-21T17:14:49.971Z",
    "createdAt": "2016-01-21T17:14:49.971Z",
    "name": "woocommerce",
    "payload": "{\n  \"removeOrganisation\": false\n}\n"
  },
  "code": 2000,
  "message": "Success"
}