Update a single user by user ID

PUT/users/{user}

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Update a single user by user ID action (under Users).
Fill in the fields below, then reference the result from later steps as {{updateASingleUserByUserId.response.data}}.

Request

Path parameters

userstringrequired

Specify the unique ID of the user to retrieve, update, or delete.

Request body

Enter the body as JSON in the step's Body field.

usersarray<object>required

Specify the user details to update. Only one user record can be submitted per request.

$next_shiftoneOf

Specify the upcoming shift to be assigned to the user. Set to null to clear the upcoming shift.

$current_shiftoneOf

Specify the current shift assigned to the user. Set to null to clear the assigned shift.

$shift_effective_fromoneOf

Specify the date on which the upcoming shift assignment becomes effective.

date_formatstring

Specify the user's preferred date format for displaying date values.

One ofdd-MM-yyyydd/MM/yyyydd.MM.yyyydd MM yyyydd-MM-yydd/MM/yydd.MM.yyd.MM.yyd-M-yyd/M/yyd.M.yyd.M.yy.d-M-yyyyd/M/yyyyd.M.yyyyd. M. yyyy.d. M. yyyyd MMM, yyyydd MMM, yyyyd. MMMM yyyydd.MM.yyyy.dd.MM.yy.yyyy-MM-ddyyyy/MM/ddyyyy.MM.ddyyyy MM ddyy/MM/ddyy-MM-ddyy.M.dyy-M-dyy. M. dyyyy/M/dyyyy年MM月dd日yy年M月d日yyyy.MM.dd.yyyy. MM. ddMM-dd-yyyyMM/dd/yyyyMM.dd.yyyyMM dd yyyy

decimal_separatorstring

Specify the user's preferred decimal separator character for displaying numerical values.

One ofCommaPeriod

emailstring

Specify the email address for the user's account.

first_namestring

Specify the user's first name.

full_namestring

Specify the user's full name.

idstring

Represents the unique identifier of the user record.

last_nameoneOf

Specify the user's last name. Set to null if no last name is to be stored.

profileobject2 fields

Specify the profile to assign to the user, including the profile's unique identifier and display name.

roleobject2 fields

Specify the role to assign to the user, including the role's unique identifier and display name.

statusstring

Specify the status of the user account.

One ofactiveinactive

aliasoneOf

Specify an alias or short name for the user. Set to null to remove an existing alias.

localestring

Specify the locale for the user.

One ofin_IDzh_CNzh_TWda_DKde_DEen_GBen_USes_ESfr_FRiw_ILhr_HRit_IThu_HUnl_NLpl_PLpt_BRpt_PTsv_SEvi_VNtr_TRcs_CZbg_BGru_RUar_EGhi_INth_THja_JPko_KR

phonestring | null

Specify the user's phone number. Set to null to clear an existing phone number.

mobilestring | null

Specify the user's mobile phone number. Set to null to clear an existing mobile number.

cityoneOf

Specify the city for the user's address. Set to null to clear an existing city value.

countryoneOf

Specify the country for the user's address. Set to null to clear an existing country value.

doboneOf

Specify the user's date of birth in YYYY-MM-DD format. Set to null to clear an existing date of birth.

faxoneOf

Specify the user's fax number. Set to null to clear an existing fax number.

number_separatorstring

Specify the character to use as a separator when formatting numbers for the user. This field is case-insensitive.

One ofCommaPeriodSpacecommaperiodspace

stateoneOf

Specify the state or province for the user's address. Set to null to clear an existing state value.

streetoneOf

Specify the street address for the user. Set to null to clear an existing street address.

time_formatstring

Specify the time format to use for displaying time values for the user.

One ofHH:mmhh:mm a

websiteoneOf

Specify the user's website URL. Set to null to clear an existing website URL.

ziponeOf

Specify the user's postal code or ZIP code. Set to null to clear an existing postal code.

name_format__sstring

Specify the format to use when displaying the user's name.

One ofSalutation,First Name,Last NameSalutation,Last Name,First NameFirst Name,Salutation,Last NameFirst Name,Last Name,SalutationLast Name,Salutation,First NameLast Name,First Name,Salutation

languagestring

Specify the preferred language for the user. This value can be updated only by the user themselves.

One ofaf_NAaf_ZAak_GHsu_IDcy_GBde_CHde_ATen_AUen_CAen_IEen_NZen_SGen_ZAee_GHee_TGfy_NLga_GBga_IEgv_IMki_KEgd_GBha_GHha_NGha_NEig_NGrn_BIjv_IDrw_RWsw_CDsw_KEsw_TZsw_UGlg_UGlb_LUmg_MGmt_MTms_BNms_IDms_MYms_SG

country_localestring

Specify the locale associated with the user's country.

One ofps_AFsv_AXsq_ALar_DZen_ASca_ADpt_AOen_AIen_AQen_AGes_ARhy_AMnl_AWen_AUde_ATaz_AZen_BSar_BHbn_BDen_BBbe_BYnl_BEfr_BEen_BZfr_BJen_BMen_BTes_BObs_BAen_BWno_BVpt_BRen_IOen_VGms_BNbg_BGfr_BFfr_BIkm_KHfr_CM

image_linkstring

Specify the URL of the user's profile image from the Identity and Access Management (IAM) system.

sort_order_preference__sstring

Specify the user's preferred sort order for displaying records.

One ofFirst Name,Last NameLast Name,First Name

Reporting_TooneOf

Specify the user to whom this user reports. Set to null to remove the reporting relationship. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for valid user IDs.

share_among_subordinatesboolean

Specify whether the user's records should be shared with their subordinates.\n\nPossible values:\ntrue - Records are shared with subordinates.\nfalse - Records are not shared with subordinates.

time_zonestring

Specify the time zone for the user. This value can be updated only by the user themselves.

distance_preference__sstring

Specify the user's preferred unit of measurement for displaying distance values.

One ofKilometersMiles

default_tab_groupinteger (int32)

Specify the default tab group for the user, determining which group of tabs is shown upon login.

signaturestring | null

Specify the email signature for the user. Set to null to remove an existing signature.

customize_infoobject3 fields

Specify user interface customization preferences for the user's account.

themeobject7 fields

Specify the theme configuration for the user's CRM interface, including color and display settings for the background, screen, header, normal tab, and selected tab elements.

json

{
  "users": [
    {
      "$next_shift": null,
      "$current_shift": null,
      "$shift_effective_from": null,
      "date_format": "dd-MM-yyyy",
      "decimal_separator": "Comma",
      "email": "string",
      "first_name": "string",
      "full_name": "string",
      "id": "string",
      "last_name": null,
      "profile": {
        "name": "string",
        "id": "4832675000000850800"
      },
      "role": {
        "name": "string",
        "id": "string"
      }
    }
  ]
}

Response

Returns 200 with an object. Read it in later steps with {{updateASingleUserByUserId.response.data.<field>}}.

usersarray<object>

Represents the list of outcome objects returned after processing the user update request. Each element reports the result status for the updated user record.

codestring

Indicates the API-level result code for the user update operation. Possible values: SUCCESS - The user record updates successfully.

One ofSUCCESS

detailsobject1 fields

Represents an object containing identifying information about the updated user. Includes the unique ID of the user.

messagestring

Indicates the message describing the outcome of the user update operation. Possible values: User updated - The user record updates successfully.

One ofUser updated

statusstring

Indicates the overall processing status of the user update request. Possible values: success - The request processes and the user record updates without errors.

One ofsuccess

json

{
  "users": [
    {
      "code": "SUCCESS",
      "details": {
        "id": "string"
      },
      "message": "User updated",
      "status": "success"
    }
  ]
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?