Chilkat Online Tools

Xojo / DocuSign REST API / Updates the specified user information.

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "userName": "sample string 1",
//   "userId": "sample string 2",
//   "userType": "sample string 3",
//   "isAdmin": "sample string 4",
//   "userStatus": "sample string 5",
//   "uri": "sample string 6",
//   "email": "sample string 7",
//   "password": "sample string 8",
//   "title": "sample string 9",
//   "createdDateTime": "sample string 10",
//   "firstName": "sample string 11",
//   "middleName": "sample string 12",
//   "lastName": "sample string 13",
//   "suffixName": "sample string 14",
//   "permissionProfileId": "sample string 15",
//   "permissionProfileName": "sample string 16",
//   "countryCode": "sample string 17",
//   "subscribe": "sample string 18",
//   "userSettings": [
//     {}
//   ],
//   "accountManagementGranular": {
//     "canManageUsers": "sample string 1",
//     "canManageAdmins": "sample string 2",
//     "canManageGroups": "sample string 3",
//     "canManageSharing": "sample string 4",
//     "canManageEnvelopeTransfer": "sample string 5",
//     "canManageAccountSettings": "sample string 6",
//     "canManageReporting": "sample string 7",
//     "canManageAccountSecuritySettings": "sample string 8",
//     "canManageSigningGroups": "sample string 9",
//     "canManageDocumentRetention": "sample string 10",
//     "canViewUsers": "sample string 11",
//     "canManageUsersMetadata": {
//       "rights": "sample string 1",
//       "uiHint": "sample string 2",
//       "uiType": "sample string 3",
//       "uiOrder": "sample string 4",
//       "is21CFRPart11": "sample string 5",
//       "options": [
//         "sample string 1"
//       ]
//     },
//     "canManageAdminsMetadata": {},
//     "canManageGroupsMetadata": {},
//     "canManageSharingMetadata": {},
//     "canManageEnvelopeTransferMetadata": {},
//     "canManageAccountSettingsMetadata": {},
//     "canManageReportingMetadata": {},
//     "canManageAccountSecuritySettingsMetadata": {},
//     "canManageSigningGroupsMetadata": {},
//     "canManageDocumentRetentionMetadata": {},
//     "canViewUsersMetadata": {}
//   },
//   "sendActivationOnInvalidLogin": "sample string 19",
//   "activationAccessCode": "sample string 20",
//   "enableConnectForUser": "sample string 21",
//   "forgottenPasswordInfo": {
//     "forgottenPasswordQuestion1": "sample string 1",
//     "forgottenPasswordAnswer1": "sample string 2",
//     "forgottenPasswordQuestion2": "sample string 3",
//     "forgottenPasswordAnswer2": "sample string 4",
//     "forgottenPasswordQuestion3": "sample string 5",
//     "forgottenPasswordAnswer3": "sample string 6",
//     "forgottenPasswordQuestion4": "sample string 7",
//     "forgottenPasswordAnswer4": "sample string 8"
//   },
//   "groupList": [
//     {
//       "groupId": "sample string 1",
//       "groupName": "sample string 2",
//       "permissionProfileId": "sample string 3",
//       "groupType": "sample string 4",
//       "users": [
//         {
//           "userName": "sample string 1",
//           "userId": "sample string 2",
//           "email": "sample string 3",
//           "userType": "sample string 4",
//           "userStatus": "sample string 5",
//           "uri": "sample string 6",
//           "loginStatus": "sample string 7",
//           "sendActivationEmail": "sample string 8",
//           "activationAccessCode": "sample string 9"
//         }
//       ]
//     }
//   ],
//   "workAddress": {
//     "address1": "sample string 1",
//     "address2": "sample string 2",
//     "city": "sample string 3",
//     "stateOrProvince": "sample string 4",
//     "postalCode": "sample string 5",
//     "phone": "sample string 6",
//     "fax": "sample string 7",
//     "country": "sample string 8"
//   },
//   "homeAddress": {},
//   "loginStatus": "sample string 22",
//   "passwordExpiration": "sample string 23",
//   "lastLogin": "sample string 24",
//   "sendActivationEmail": "sample string 25",
//   "customSettings": [
//     {}
//   ],
//   "profileImageUri": "sample string 26",
//   "userProfileLastModifiedDate": "sample string 27",
//   "signatureImageUri": "sample string 28",
//   "initialsImageUri": "sample string 29",
//   "jobTitle": "sample string 30"
// }

Dim json As New Chilkat.JsonObject
success = json.UpdateString("userName","sample string 1")
success = json.UpdateString("userId","sample string 2")
success = json.UpdateString("userType","sample string 3")
success = json.UpdateString("isAdmin","sample string 4")
success = json.UpdateString("userStatus","sample string 5")
success = json.UpdateString("uri","sample string 6")
success = json.UpdateString("email","sample string 7")
success = json.UpdateString("password","sample string 8")
success = json.UpdateString("title","sample string 9")
success = json.UpdateString("createdDateTime","sample string 10")
success = json.UpdateString("firstName","sample string 11")
success = json.UpdateString("middleName","sample string 12")
success = json.UpdateString("lastName","sample string 13")
success = json.UpdateString("suffixName","sample string 14")
success = json.UpdateString("permissionProfileId","sample string 15")
success = json.UpdateString("permissionProfileName","sample string 16")
success = json.UpdateString("countryCode","sample string 17")
success = json.UpdateString("subscribe","sample string 18")
success = json.UpdateString("accountManagementGranular.canManageUsers","sample string 1")
success = json.UpdateString("accountManagementGranular.canManageAdmins","sample string 2")
success = json.UpdateString("accountManagementGranular.canManageGroups","sample string 3")
success = json.UpdateString("accountManagementGranular.canManageSharing","sample string 4")
success = json.UpdateString("accountManagementGranular.canManageEnvelopeTransfer","sample string 5")
success = json.UpdateString("accountManagementGranular.canManageAccountSettings","sample string 6")
success = json.UpdateString("accountManagementGranular.canManageReporting","sample string 7")
success = json.UpdateString("accountManagementGranular.canManageAccountSecuritySettings","sample string 8")
success = json.UpdateString("accountManagementGranular.canManageSigningGroups","sample string 9")
success = json.UpdateString("accountManagementGranular.canManageDocumentRetention","sample string 10")
success = json.UpdateString("accountManagementGranular.canViewUsers","sample string 11")
success = json.UpdateString("accountManagementGranular.canManageUsersMetadata.rights","sample string 1")
success = json.UpdateString("accountManagementGranular.canManageUsersMetadata.uiHint","sample string 2")
success = json.UpdateString("accountManagementGranular.canManageUsersMetadata.uiType","sample string 3")
success = json.UpdateString("accountManagementGranular.canManageUsersMetadata.uiOrder","sample string 4")
success = json.UpdateString("accountManagementGranular.canManageUsersMetadata.is21CFRPart11","sample string 5")
success = json.UpdateString("accountManagementGranular.canManageUsersMetadata.options[0]","sample string 1")
success = json.UpdateNewObject("accountManagementGranular.canManageAdminsMetadata")
success = json.UpdateNewObject("accountManagementGranular.canManageGroupsMetadata")
success = json.UpdateNewObject("accountManagementGranular.canManageSharingMetadata")
success = json.UpdateNewObject("accountManagementGranular.canManageEnvelopeTransferMetadata")
success = json.UpdateNewObject("accountManagementGranular.canManageAccountSettingsMetadata")
success = json.UpdateNewObject("accountManagementGranular.canManageReportingMetadata")
success = json.UpdateNewObject("accountManagementGranular.canManageAccountSecuritySettingsMetadata")
success = json.UpdateNewObject("accountManagementGranular.canManageSigningGroupsMetadata")
success = json.UpdateNewObject("accountManagementGranular.canManageDocumentRetentionMetadata")
success = json.UpdateNewObject("accountManagementGranular.canViewUsersMetadata")
success = json.UpdateString("sendActivationOnInvalidLogin","sample string 19")
success = json.UpdateString("activationAccessCode","sample string 20")
success = json.UpdateString("enableConnectForUser","sample string 21")
success = json.UpdateString("forgottenPasswordInfo.forgottenPasswordQuestion1","sample string 1")
success = json.UpdateString("forgottenPasswordInfo.forgottenPasswordAnswer1","sample string 2")
success = json.UpdateString("forgottenPasswordInfo.forgottenPasswordQuestion2","sample string 3")
success = json.UpdateString("forgottenPasswordInfo.forgottenPasswordAnswer2","sample string 4")
success = json.UpdateString("forgottenPasswordInfo.forgottenPasswordQuestion3","sample string 5")
success = json.UpdateString("forgottenPasswordInfo.forgottenPasswordAnswer3","sample string 6")
success = json.UpdateString("forgottenPasswordInfo.forgottenPasswordQuestion4","sample string 7")
success = json.UpdateString("forgottenPasswordInfo.forgottenPasswordAnswer4","sample string 8")
success = json.UpdateString("groupList[0].groupId","sample string 1")
success = json.UpdateString("groupList[0].groupName","sample string 2")
success = json.UpdateString("groupList[0].permissionProfileId","sample string 3")
success = json.UpdateString("groupList[0].groupType","sample string 4")
success = json.UpdateString("groupList[0].users[0].userName","sample string 1")
success = json.UpdateString("groupList[0].users[0].userId","sample string 2")
success = json.UpdateString("groupList[0].users[0].email","sample string 3")
success = json.UpdateString("groupList[0].users[0].userType","sample string 4")
success = json.UpdateString("groupList[0].users[0].userStatus","sample string 5")
success = json.UpdateString("groupList[0].users[0].uri","sample string 6")
success = json.UpdateString("groupList[0].users[0].loginStatus","sample string 7")
success = json.UpdateString("groupList[0].users[0].sendActivationEmail","sample string 8")
success = json.UpdateString("groupList[0].users[0].activationAccessCode","sample string 9")
success = json.UpdateString("workAddress.address1","sample string 1")
success = json.UpdateString("workAddress.address2","sample string 2")
success = json.UpdateString("workAddress.city","sample string 3")
success = json.UpdateString("workAddress.stateOrProvince","sample string 4")
success = json.UpdateString("workAddress.postalCode","sample string 5")
success = json.UpdateString("workAddress.phone","sample string 6")
success = json.UpdateString("workAddress.fax","sample string 7")
success = json.UpdateString("workAddress.country","sample string 8")
success = json.UpdateNewObject("homeAddress")
success = json.UpdateString("loginStatus","sample string 22")
success = json.UpdateString("passwordExpiration","sample string 23")
success = json.UpdateString("lastLogin","sample string 24")
success = json.UpdateString("sendActivationEmail","sample string 25")
success = json.UpdateString("profileImageUri","sample string 26")
success = json.UpdateString("userProfileLastModifiedDate","sample string 27")
success = json.UpdateString("signatureImageUri","sample string 28")
success = json.UpdateString("initialsImageUri","sample string 29")
success = json.UpdateString("jobTitle","sample string 30")

// Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = "{{accessToken}}"
http.SetRequestHeader "Accept","application/json"

Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)

Dim resp As Chilkat.HttpResponse
resp = http.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/users/{{userId}}?allow_all_languages={{allow_all_languages}}",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

System.DebugLog(Str(resp.StatusCode))
System.DebugLog(resp.BodyStr)

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "userName": "sample string 1",
  "userId": "sample string 2",
  "userType": "sample string 3",
  "isAdmin": "sample string 4",
  "userStatus": "sample string 5",
  "uri": "sample string 6",
  "email": "sample string 7",
  "password": "sample string 8",
  "title": "sample string 9",
  "createdDateTime": "sample string 10",
  "firstName": "sample string 11",
  "middleName": "sample string 12",
  "lastName": "sample string 13",
  "suffixName": "sample string 14",
  "permissionProfileId": "sample string 15",
  "permissionProfileName": "sample string 16",
  "countryCode": "sample string 17",
  "subscribe": "sample string 18",
  "userSettings": [
    {}
  ],
  "accountManagementGranular": {
    "canManageUsers": "sample string 1",
    "canManageAdmins": "sample string 2",
    "canManageGroups": "sample string 3",
    "canManageSharing": "sample string 4",
    "canManageEnvelopeTransfer": "sample string 5",
    "canManageAccountSettings": "sample string 6",
    "canManageReporting": "sample string 7",
    "canManageAccountSecuritySettings": "sample string 8",
    "canManageSigningGroups": "sample string 9",
    "canManageDocumentRetention": "sample string 10",
    "canViewUsers": "sample string 11",
    "canManageUsersMetadata": {
      "rights": "sample string 1",
      "uiHint": "sample string 2",
      "uiType": "sample string 3",
      "uiOrder": "sample string 4",
      "is21CFRPart11": "sample string 5",
      "options": [
        "sample string 1"
      ]
    },
    "canManageAdminsMetadata": {},
    "canManageGroupsMetadata": {},
    "canManageSharingMetadata": {},
    "canManageEnvelopeTransferMetadata": {},
    "canManageAccountSettingsMetadata": {},
    "canManageReportingMetadata": {},
    "canManageAccountSecuritySettingsMetadata": {},
    "canManageSigningGroupsMetadata": {},
    "canManageDocumentRetentionMetadata": {},
    "canViewUsersMetadata": {}
  },
  "sendActivationOnInvalidLogin": "sample string 19",
  "activationAccessCode": "sample string 20",
  "enableConnectForUser": "sample string 21",
  "forgottenPasswordInfo": {
    "forgottenPasswordQuestion1": "sample string 1",
    "forgottenPasswordAnswer1": "sample string 2",
    "forgottenPasswordQuestion2": "sample string 3",
    "forgottenPasswordAnswer2": "sample string 4",
    "forgottenPasswordQuestion3": "sample string 5",
    "forgottenPasswordAnswer3": "sample string 6",
    "forgottenPasswordQuestion4": "sample string 7",
    "forgottenPasswordAnswer4": "sample string 8"
  },
  "groupList": [
    {
      "groupId": "sample string 1",
      "groupName": "sample string 2",
      "permissionProfileId": "sample string 3",
      "groupType": "sample string 4",
      "users": [
        {
          "userName": "sample string 1",
          "userId": "sample string 2",
          "email": "sample string 3",
          "userType": "sample string 4",
          "userStatus": "sample string 5",
          "uri": "sample string 6",
          "loginStatus": "sample string 7",
          "sendActivationEmail": "sample string 8",
          "activationAccessCode": "sample string 9"
        }
      ]
    }
  ],
  "workAddress": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "city": "sample string 3",
    "stateOrProvince": "sample string 4",
    "postalCode": "sample string 5",
    "phone": "sample string 6",
    "fax": "sample string 7",
    "country": "sample string 8"
  },
  "homeAddress": {},
  "loginStatus": "sample string 22",
  "passwordExpiration": "sample string 23",
  "lastLogin": "sample string 24",
  "sendActivationEmail": "sample string 25",
  "customSettings": [
    {}
  ],
  "profileImageUri": "sample string 26",
  "userProfileLastModifiedDate": "sample string 27",
  "signatureImageUri": "sample string 28",
  "initialsImageUri": "sample string 29",
  "jobTitle": "sample string 30"
}'
https://domain.com/v2.1/accounts/{{accountId}}/users/{{userId}}?allow_all_languages={{allow_all_languages}}

Postman Collection Item JSON

{
  "name": "Updates the specified user information.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"userName\": \"sample string 1\",\n  \"userId\": \"sample string 2\",\n  \"userType\": \"sample string 3\",\n  \"isAdmin\": \"sample string 4\",\n  \"userStatus\": \"sample string 5\",\n  \"uri\": \"sample string 6\",\n  \"email\": \"sample string 7\",\n  \"password\": \"sample string 8\",\n  \"title\": \"sample string 9\",\n  \"createdDateTime\": \"sample string 10\",\n  \"firstName\": \"sample string 11\",\n  \"middleName\": \"sample string 12\",\n  \"lastName\": \"sample string 13\",\n  \"suffixName\": \"sample string 14\",\n  \"permissionProfileId\": \"sample string 15\",\n  \"permissionProfileName\": \"sample string 16\",\n  \"countryCode\": \"sample string 17\",\n  \"subscribe\": \"sample string 18\",\n  \"userSettings\": [\n    {}\n  ],\n  \"accountManagementGranular\": {\n    \"canManageUsers\": \"sample string 1\",\n    \"canManageAdmins\": \"sample string 2\",\n    \"canManageGroups\": \"sample string 3\",\n    \"canManageSharing\": \"sample string 4\",\n    \"canManageEnvelopeTransfer\": \"sample string 5\",\n    \"canManageAccountSettings\": \"sample string 6\",\n    \"canManageReporting\": \"sample string 7\",\n    \"canManageAccountSecuritySettings\": \"sample string 8\",\n    \"canManageSigningGroups\": \"sample string 9\",\n    \"canManageDocumentRetention\": \"sample string 10\",\n    \"canViewUsers\": \"sample string 11\",\n    \"canManageUsersMetadata\": {\n      \"rights\": \"sample string 1\",\n      \"uiHint\": \"sample string 2\",\n      \"uiType\": \"sample string 3\",\n      \"uiOrder\": \"sample string 4\",\n      \"is21CFRPart11\": \"sample string 5\",\n      \"options\": [\n        \"sample string 1\"\n      ]\n    },\n    \"canManageAdminsMetadata\": {},\n    \"canManageGroupsMetadata\": {},\n    \"canManageSharingMetadata\": {},\n    \"canManageEnvelopeTransferMetadata\": {},\n    \"canManageAccountSettingsMetadata\": {},\n    \"canManageReportingMetadata\": {},\n    \"canManageAccountSecuritySettingsMetadata\": {},\n    \"canManageSigningGroupsMetadata\": {},\n    \"canManageDocumentRetentionMetadata\": {},\n    \"canViewUsersMetadata\": {}\n  },\n  \"sendActivationOnInvalidLogin\": \"sample string 19\",\n  \"activationAccessCode\": \"sample string 20\",\n  \"enableConnectForUser\": \"sample string 21\",\n  \"forgottenPasswordInfo\": {\n    \"forgottenPasswordQuestion1\": \"sample string 1\",\n    \"forgottenPasswordAnswer1\": \"sample string 2\",\n    \"forgottenPasswordQuestion2\": \"sample string 3\",\n    \"forgottenPasswordAnswer2\": \"sample string 4\",\n    \"forgottenPasswordQuestion3\": \"sample string 5\",\n    \"forgottenPasswordAnswer3\": \"sample string 6\",\n    \"forgottenPasswordQuestion4\": \"sample string 7\",\n    \"forgottenPasswordAnswer4\": \"sample string 8\"\n  },\n  \"groupList\": [\n    {\n      \"groupId\": \"sample string 1\",\n      \"groupName\": \"sample string 2\",\n      \"permissionProfileId\": \"sample string 3\",\n      \"groupType\": \"sample string 4\",\n      \"users\": [\n        {\n          \"userName\": \"sample string 1\",\n          \"userId\": \"sample string 2\",\n          \"email\": \"sample string 3\",\n          \"userType\": \"sample string 4\",\n          \"userStatus\": \"sample string 5\",\n          \"uri\": \"sample string 6\",\n          \"loginStatus\": \"sample string 7\",\n          \"sendActivationEmail\": \"sample string 8\",\n          \"activationAccessCode\": \"sample string 9\"\n        }\n      ]\n    }\n  ],\n  \"workAddress\": {\n    \"address1\": \"sample string 1\",\n    \"address2\": \"sample string 2\",\n    \"city\": \"sample string 3\",\n    \"stateOrProvince\": \"sample string 4\",\n    \"postalCode\": \"sample string 5\",\n    \"phone\": \"sample string 6\",\n    \"fax\": \"sample string 7\",\n    \"country\": \"sample string 8\"\n  },\n  \"homeAddress\": {},\n  \"loginStatus\": \"sample string 22\",\n  \"passwordExpiration\": \"sample string 23\",\n  \"lastLogin\": \"sample string 24\",\n  \"sendActivationEmail\": \"sample string 25\",\n  \"customSettings\": [\n    {}\n  ],\n  \"profileImageUri\": \"sample string 26\",\n  \"userProfileLastModifiedDate\": \"sample string 27\",\n  \"signatureImageUri\": \"sample string 28\",\n  \"initialsImageUri\": \"sample string 29\",\n  \"jobTitle\": \"sample string 30\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/users/{{userId}}?allow_all_languages={{allow_all_languages}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "users",
        "{{userId}}"
      ],
      "query": [
        {
          "key": "allow_all_languages",
          "value": "{{allow_all_languages}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "userId",
          "value": "{{userId}}"
        }
      ]
    }
  },
  "response": [
  ]
}