Chilkat Online Tools

Foxpro / DocuSign REST API / Adds one or more users to an existing group.

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
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.

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

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

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/groups/{{groupId}}/users",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    CANCEL
ENDIF

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

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "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"
    }
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/groups/{{groupId}}/users

Postman Collection Item JSON

{
  "name": "Adds one or more users to an existing group.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\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}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/groups/{{groupId}}/users",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "groups",
        "{{groupId}}",
        "users"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "groupId",
          "value": "{{groupId}}"
        }
      ]
    },
    "description": "Adds one or more users to an existing group."
  },
  "response": [
  ]
}