Delete channel metadata
Deletes metadata for the specified channel.
Note: Enabling referential integrity on your app’s keyset in the Admin Portal ensures that deleting a channel entity automatically deletes any memberships related to this channel.
Path Parameters |
---|
sub_key string — REQUIREDYour app's subscribe key from Admin Portal. |
channel string — REQUIREDThe channel name to perform the operation on. Must not be empty and can contain up to 92 UTF-8 byte sequences. Prohibited characters are: |
Query Parameters |
---|
auth stringString which is either the auth key (PAM v2) or a valid token (Access Manager) used to authorize the operation if access control is enabled. Authorization token with permissions to perform the request. |
signature stringSignature used to verify that the request was signed with the secret key associated with the subscribe key. If Access Manager is enabled, either a valid authorization token or a signature are required. Check Access Manager documentation for details on how to compute the signature. |
timestamp integerUnix epoch timestamp used as a nonce for signature computation. Must have no more than ± 60 seconds offset from NTP.
Required if |
Responses | |||||||||
---|---|---|---|---|---|---|---|---|---|
200 Successfully deleted metadata for the channel.
| |||||||||
403 Disabled - The subscribe key doesn't have App Context API enabled. Forbidden - The client isn't authorized to perform this operation. The authorization key you provided doesn't have the required permissions for this operation.
| |||||||||
412 Conditional operation cannot be performed because the target resource has changed since the last retrieval.
| |||||||||
429 Request rate limit exceeded.
| |||||||||
500 An internal server error occurred.
| |||||||||
503 Request processing exceeded the maximum allowed time.
|