Delete configuration

Deletes one configuration row. The name comes from the path; name the rest of the key in the body, as the list returns it. Each key part you leave out is *, except that below Reseller your own domain and user fill in, so a Super User's body-less delete removes the system row. After that the next less specific row, or the definition's default, applies.

Who can delete:

Super User deletes any row, including system rows, for any name.

Reseller deletes rows for its own territory or a domain in it. With neither reseller nor domain, the row is stored for your territory.

Office Manager and Route Manager delete their own domain's rows. domain left out means your domain.

Other scopes with delete rights delete only their own user's rows in their own domain. user and domain left out mean yours.

Super User Read Only, Route Manager Reseller, Call Center Supervisor, Site Manager, and Office Manager Read-Only are read-only and get 403.

Below Super User, the setting must have a definition whose config-def-allow-reseller-access is yes. A key outside your tier returns 403.

A key that matches no row returns 404. DELETE /configurations without a name answers 405. The delete is published over the service bus (SBUS) and applied on every server shortly after, so 202 means accepted. Send domain, reseller, and user in the body: in the query string they're ignored.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

application/json

The delete was published over the service bus (SBUS); it is applied on every server shortly after: {"code": 202, "message": "Accepted"}.

Bodyapplication/json

curl --location --request DELETE 'https://awqacore01.crexendocloud.com/ns-api/v2/configurations/PORTAL_SHOW_SHARED_CONTACTS' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "domain": "example.com" }'

Request

Responses