Set user metadata

Your app's subscribe key from Admin Portal.

A UTF-8 encoded string used to identify the client. Must not be empty and can contain up to 92 UTF-8 byte sequences.

Prohibited characters are: ,, /, \, *, :, channel, non-printable ASCII control characters, and Unicode zero.

Possible values: [custom, type, status]

List of additional/complex UUID metadata to include in the response. Omit this query parameter if you don't want to retrieve additional metadata.

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. Required if signature parameter is supplied.

An optional HTTP header that prevents concurrent modifications of the same User object by allowing clients to (optionally) request that their updates only be performed if the object hasn't been modified since it was read.

You can add If-Match in the Set user metadata requests and set it to the value of the eTag field from a previous Get user metadata response body.

Imagine the use case where you want to modify an existing User object only if it hasn't been modified since the last time you read it.

This is how the flow would look like:

1. The client reads the details of a User object from App Context API through the Get user metadata request that returns a response body containing the eTag value representing the object's current state, like 8f6da76a321017a34e0a72ed674393ee.
2. The client sends the eTag value of 8f6da76a321017a34e0a72ed674393ee in the If-Match HTTP header in a subsequent Set user metadata request, like -H 'If-Match: 8f6da76a321017a34e0a72ed674393ee'.
3. Since that eTag value in the If-Match HTTP header matches the User object's current eTag value, the Set user metadata request will succeed. If the request is sent with an old eTag value that doesn't match the User object's current eTag value, the request will fail with a 412 (Precondition failed) error.

Note The If-Match precondition checking for concurrent modifications is currently not supported for the membership/members' metadata APIs. These APIs also return an eTag field in the response body, but that field is not yet checked in the request header.

Possible values: 1 ≤ length

Name of the UUID. Max. 2,048 characters. Must not be empty or consist only of whitespace characters.

UUID's identifier in an external system. Max. 2,048 characters.

URL for the UUID's profile picture. Max. 2,048 characters. Syntax is as defined in RFC 3986.

The UUID's email address. Max. 320 characters. Syntax is as defined by RFC 5322 and extended by RFC 6532, with one exception: the display-name part is not allowed (only the addr-spec part is allowed).

User type. Max. 50 characters.

User status. Max. 50 characters.

JSON object of key/value pairs with supported data-types. Values must be scalar only; arrays or objects are not supported.

NOTE: If you set custom fields with integer values, do not specify numbers larger than 9007199254740991 due to precision limitations in JSON implementations. For large integer values, for example PubNub timetoken values, use string values instead of integers.