Add code samples and snippets for Workspace API (#121)

RomanBachaloSigmaSoftware · karissarjacobsen · web-flow · commit b6ac03b1fa1d · 2025-06-20T13:19:44.000-07:00
* add snippets and code samples

* file structure reorg

---------

Co-authored-by: Karissa Jacobsen &lt;karissa.jacobsen@docusign.com&gt;
diff --git a/api-reference/workspaces/accounts/workspaceDocuments/deleteWorkspaceDocument.sh b/api-reference/workspaces/accounts/workspaceDocuments/deleteWorkspaceDocument.sh
@@ -0,0 +1,6 @@
+#apx-snippet-start:deleteWorkspaceDocument
+Status=$(curl -s -w "%{http_code}\n" -i \
+    --request DELETE "https://api-d.docusign.com/v1/accounts/${account_id}/workspaces/${workspace_id}/documents/${document_id}" \
+    --header "Authorization: Bearer ${access_token}" \
+    --output ${response})
+#apx-snippet-end:deleteWorkspaceDocument
diff --git a/api-reference/workspaces/accounts/workspaceDocuments/getWorkspaceDocument.sh b/api-reference/workspaces/accounts/workspaceDocuments/getWorkspaceDocument.sh
@@ -0,0 +1,6 @@
+#apx-snippet-start:getWorkspaceDocument
+Status=$(curl -s -w "%{http_code}\n" -i \
+    --request GET "https://api-d.docusign.com/v1/accounts/${account_id}/workspaces/${workspace_id}/documents/${document_id}" \
+    --header "Authorization: Bearer ${access_token}" \
+    --output ${response})
+#apx-snippet-end:getWorkspaceDocument
diff --git a/api-reference/workspaces/accounts/workspaceDocuments/getWorkspaceDocumentContents.sh b/api-reference/workspaces/accounts/workspaceDocuments/getWorkspaceDocumentContents.sh
@@ -0,0 +1,6 @@
+#apx-snippet-start:getWorkspaceDocumentContents
+Status=$(curl -s -w "%{http_code}\n" -i \
+    --request GET "https://api-d.docusign.com/v1/accounts/${account_id}/workspaces/${workspace_id}/documents/${document_id}/contents" \
+    --header "Authorization: Bearer ${access_token}" \
+    --output ${response})
+#apx-snippet-end:getWorkspaceDocumentContents
diff --git a/api-reference/workspaces/accounts/workspaceDocuments/getWorkspaceDocuments.sh b/api-reference/workspaces/accounts/workspaceDocuments/getWorkspaceDocuments.sh
@@ -0,0 +1,6 @@
+#apx-snippet-start:getWorkspaceDocuments
+Status=$(curl -s -w "%{http_code}\n" -i \
+    --request GET "https://api-d.docusign.com/v1/accounts/${account_id}/workspaces/${workspace_id}/documents" \
+    --header "Authorization: Bearer ${access_token}" \
+    --output ${response})
+#apx-snippet-end:getWorkspaceDocuments
diff --git a/api-reference/workspaces/accounts/workspaceUsers/addWorkspaceUser.sh b/api-reference/workspaces/accounts/workspaceUsers/addWorkspaceUser.sh
@@ -0,0 +1,16 @@
+#apx-snippet-start:addWorkspaceUser
+printf \
+'{
+    "email": "'"${email}"'",
+    "first_name": "'"${first_name}"'",
+    "last_name": "'"${last_name}"'",
+    "role_id": "'"${role_id}"'"
+}' >> $request_data
+
+Status=$(curl -s -w "%{http_code}\n" -i \
+    --request POST "https://api-d.docusign.com/v1/accounts/${account_id}/workspaces/${workspace_id}/users" \
+    --header "Authorization: Bearer ${access_token}" \
+    --header 'Content-Type: application/json' \
+    --data-binary @${request_data} \
+    --output ${response})
+#apx-snippet-end:addWorkspaceUser
diff --git a/api-reference/workspaces/accounts/workspaceUsers/getWorkspaceUsers.sh b/api-reference/workspaces/accounts/workspaceUsers/getWorkspaceUsers.sh
@@ -0,0 +1,6 @@
+#apx-snippet-start:getWorkspaceUsers
+Status=$(curl -s -w "%{http_code}\n" -i \
+    --request GET "https://api-d.docusign.com/v1/accounts/${account_id}/workspaces/${workspace_id}/users" \
+    --header "Authorization: Bearer ${access_token}" \
+    --output ${response})
+#apx-snippet-end:getWorkspaceUsers
diff --git a/api-reference/workspaces/accounts/workspaceUsers/restoreWorkspaceUserAccess.sh b/api-reference/workspaces/accounts/workspaceUsers/restoreWorkspaceUserAccess.sh
@@ -0,0 +1,6 @@
+#apx-snippet-start:restoreWorkspaceUserAccess
+Status=$(curl -s -w "%{http_code}\n" -i \
+    --request POST "https://api-d.docusign.com/v1/accounts/${account_id}/workspaces/${workspace_id}/users/${user_id}/actions/restore-access" \
+    --header "Authorization: Bearer ${access_token}" \
+    --output ${response})
+#apx-snippet-end:restoreWorkspaceUserAccess
diff --git a/api-reference/workspaces/accounts/workspaceUsers/revokeWorkspaceUserAccess.sh b/api-reference/workspaces/accounts/workspaceUsers/revokeWorkspaceUserAccess.sh
@@ -0,0 +1,6 @@
+#apx-snippet-start:revokeWorkspaceUserAccess
+Status=$(curl -s -w "%{http_code}\n" -i \
+    --request POST "https://api-d.docusign.com/v1/accounts/${account_id}/workspaces/${workspace_id}/users/${user_id}/actions/revoke-access" \
+    --header "Authorization: Bearer ${access_token}" \
+    --output ${response})
+#apx-snippet-end:revokeWorkspaceUserAccess
diff --git a/api-reference/workspaces/accounts/workspaceUsers/updateWorkspaceUser.sh b/api-reference/workspaces/accounts/workspaceUsers/updateWorkspaceUser.sh
@@ -0,0 +1,13 @@
+#apx-snippet-start:updateWorkspaceUser
+printf \
+'{
+    "role_id": "'"${role_id}"'"
+}' >> $request_data
+
+Status=$(curl -s -w "%{http_code}\n" -i \
+    --request PUT "https://api-d.docusign.com/v1/accounts/${account_id}/workspaces/${workspace_id}/users/${user_id}" \
+    --header "Authorization: Bearer ${access_token}" \
+    --header 'Content-Type: application/json' \
+    --data-binary @${request_data} \
+    --output ${response})
+#apx-snippet-end:updateWorkspaceUser
diff --git a/api-reference/workspaces/accounts/workspaces/getWorkspace.sh b/api-reference/workspaces/accounts/workspaces/getWorkspace.sh
@@ -0,0 +1,6 @@
+#apx-snippet-start:getWorkspace
+Status=$(curl -s -w "%{http_code}\n" -i \
+    --request GET "https://api-d.docusign.com/v1/accounts/${account_id}/workspaces/${workspace_id}" \
+    --header "Authorization: Bearer ${access_token}" \
+    --output ${response})
+#apx-snippet-end:getWorkspace
diff --git a/api-reference/workspaces/accounts/workspaces/getWorkspaceAssignableRoles.sh b/api-reference/workspaces/accounts/workspaces/getWorkspaceAssignableRoles.sh
@@ -0,0 +1,6 @@
+#apx-snippet-start:getWorkspaceAssignableRoles
+Status=$(curl -s -w "%{http_code}\n" -i \
+    --request GET "https://api-d.docusign.com/v1/accounts/${account_id}/workspaces/${workspace_id}/assignable-roles" \
+    --header "Authorization: Bearer ${access_token}" \
+    --output ${response})
+#apx-snippet-end:getWorkspaceAssignableRoles
diff --git a/api-reference/workspaces/accounts/workspaces/getWorkspaceEnvelopes.sh b/api-reference/workspaces/accounts/workspaces/getWorkspaceEnvelopes.sh
@@ -0,0 +1,6 @@
+#apx-snippet-start:getWorkspaceEnvelopes
+Status=$(curl -s -w "%{http_code}\n" -i \
+    --request GET "https://api-d.docusign.com/v1/accounts/${account_id}/workspaces/${workspace_id}/envelopes" \
+    --header "Authorization: Bearer ${access_token}" \
+    --output ${response})
+#apx-snippet-end:getWorkspaceEnvelopes
diff --git a/api-reference/workspaces/accounts/workspaces/getWorkspaces.sh b/api-reference/workspaces/accounts/workspaces/getWorkspaces.sh
@@ -0,0 +1,6 @@
+#apx-snippet-start:getWorkspaces
+Status=$(curl -s -w "%{http_code}\n" -i \
+    --request GET "https://api-d.docusign.com/v1/accounts/${account_id}/workspaces" \
+    --header "Authorization: Bearer ${access_token}" \
+    --output ${response})
+#apx-snippet-end:getWorkspaces
diff --git a/examples/Workspaces/eg001CreateWorkspace.sh b/examples/Workspaces/eg001CreateWorkspace.sh
@@ -27,6 +27,7 @@ declare -a Headers=('--header' "Authorization: Bearer ${ACCESS_TOKEN}" \
 #ds-snippet-end:Workspaces1Step2
 
 # Create the workspace definition
+#apx-snippet-start:createWorkspace
 #ds-snippet-start:Workspaces1Step3
 printf \
 '{
@@ -41,6 +42,7 @@ Status=$(curl -s -w "%{http_code}\n" -i \
     --data-binary @${request_data} \
     --output ${response})
 #ds-snippet-end:Workspaces1Step4
+#apx-snippet-end:createWorkspace
 
 if [[ "$Status" -gt "201" ]] ; then
   echo ""
diff --git a/examples/Workspaces/eg002AddDocumentToWorkspace.sh b/examples/Workspaces/eg002AddDocumentToWorkspace.sh
@@ -56,6 +56,7 @@ echo ""
 read doc_name
 #ds-snippet-end:Workspaces2Step3
 
+#apx-snippet-start:addWorkspaceDocument
 #ds-snippet-start:Workspaces2Step4
 Status=$(curl -s -w "%{http_code}" -o "${response}" \
     --request POST "${base_path}/accounts/${account_id}/workspaces/${workspace_id}/documents" \
@@ -64,6 +65,7 @@ Status=$(curl -s -w "%{http_code}" -o "${response}" \
     -F "name=${doc_name}"
 )
 #ds-snippet-end:Workspaces2Step4
+#apx-snippet-end:addWorkspaceDocument
 
 
 if [[ "$Status" -gt "201" ]]; then
diff --git a/examples/Workspaces/eg003SendEnvelopeWithRecipientInfo.sh b/examples/Workspaces/eg003SendEnvelopeWithRecipientInfo.sh
@@ -42,6 +42,7 @@ declare -a Headers=('--header' "Authorization: Bearer ${ACCESS_TOKEN}" \
 #ds-snippet-end:Workspaces3Step2
 
 # Create the workspace envelope definition
+#apx-snippet-start:createWorkspaceEnvelope
 #ds-snippet-start:Workspaces3Step3
 printf \
 '{
@@ -57,6 +58,7 @@ Status=$(curl -s -w "%{http_code}\n" -i \
     --data-binary @${request_data} \
     --output ${response})
 #ds-snippet-end:Workspaces3Step4
+#apx-snippet-end:createWorkspaceEnvelope
 
 if [[ "$Status" -gt "201" ]] ; then
   echo ""
