Close Notification Channel

Required plan: Starter

Description #

Closes an existing push notification channel to stop notifications being sent.

URL format #

api.cronofy.com/v1/channels/{CHANNEL_ID}

Example Request #

DELETE /v1/channels/{CHANNEL_ID} HTTP/1.1
Host: api.cronofy.com
Authorization: Bearer {ACCESS_TOKEN}

Example Response #

HTTP/1.1 202 Accepted

Request parameters #

CHANNEL_ID required  #

The ID of the push notification channel you wish to close.

Response parameters #

This request has no response body.

Error responses #

401 Unauthorized #

The request was refused as the provided authentication credentials were not recognized.

When an OAuth refresh_token is available then it should be used to request a replacement auth_token before the request is retried.