Skip to main content
NICE CXone Expert
Expert Success Center

site/properties/{key} (DELETE)


Remove a site property

  • REST Method: DELETE
  • Method Access: public

Uri Parameters

Name Type Description
userid string either an integer user ID, "current", or "=" followed by a double uri-encoded user name
key string A unique identifier for a property that is obtained through GET:site/properties

Query Parameters

Name Type Description
authenticate bool? Force authentication for request (default: false)
redirects int? If zero, do not follow page redirects.

Return Codes

Name Value Description
OK 200 The request completed successfully
Bad Request 400 Invalid input parameter or request body
Forbidden 403 ADMIN access is required
Not Found 404 Requested property could not be found

Implementation Notes

  • ADMIN right to the site is required for deleting a property
  • A current eTag is not required for deleting a property

C# Code Sample: Delete Site Property

The following code authenticates and deletes a site property named 'foo'.

Sample Code

Plug p = Plug.New("http://devwiki/@api/deki"); 
p.At("users", "authenticate")
 .WithCredentials("sysop", "password").Get(); 
p.At("site", "properties", "foo")

Implementation notes 

Add notes about requirements or config values

Curl Code Sample: Delete Site Property

The following command deletes the site property "foo":

Sample Code

curl -u admin:password -X DELETE -i http://mindtouch.address/@api/deki/site/properties/foo

Implementation notes 

curl flags

Provides external user authentication.
Specifies the HTTP request method.
Outputs the HTTP response headers. Useful for debugging.


ADMIN permissions is required to execute above command.


  • Was this article helpful?