Create configuration definition

POST

/config-definitions

Last modified:2026-10-30 21:14:08

OperationId:CreateConfigurationDefinition

Creates a configuration definition, which describes one setting: what it controls, its default value, its data-type, the release it first applies to, and whether a Reseller may set it. Requires Super User scope. Definitions the platform ships are reset on every upgrade; a definition you create keeps its values.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢202Accepted

application/json

The change is accepted and applied on every server shortly after: {"code": 202, "message": "Accepted"}. Read the definition back to confirm it.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠409Conflict

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/config-definitions' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "config-name": "PORTAL_SHOW_SHARED_CONTACTS",
    "description": "Show shared contacts to every user",
    "default": "no",
    "code-version": "v44.0",
    "data-type": "boolean",
    "config-def-allow-reseller-access": "yes",
    "tags": "portal,contacts"
}'

Response Example

202 - Accepted

{
    "code": 202,
    "message": "Accepted"
}

Modified at 2026-10-30 21:14:08

List configuration definitions

Read configuration definition