Update group

To update a group with latest details use below API.

info

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

HTTP request#

curl -X PUT "https://{api-base-url}/api/v1/group/group" \
-H "accept: */*" \
-H "Authorization: xxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
--data-raw '{"groupId":"samplegroupId","groupImageUrl":"sampleUrl","groupName":"samplegroupname","mobileNumber":"99xxxxxx11","email":"sampleemail@gmail.com","status":"some status message","licensekey":"samplelicensekey","metaData":{"key1":"value1","key2":"value2","key3":"value3"}}'

Request Params#

Param	DataType	Required	Description
groupId	String	Yes	Id of the group
groupName	String	Yes	A name for this group
groupImageUrl	String	No	Group profile picture url
mobileNumber	String	No	Mobile number of the group owner
email	String	No	Email address of the group owner
status	String	No	Some status message for the group
licensekey	String	Yes	Licensekey for this group
metaData	String	No	JSON-formatted string to which you would like to update metadata. Can add three key-value pairs, where the values can be either numbers or strings. `"metaData":{"key1":"value1","key2":"value2","key3":"value3"}`

Responses#

If successful, this action updates the group details.

{
  "status": 200,
  "data": {
    "groupId": "samplegroupId", // String - group id
    "groupName": "samplegroupname"// String - group name
  },
  "message": "Group updated successfully"
}

Error#

In the case of an error, an error object like below is returned.

When the token passed in Headers is expired

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

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

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