Delete configuration definition

DELETE

/config-definitions/{config-name}

Last modified:2026-09-30 05:25:40

OperationId:DeleteConfigurationDefinition

Deletes a configuration definition and every configuration row with the same name, at every tier.

Requires Super User scope. Every other scope gets 403.

Name one definition exactly: any * returns 400, and a name with no definition returns 404. The configuration rows are published for deletion first; if any cannot be published, the definition is kept and the answer is 400, so retry the delete. A definition the platform ships comes back on the next upgrade; its configuration rows do not. The deletes are published over the service bus (SBUS) and applied on every server shortly after, so 202 means accepted.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢202Accepted

application/json

The definition and its configuration rows were published for deletion over the service bus (SBUS): {"code": 202, "message": "Accepted"}.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://awqacore01.crexendocloud.com/ns-api/v2/config-definitions/PORTAL_SHOW_SHARED_CONTACTS' \
--header 'Authorization: Bearer <token>'

Response Example

202 - Accepted

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

Modified at 2026-09-30 05:25:40

Update configuration definition

Read image