Update MetaData

To update the metadata information based on the user id you can use the below API.

info

{api-base-url} can be obtained from the MirrorFly console.

HTTP request#

curl -X PUT "https://{api-base-url}/api/v1/users/updateMetaData/{userId}"
-H "accept: */*"
-H "Authorization: AuthToken"
-d "{\"key1\":\"value1\", \"key2\":\"value2\", \"key3\":\"value3\"}"

Note : Both key/value should be string only. Maximum of 3 key/value pairs are allowed. You can define key name as you need.

Request Params#

ParamDataTypeRequiredDescription
userIdStringYesuserId whose metadata to be updated
metaDataStringYesmetadata to be updated

Responses#

If successful, this action returns a metadata in the response body.

{
"status": 200,
"data": {
"metaData": {
// metadata key/value if any set
},
"message": "User Successfully Updated"
}
}

Error#

In the case of an error, an error object like below is returned. When the token passed in Headers is not given or expired

{
"status": 401,
"message": "Token Expired"
}

In the case of a Bad Request, an error message is returned

{
"status": 400,
"message": "Error Message"
}