DataFlex / DocuSign REST API / Creates a signing group.
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
Variant vResp
Handle hoResp
String sTemp1
Integer iTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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"
// }
// ]
// }
// ]
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "groups[0].signingGroupId" "sample string 1" To iSuccess
Get ComUpdateString Of hoJson "groups[0].groupName" "sample string 2" To iSuccess
Get ComUpdateString Of hoJson "groups[0].groupType" "sample string 3" To iSuccess
Get ComUpdateString Of hoJson "groups[0].groupEmail" "sample string 4" To iSuccess
Get ComUpdateString Of hoJson "groups[0].created" "sample string 5" To iSuccess
Get ComUpdateString Of hoJson "groups[0].createdBy" "sample string 6" To iSuccess
Get ComUpdateString Of hoJson "groups[0].modified" "sample string 7" To iSuccess
Get ComUpdateString Of hoJson "groups[0].modifiedBy" "sample string 8" To iSuccess
Get ComUpdateString Of hoJson "groups[0].users[0].userName" "sample string 1" To iSuccess
Get ComUpdateString Of hoJson "groups[0].users[0].email" "sample string 2" To iSuccess
// Adds the "Authorization: Bearer {{accessToken}}" header.
Set ComAuthToken Of hoHttp To "{{accessToken}}"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://domain.com/v2.1/accounts/{{accountId}}/signing_groups" "application/json" vJson To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
Showln iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln sTemp1
Send Destroy of hoResp
End_Procedure
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": [
]
}