Delete an Existing Callback

Operation Summary:

Deletes an existing callback from the application.

Resource URL:

https://api.compendiumblog.com/app/callback/{CallbackId}

HTTP method:

DELETE

HTTP Status Codes:

200 OK

403 Forbidden

HTTP Status Code Details:

200 OK: The callback was deleted successfully.
403 Forbidden: The user invoking the endpoint is not authenticated or does not have appropriate authorization to perform the operation

Response Representations:

JSON

Permitted Roles:

Super Administrator

Super Delegate

Network Administrator

Required Parameters:

CallbackId: The system-assigned unique identifier of the callback.

Optional Parameters:

There are no optional parameters for this endpoint.

Response Values:

Success: The callback data was deleted successfully.
Error: The callback data was not deleted successfully.

Response Structure:

Responses are single-member objects which have a property name based on the type of result.

The Success result will look like:

{'Success' : string}

The string is the unique identifier of the callback that was deleted. It should be identical to the value supplied to the service call.

The Error result will be a flat array of objects, which have keys for the message name and explanatory text.

{
     'Error' : [
       { 'Name' : string, 'Message' : string },
       { 'Name' : string, 'Message' : string },
       ...   
    ]
 }

Error Types:

CallbackId: An invalid callback ID was specified.

Additional Notes:

The "Super Administrator" role may delete a callback either at the global scope or for any network.
The "Super Delegate" role may delete a callback for any assigned network.
The "Network Administrator" role may delete a callback for his or her own network.

Command Line Example

curl -v --insecure -X DELETE \
-H 'Accept: application/vnd.compendium.blog;version=2,application/json'  \
--user 'username:ILZ22XyjgcQ3zXLc7PSXGOMQtDIz6O9k99DY6ahC'  \
https://api.test.compendiumblog.com/app/callback/1e3935a1-93c3-407d-b286...

Compendium Documentation

Help