Action: Add User to Workspace

Docusign Operation

The Add User to Workspace action grants a new user access to a specific DocuSign workspace.

Example User Story

I want to add new team members to our DocuSign workspace automatically, so they can immediately access and collaborate on documents.

Fields

Field Name	Field Type	Required
workspaceId	String	Yes
userId	String	Yes
permissionProfileId	String	Yes
accessToken	String	Yes

Related Connections

Docusign

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "add-user-to-workspace",
  "state": "inDev",
  "meta": {
    "short": "Add User to Workspace",
    "description": "Adds a user to a specified workspace in DocuSign."
  },
  "input": [
    {
      "name": "workspaceId",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The ID of the workspace to which the user will be added."
      }
    },
    {
      "name": "userId",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The ID of the user to be added to the workspace."
      }
    },
    {
      "name": "permissionProfileId",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The ID of the permission profile to assign to the user."
      }
    }
  ],
  "output": [
    {
      "name": "success",
      "type": "Boolean",
      "selector": ["success"],
      "meta": {
        "description": "Indicates whether the operation was successful."
      }
    },
    {
      "name": "workspaceUserId",
      "type": "String",
      "selector": ["workspaceUserId"],
      "meta": {
        "description": "The ID of the newly created workspace user association."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/v2.1/workspaces/{{workspaceId}}/users",
        "headers": {
          "Content-Type": "application/json"
        },
        "bodyTemplate": {
          "value": "{\"userId\": \"{{userId}}\", \"permissionProfileId\": \"{{permissionProfileId}}\"}",
          "placeholders": [
            {
              "name": "accessToken",
              "type": "String",
              "description": "The access token for authenticating with the DocuSign API.",
              "required": true
            },
            {
              "name": "workspaceId",
              "type": "String",
              "description": "The ID of the workspace to which the user will be added.",
              "required": true
            },
            {
              "name": "userId",
              "type": "String",
              "description": "The ID of the user to be added to the workspace.",
              "required": true
            },
            {
              "name": "permissionProfileId",
              "type": "String",
              "description": "The ID of the permission profile to assign to the user.",
              "required": true
            }
          ]
        }
      }
    }
  ]
}