Update configuration definition

PUT

/config-definitions/{config-name}

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

OperationId:UpdateConfigurationDefinition

Changes an existing configuration definition; send only the fields to change. Requires Super User scope. Changing default changes the value of every configuration that has no row of its own. A shipped definition is reset on the next upgrade, except that config-def-allow-reseller-access set to yes is kept.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

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

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/config-definitions/PORTAL_SHOW_SHARED_CONTACTS' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "default": "yes",
    "description": "Show shared contacts to every user unless a domain turns it off"
}'

Response Example

202 - Success

{
    "code": 409,
    "message": "Config definition already exists"
}

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

Read configuration definition

Delete configuration definition