Chilkat Online Tools

Ruby / DocuSign eSignature REST API / Adds members to a signing group.

Back to Collection Items

require '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.

# {
#   "users": [
#     {
#       "userName": "sample string 1",
#       "email": "sample string 2"
#     }
#   ]
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("users[0].userName","sample string 1")
json.UpdateString("users[0].email","sample string 2")

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

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/signing_groups/{{signingGroupId}}/users",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "users": [
    {
      "userName": "sample string 1",
      "email": "sample string 2"
    }
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/signing_groups/{{signingGroupId}}/users

Postman Collection Item JSON

{
  "name": "Adds members to a signing 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      \"email\": \"sample string 2\"\n    }\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/signing_groups/{{signingGroupId}}/users",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "signing_groups",
        "{{signingGroupId}}",
        "users"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "signingGroupId",
          "value": "{{signingGroupId}}",
          "type": "string"
        }
      ]
    },
    "description": "Adds one or more new members to a signing group. A signing group can have a maximum of 50 members. "
  },
  "response": [
  ]
}