Users

The user's APIs are primarily used to interact with the BoldSign application to create, send, and manage documents. This section demonstrates how to create users, update user roles, cancel user invitations, resend user invitations and get user details. Users can be created programmatically or through the BoldSign web interface and they can be used by your application.

Create users

post/v1/users/create

The create user API is used to invite new users to their BoldSign organization with their unique email addresses if they don't already have one. You can create the maximum number of users based on their BoldSign subscription plan.

All newly invited users will receive a verification email from BoldSign, and a member account will be created by default. After verification, the invited user can create a password.

Code snippet

curl -X 'POST' \
  'https://api.boldsign.com/v1/users/create' \
  -H 'accept: */*' \
  -H 'X-API-KEY: {your API key}' \
  -H 'Content-Type: application/json;odata.metadata=minimal;odata.streaming=true' \
  -d '[
  {
    "emailId": "luthercooper@cubeflakes.com",
    "teamId": "xxc5b097-xxxx-xxxx-xxxx-afd07c66xxxx",
    "userRole": "Admin"
  },
  {
    "emailId": "hankwhite@cubeflakes.com",
    "teamId": "xxc5b097-xxxx-xxxx-xxxx-afd07c66xxxx",
    "userRole": "Member"
  }
]'
           var apiClient = new ApiClient("https://api.boldsign.com", "{apikey}");
           var userClient = new UserClient(apiClient);
           List<CreateUserRequest> createUserRequest = new List<CreateUserRequest>()
            {
                new CreateUserRequest()
                {
                    EmailId= "luthercooper@cubeflakes.com",
                TeamId= "xxc5b097-xxxx-xxxx-xxxx-afd07c66xxxx",
                UserRole=UserRoleType.TeamAdmin
                },
                new CreateUserRequest()
                {
                    EmailId= "hankwhite@cubeflakes.com",
                TeamId= "xxc5b097-xxxx-xxxx-xxxx-afd07c66xxxx",
                UserRole=UserRoleType.Member
                }
            };
         
            var createUserResponse = await userClient.CreateUserAsync(createUserRequest).ConfigureAwait(false);
import requests

url = "https://api.boldsign.com/v1/users/create"

payload = "[\n  {\n    \"emailId\": \"luthercooper@cubeflakes.com\",\n    \"teamId\": \"xxc5b097-xxxx-xxxx-xxxx-afd07c66xxxx\",\n    \"userRole\": \"Admin\"\n  },\n  {\n    \"emailId\": \"hankwhite@cubeflakes.com\",\n    \"teamId\": \"xxc5b097-xxxx-xxxx-xxxx-afd07c66xxxx\",\n    \"userRole\": \"Member\"\n  }\n]"
headers = {
  'accept': '*/*',
  'X-API-KEY': '{your API key}',
  'Content-Type': 'application/json;odata.metadata=minimal;odata.streaming=true'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
const axios = require('axios');
const response = await axios.post(
    'https://api.boldsign.com/v1/users/create',
    [
        {
            'emailId': 'luthercooper@cubeflakes.com',
            'teamId': 'xxc5b097-xxxx-xxxx-xxxx-afd07c66xxxx',
            'userRole': 'Admin'
        },
        {
            'emailId': 'hankwhite@cubeflakes.com',
            'teamId': 'xxc5b097-xxxx-xxxx-xxxx-afd07c66xxxx',
            'userRole': 'Member'
        }
    ],
    {
        headers: {
            'accept': '*/*',
            'X-API-KEY': '{your API key}',
            'Content-Type': 'application/json;odata.metadata=minimal;odata.streaming=true'
        }
    }
);

Request body

heading1heading2
emailIdstringRequiredThe email address of the user.
teamIdstringRequiredThe id of the team.
userRolestringRequiredRepresents a user role in their organization.

Example response

200 Success

{
  "users": [
    {
      "emailId": "luthercooper@cubeflakes.com",
      "userId": "e892ea92-xxxx-xxxx-xxxx-bbdbcaa5xxxx",
      "teamId": "xxc5b097-xxxx-xxxx-xxxx-afd07c66xxxx"
    },
    {
      "emailId": "hankwhite@cubeflakes.com",
      "userId": "8eec6e8d-xxxx-xxxx-xxxx-bfc81abcxxxx",
      "teamId": "xxc5b097-xxxx-xxxx-xxxx-afd07c66xxxx"
    }
  ]
}