Chilkat Online Tools

Foxpro / DocuSign REST API / Creates one or more groups for the account.

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* 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"
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("groups[0].groupId","sample string 1")
loJson.UpdateString("groups[0].groupName","sample string 2")
loJson.UpdateString("groups[0].permissionProfileId","sample string 3")
loJson.UpdateString("groups[0].groupType","sample string 4")
loJson.UpdateString("groups[0].users[0].userName","sample string 1")
loJson.UpdateString("groups[0].users[0].userId","sample string 2")
loJson.UpdateString("groups[0].users[0].email","sample string 3")
loJson.UpdateString("groups[0].users[0].userType","sample string 4")
loJson.UpdateString("groups[0].users[0].userStatus","sample string 5")
loJson.UpdateString("groups[0].users[0].uri","sample string 6")
loJson.UpdateString("groups[0].users[0].loginStatus","sample string 7")
loJson.UpdateString("groups[0].users[0].sendActivationEmail","sample string 8")
loJson.UpdateString("groups[0].users[0].activationAccessCode","sample string 9")
loJson.UpdateString("resultSetSize","sample string 1")
loJson.UpdateString("totalSetSize","sample string 2")
loJson.UpdateString("startPosition","sample string 3")
loJson.UpdateString("endPosition","sample string 4")
loJson.UpdateString("nextUri","sample string 5")
loJson.UpdateString("previousUri","sample string 6")

* Adds the "Authorization: Bearer {{accessToken}}" header.
loHttp.AuthToken = "{{accessToken}}"
loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.PostJson3("https://domain.com/v2.1/accounts/{{accountId}}/groups","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson

Curl Command

curl -X POST
	-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": "Creates one or more groups for the account.",
  "request": {
    "method": "POST",
    "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": "Creates one or more groups for the account.\n\nGroups can be used to help manage users by associating users with a group. You can associate a group with a Permission Profile, which sets the user permissions for users in that group without having to set the `userSettings` property for each user. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. You can also use groups with template sharing to limit user access to templates."
  },
  "response": [
  ]
}