v50

latestOpenAPI 3.0.3AGPLv3raw.githubusercontent.com2026-04-1028178439.6 KB
Configurations

Create

Create a configuration

post/keys/{key}/configs

Path parameters

keystring required

API Key

The API Key to retrieve. Begins ak_.

Query parameters

user_tokenstring

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 beings uk_...

Request body

namestring required

A unique name to identify the configuration payload

payloadstring required

A serialised payload of up to 4096 characters

Example request

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

Response

Success

code2000 required
message'Success' required

Example response

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