Set channel members' metadata

Update channel members' metadata by setting or deleting UUID memberships for a specific channel

byPubNub (Realtime Messaging)

0calls

N/Alatency

Discover -> Inspect -> Call

Call setup

Tool IDpubnub.channels.uuids.update.v2.6984b3b6

Request parametersJSON

Before this Call

1 credit / call

The final charge is settled from actual provider usage and will appear in Usage.

Field reference

sub_keystringRequired

Your app's subscribe key from Admin Portal

channelstringRequired

The channel ID to perform the operation on. Must not be empty and can contain up to 92 UTF-8 byte sequences. Prohibited characters: ,,/\,*,:, channel, non-printable ASCII control characters, and Unicode zero.

includestring[]Optional

List of additional/complex metadata to include in the response. Possible values: [custom,status,type,uuid,uuid.custom,uuid.status,uuid.type]

limitintegerOptional

Number of objects to return in response. Default is 100, which is also the maximum value.

startstringOptional

Random string returned from the server, including a specific position in a data set. Used for forward pagination.

endstringOptional

Random string returned from the server, including a specific position in a data set. Used for backward pagination.

countbooleanOptional

Request totalCount to be included in the paginated response.

filterstringOptional

Expression used to filter the results. Must be properly URL-encoded.

sortstring[]Optional

List of properties to sort by. Append :asc or :desc to specify direction. Example: updated,status,type

authstringOptional

Authorization token with permissions to perform the request.

signaturestringOptional

Signature used to verify that the request was signed with the secret key.

timestampintegerOptional

Unix epoch timestamp used as a nonce for signature computation.

setarrayOptional

deletearrayOptional