PUT - Update User Personal Information

Purpose

This API is used to update the personal and contact details of a specific user within an organization.

OAuth Scope

Use the scope

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

to generate the Authtoken.

ALL - Grants full access to accounts.

UPDATE - Grants update access to accounts.

Request URL

Method: PUT

https://mail.zoho.com/api/organization/{zoid}/accounts/{accountId}

Path Parameters

  • zoid* long
    • This parameter denotes the unique Zoho Organization Identifier for the organization.
    • This parameter can be retrieved from the Get Organization Details API.
  • accountId* long
    • This parameter is used to identify the account whose details are retrieved.
    • This parameter can be retrieved from the Get User Account Details API.

 

Request Body ( JSON Object)

  • zuid* long
  • mode* string
    • This parameter represents the type of operation that is to be performed.
    • Provide the value as updatePersonalInfo.
  • displayName string
    • Provide the preferred display name of the user.
  • gender string
    • Provide the user's gender.
    • Allowed values:
      • MALE
      • FEMALE
      • NON_BINARY
      • NOT_SPECIFIED
  • country string
    • Provide the user's country code.
    • Allowed values: Refer to Country codes.
  • phoneNumer string
    • Provide the user's primary phone number. 
  • mobileNumber string
    • Provide the user's mobile number. 
  • address JSON object

    This is a JSON object containing detailed address information. The following parameters should be included in the object:

    • streetAddr string
      • Provide the street address of the user.
    • city string
      • Provide the city name of the user.
    • postalCode string
      • Provide the postal/ZIP code of the user.
    • state string
      • Provide the state/region name of the user.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mail.zoho.com/api/organization/1234567890/accounts/2560636000000008002" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Zoho-oauthtoken 1********" \
-d '{
  "firstName": "Rebecca",
  "lastName": "Anderson",
  "displayName": "Rebecca Anderson",
  "gender": "FEMALE",
  "country": "us",
  "address": {
    "streetAddr": "91, Thomas Street",
    "city": "New York",
    "postalCode": "10001",
    "state": "New York"
  },
  "phoneNumber": "9000000001",
  "mobileNumber": "9000000002",
  "mode": "updatePersonalInfo",
  "zuid": 100001234
}'

Sample Success Response

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