Chilkat Online Tools

Perl / DocuSign REST API / Creates a signing group.

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

# 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": [
#     {
#       "signingGroupId": "sample string 1",
#       "groupName": "sample string 2",
#       "groupType": "sample string 3",
#       "groupEmail": "sample string 4",
#       "created": "sample string 5",
#       "createdBy": "sample string 6",
#       "modified": "sample string 7",
#       "modifiedBy": "sample string 8",
#       "users": [
#         {
#           "userName": "sample string 1",
#           "email": "sample string 2"
#         }
#       ]
#     }
#   ]
# }

$json = chilkat::CkJsonObject->new();
$json->UpdateString("groups[0].signingGroupId","sample string 1");
$json->UpdateString("groups[0].groupName","sample string 2");
$json->UpdateString("groups[0].groupType","sample string 3");
$json->UpdateString("groups[0].groupEmail","sample string 4");
$json->UpdateString("groups[0].created","sample string 5");
$json->UpdateString("groups[0].createdBy","sample string 6");
$json->UpdateString("groups[0].modified","sample string 7");
$json->UpdateString("groups[0].modifiedBy","sample string 8");
$json->UpdateString("groups[0].users[0].userName","sample string 1");
$json->UpdateString("groups[0].users[0].email","sample string 2");

# Adds the "Authorization: Bearer {{accessToken}}" header.
$http->put_AuthToken("{{accessToken}}");
$http->SetRequestHeader("Accept","application/json");

# resp is a HttpResponse
$resp = $http->PostJson3("https://domain.com/v2.1/accounts/{{accountId}}/signing_groups","application/json",$json);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

print $resp->get_StatusCode() . "\r\n";
print $resp->bodyStr() . "\r\n";

Curl Command

curl -X POST
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "groups": [
    {
      "signingGroupId": "sample string 1",
      "groupName": "sample string 2",
      "groupType": "sample string 3",
      "groupEmail": "sample string 4",
      "created": "sample string 5",
      "createdBy": "sample string 6",
      "modified": "sample string 7",
      "modifiedBy": "sample string 8",
      "users": [
        {
          "userName": "sample string 1",
          "email": "sample string 2"
        }
      ]
    }
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/signing_groups

Postman Collection Item JSON

{
  "name": "Creates a signing group. ",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"groups\": [\n    {\n      \"signingGroupId\": \"sample string 1\",\n      \"groupName\": \"sample string 2\",\n      \"groupType\": \"sample string 3\",\n      \"groupEmail\": \"sample string 4\",\n      \"created\": \"sample string 5\",\n      \"createdBy\": \"sample string 6\",\n      \"modified\": \"sample string 7\",\n      \"modifiedBy\": \"sample string 8\",\n      \"users\": [\n        {\n          \"userName\": \"sample string 1\",\n          \"email\": \"sample string 2\"\n        }\n      ]\n    }\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/signing_groups",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "signing_groups"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    },
    "description": "Creates one or more signing groups. \n\nMultiple signing groups can be created in one call. Only users with account administrator privileges can create signing groups. \n\nAn account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members.\n \nSigning groups can be used by any account user."
  },
  "response": [
  ]
}