Configs

Update

Replaces a configuration's payload and returns the updated configuration. The name is fixed at creation.

post/keys/{key}/configs/{config}

Request

  • Base URL: https://api.addresszen.com/v1
  • URL: https://api.addresszen.com/v1/keys/{key}/configs/{config}
  • Auth: HTTP bearer

Path parameters

keystring required

API Key

The API Key to retrieve. Begins ak_.

configstring required

Configuration Name

User-provided configuration object name.

Query parameters

user_tokenstring

Management Key

A secret key used to manage your account and API Keys. It was previously called the user token.

Your management key can be retrieved and managed from your accounts page.

Typically begins uk_.... Prefer the Authorization: Bearer uk_... header.

Request body

payloadstring

A serialized payload of up to 65536 characters

Example request

{
  "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"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.