Chilkat Online Tools

autoit / DocuSign REST API / Updates the group information for a group.

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

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

; The following JSON is sent in the request body.

; {
;   "groups": [
;     {
;       "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"
;         }
;       ]
;     }
;   ],
;   "resultSetSize": "sample string 1",
;   "totalSetSize": "sample string 2",
;   "startPosition": "sample string 3",
;   "endPosition": "sample string 4",
;   "nextUri": "sample string 5",
;   "previousUri": "sample string 6"
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("groups[0].groupId","sample string 1")
$oJson.UpdateString("groups[0].groupName","sample string 2")
$oJson.UpdateString("groups[0].permissionProfileId","sample string 3")
$oJson.UpdateString("groups[0].groupType","sample string 4")
$oJson.UpdateString("groups[0].users[0].userName","sample string 1")
$oJson.UpdateString("groups[0].users[0].userId","sample string 2")
$oJson.UpdateString("groups[0].users[0].email","sample string 3")
$oJson.UpdateString("groups[0].users[0].userType","sample string 4")
$oJson.UpdateString("groups[0].users[0].userStatus","sample string 5")
$oJson.UpdateString("groups[0].users[0].uri","sample string 6")
$oJson.UpdateString("groups[0].users[0].loginStatus","sample string 7")
$oJson.UpdateString("groups[0].users[0].sendActivationEmail","sample string 8")
$oJson.UpdateString("groups[0].users[0].activationAccessCode","sample string 9")
$oJson.UpdateString("resultSetSize","sample string 1")
$oJson.UpdateString("totalSetSize","sample string 2")
$oJson.UpdateString("startPosition","sample string 3")
$oJson.UpdateString("endPosition","sample string 4")
$oJson.UpdateString("nextUri","sample string 5")
$oJson.UpdateString("previousUri","sample string 6")

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

$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/groups",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "groups": [
    {
      "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"
        }
      ]
    }
  ],
  "resultSetSize": "sample string 1",
  "totalSetSize": "sample string 2",
  "startPosition": "sample string 3",
  "endPosition": "sample string 4",
  "nextUri": "sample string 5",
  "previousUri": "sample string 6"
}'
https://domain.com/v2.1/accounts/{{accountId}}/groups

Postman Collection Item JSON

{
  "name": "Updates the group information for a group.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"groups\": [\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  \"resultSetSize\": \"sample string 1\",\n  \"totalSetSize\": \"sample string 2\",\n  \"startPosition\": \"sample string 3\",\n  \"endPosition\": \"sample string 4\",\n  \"nextUri\": \"sample string 5\",\n  \"previousUri\": \"sample string 6\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/groups",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "groups"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    },
    "description": "Updates the group name and modifies, or sets, the permission profile for the group."
  },
  "response": [
  ]
}