Set channel members' metadata
Sets the members's metadata in the specified channel. Use the
delete properties in the request body to perform those operations on one or more memberships.
Returns the list of channel members' metadata, optionally including:
- Channel's custom properties
- Custom properties for each UUID's membership in the channel
- Each UUID's custom properties
- You can change all of the membership object's properties except its identifier.
- Invalid property names are silently ignored and will not cause a request to fail.
- If you set the
customproperty, you must completely replace it since partial updates are not supported.
- The custom object can only contain scalar values.
Your app's subscribe key from Admin Portal.
The channel name to perform the operation on. Must not be empty and can contain up to 92 UTF-8 byte sequences.
Prohibited characters are:
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.
Possible values: value ≤ 100
Number of objects to return in response. Default is
Previously-returned cursor bookmark for fetching the next page.
Previously-returned cursor bookmark for fetching the previous page. Ignored if you also supply the start parameter.
Expression used to filter the results. Only objects whose properties satisfy the given expression are returned.
For details on [App Context Filtering], refer to documentation.
Note the following:
Example (Simple expression): custom.public == true
Example (Date/time comparison): updated >= "2019-08-31T00:00:00Z"
Example (Compound expression): description == null && (custom.label != "" || custom.description != "")
Example (Wildcard): name LIKE 'X*'
Example (Escaped wildcard): name LIKE '*\\**'
Possible values: Value must match regular expression
List of properties to sort by.
String 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 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.
Unix epoch timestamp used as a nonce for signature computation. Must have no more than ± 60 seconds offset from NTP.
|Request Body — REQUIRED|
JSON object with changes to the channel members' list.
Successfully set the channel members' metadata.
The request body contains invalid data.
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.
The format of the request body you supplied isn't supported. The request body must be in JSON format.
Request rate limit exceeded.
An internal server error occurred.
Request processing exceeded the maximum allowed time.