Teams
You can create user groups within the organization for more effective administration. Teams allow you to protect documents from other team members and allow you to share templates across teams. The Teams API allows you to create, list the available teams, list the users in the team, search, delete, and update your teams.
Create a new team
post/v1/teams/createCreates a new team in your organization account. You can create multiple teams in your organization. For example: HR, Sales, Accounts, and more.
Code snippet
curl -X 'POST' \ 'https://api.boldsign.com/v1/teams/create' \ -H 'accept: application/json' \ -H 'X-API-KEY: {your API key}' \ -H 'Content-Type: application/json;odata.metadata=minimal;odata.streaming=true' \ -d '{ "teamName": "HR" }'
var apiClient = new ApiClient("YOUR_API_KEY"); var teamClient = new TeamClient(apiClient); var team = new CreateTeam() { TeamName = "HR" }; var teamCreated = teamClient.CreateTeam(team);
import boldsign configuration = boldsign.Configuration(api_key="YOUR_API_KEY") with boldsign.ApiClient(configuration) as api_client: teams_api = boldsign.TeamsApi(api_client) create_team_request = boldsign.CreateTeamRequest(teamName="HR") team_created = teams_api.create_team(create_team_request=create_team_request)
<?php require_once "vendor/autoload.php"; use BoldSign\Configuration; use BoldSign\Api\TeamsApi; use BoldSign\Model\CreateTeamRequest; $config = new Configuration(); $config->setApiKey('YOUR_API_KEY'); $teams_api = new TeamsApi($config); $create_team_request = new CreateTeamRequest(); $create_team_request->setTeamName('HR'); $team_created = $teams_api->createTeam($create_team_request);
ApiClient client = Configuration.getDefaultApiClient(); client.setApiKey("YOUR_API_KEY"); TeamsApi teamsApi = new TeamsApi(client); CreateTeamRequest createTeamRequest = new CreateTeamRequest(); createTeamRequest.setTeamName("HR"); TeamCreated teamCreated = teamsApi.createTeam(createTeamRequest);
import { CreateTeamRequest, TeamsApi } from "boldsign"; const teamsApi = new TeamsApi(); teamsApi.setApiKey("YOUR_API_KEY"); const createTeamRequest = new CreateTeamRequest(); createTeamRequest.teamName = "HR"; const teamCreated = teamsApi.createTeam(createTeamRequest);
Request body
teamNamestringRequired | The name of the team. |
Example response
200 Success
{ "teamId": "8b637de3-xxxx-xxxx-xxxx-6a4fdd0124b8" }