PUT - Update Storage for a User

Purpose

This API updates the base storage or the extra storage for the particular user in the given organization, as per the mode and the plan type/add-on value provided.

OAuth Scope

Use the scope

ZohoMail.organization.subscriptions.ALL (or) ZohoMail.organization.subscriptions.UPDATE

to generate the Authtoken.

ALL - Full access to the organization's subscription.

UPDATE - Update the organization's subscription details.

Request URL

Method: PUT

https://mail.zoho.com/api/organization/{zoid}/storage/{zuid}

Path Parameters

  • zoid* long
    • This denotes the unique Zoho Organization Identifier for the organization.
    • This parameter can be fetched from Organization Details API.
  • zuid* long
    • This denotes the unique Zoho User Identifier for the user.
    • This parameter can be fetched from User Account Details API.

Request Body (JSON Object)

  • mode* string
    • This parameter represents the type of operation that is to be performed.
    • The possible values are

      • updateBaseStorage - To update the base storage of the user, use the planType parameter with this mode value.

      • updateExtraStorage - To update the extra storage for the user, use the addOnType parameter with this mode value.

  • planType+ string
    • This parameter specifies the plan type subscribed by the organization that needs to be updated.
    • This parameter should be mentioned when the mode is given the value updateBaseStorage.
    • The possible values can be
      • newMail5gb
      • newMail10gb
      • mailPremium
      • basic
      • professional 
  • addOnType+ JSON array of string
    • This parameter specifies the add-on type subscribed by the organization that needs to be updated.
    • This parameter should be mentioned when the mode is given the value updateExtraStorage.
    • The possible values can be 
      • 5gb
      • 25gb
      • 50gb
      • 100gb
      • 200gb
    • This parameter should be mentioned in the request body in the following format: "Add-on type required: Number of units of this storage required." For example, to update the extra storage with one unit of 25GB and two units of 5GB for a user, it should be denoted as "25gb: 1, 5gb: 2".

 

* - Mandatory parameter.
+ - Use the appropriate parameter, according to the mode value chosen.

 

Response Codes

Refer here for the response codes and their meaning.

Sample Request - Update Base Storage

Copied{
   "mode": "updateBaseStorage",
   "planType": "mailPremium"
}

Sample Request - Update Extra Storage of one unit of 25GB storage and two units of 5GB storage for a user

Copied{
   "mode": "updateExtraStorage",
   "addonType": [
      "25gb:1",
      "5gb:2"
   ]
}

Sample Response

Copied{
    "status": {
        "code": 200,
        "description": "success"
    }
}