Chilkat Online Tools

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

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

    // 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"
    //     }
    //   ]
    // }

    let json = CkoJsonObject()!
    json.update("users[0].userName", value: "sample string 1")
    json.update("users[0].userId", value: "sample string 2")
    json.update("users[0].email", value: "sample string 3")
    json.update("users[0].userType", value: "sample string 4")
    json.update("users[0].userStatus", value: "sample string 5")
    json.update("users[0].uri", value: "sample string 6")
    json.update("users[0].loginStatus", value: "sample string 7")
    json.update("users[0].sendActivationEmail", value: "sample string 8")
    json.update("users[0].activationAccessCode", value: "sample string 9")

    // Adds the "Authorization: Bearer {{accessToken}}" header.
    http.authToken = "{{accessToken}}"
    http.setRequestHeader("Accept", value: "application/json")

    let sbRequestBody = CkoStringBuilder()!
    json.emitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.pTextSb("PUT", url: "https://domain.com/v2.1/accounts/{{accountId}}/groups/{{groupId}}/users", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("\(resp!.statusCode.intValue)")
    print("\(resp!.bodyStr!)")
    resp = nil

}

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}}",
          "type": "string"
        },
        {
          "key": "groupId",
          "value": "{{groupId}}",
          "type": "string"
        }
      ]
    },
    "description": "Adds one or more users to an existing group."
  },
  "response": [
  ]
}