Chilkat Online Tools

Objective-C / DocuSign eSignature REST API / Adds one or more users to an existing group.

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

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

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"users[0].userName" value: @"sample string 1"];
[json UpdateString: @"users[0].userId" value: @"sample string 2"];
[json UpdateString: @"users[0].email" value: @"sample string 3"];
[json UpdateString: @"users[0].userType" value: @"sample string 4"];
[json UpdateString: @"users[0].userStatus" value: @"sample string 5"];
[json UpdateString: @"users[0].uri" value: @"sample string 6"];
[json UpdateString: @"users[0].loginStatus" value: @"sample string 7"];
[json UpdateString: @"users[0].sendActivationEmail" value: @"sample string 8"];
[json UpdateString: @"users[0].activationAccessCode" value: @"sample string 9"];

// Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = @"{{accessToken}}";
[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];

CkoHttpResponse *resp = [http PTextSb: @"PUT" url: @"https://domain.com/v2.1/accounts/{{accountId}}/groups/{{groupId}}/users" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

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": [
  ]
}