# Channel Delete
API call format
DELETE /broker/channels/{<channel_guid>} //Use token autorization
DELETE /broker/private/channels/{<channel_guid>} //Use Api Key
Description
This call deletes existing channel.
Precondition
- Authorization token/
Api keyis needed. - Mandatory elements (should be specified):
- <channel_guid> - valid channel guid. Take a specific channel guid using Channels List API call.
Postcondition
- On success response code should be 200
- On success message for successful deletion in JSON format is returned.
- On failure an error will be returned with the right error code and description.
Example:
[Request] DELETE https://<base_api_url>/broker/channels/<channel_guid> //use GET /broker/channels to find a specific guid
[Request] DELETE https://<base_api_url>/broker/private/channels/<channel_guid> //use GET /broker/channels to find a specific guid
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","Authorization":"<IdToken>"} //Use token autorization
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","X-Api-Key":"<api_key>"} //Use Api Key
[Response] 200
[Response Headers] {"Content-Type":["application/json"],"Content-Length":["..."],"Connection":["keep-alive"],"Date":["..... GMT"],"x-amzn-RequestId":["....."],....]}
[Response]
{
'status' => true,
'data' => 'Item was deleted successfully'
}