Set channel metadata
Sets metadata for the specified channel. Returns the channel object, optionally including custom properties.
Note:
- You can change all of the channel's metadata except its identifier.
- Invalid property names are silently ignored and will not cause a request to fail.
- If you set the
custom
property, you must completely replace it since partial updates are not supported. - The custom object can only contain scalar values.
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 |
---|
include string[]Possible values: [ List of additional/complex metadata to include in the response. Omit this query parameter if you don't want to retrieve additional metadata. |
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 |
Request Body — REQUIRED JSON object with channel metadata to set. |
---|
name stringPossible values: 1 ≤ length The channel name to perform the operation on. Must not be empty or consist only of whitespace characters. |
description stringDescription of the channel. |
type stringChannel type. |
status stringChannel status. |
custom objectJSON object of key/value pairs with supported data-types. Values must be scalar only; arrays or objects are not supported. |
Responses | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
200 Successfully set the channel metadata.
| |||||||||||
400 The request body contains invalid data.
| |||||||||||
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.
| |||||||||||
415 The format of the request body you supplied isn't supported. The request body must be in JSON format.
| |||||||||||
429 Request rate limit exceeded.
| |||||||||||
500 An internal server error occurred.
| |||||||||||
503 Request processing exceeded the maximum allowed time.
|