All URIs are relative to https://api.hellosign.com/v3
Method | HTTP request | Description |
---|---|---|
TeamAddMember | PUT /team/add_member | Add User to Team |
TeamCreate | POST /team/create | Create Team |
TeamDelete | DELETE /team/destroy | Delete Team |
TeamGet | GET /team | Get Team |
TeamInfo | GET /team/info | Get Team Info |
TeamInvites | GET /team/invites | List Team Invites |
TeamMembers | GET /team/members/{team_id} | List Team Members |
TeamRemoveMember | POST /team/remove_member | Remove User from Team |
TeamSubTeams | GET /team/sub_teams/{team_id} | List Sub Teams |
TeamUpdate | PUT /team | Update Team |
TeamGetResponse TeamAddMember (TeamAddMemberRequest teamAddMemberRequest, string? teamId = null)
Add User to Team
Invites a user (specified using the email_address
parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a team_invite_failed
error will be returned.
using System;
using System.Collections.Generic;
using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;
public class Example
{
public static void Main()
{
var config = new Configuration();
// Configure HTTP basic authorization: api_key
config.Username = "YOUR_API_KEY";
// or, configure Bearer (JWT) authorization: oauth2
// config.AccessToken = "YOUR_BEARER_TOKEN";
var teamApi = new TeamApi(config);
var data = new TeamAddMemberRequest(
emailAddress: "george@example.com"
);
try
{
var result = teamApi.TeamAddMember(data);
Console.WriteLine(result);
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
Console.WriteLine("Status Code: " + e.ErrorCode);
Console.WriteLine(e.StackTrace);
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Add User to Team
ApiResponse<TeamGetResponse> response = apiInstance.TeamAddMemberWithHttpInfo(teamAddMemberRequest, teamId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.TeamAddMemberWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
teamAddMemberRequest | TeamAddMemberRequest | ||
teamId | string? | The id of the team. | [optional] |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
4XX | failed_operation | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TeamGetResponse TeamCreate (TeamCreateRequest teamCreateRequest)
Create Team
Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.
using System;
using System.Collections.Generic;
using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;
public class Example
{
public static void Main()
{
var config = new Configuration();
// Configure HTTP basic authorization: api_key
config.Username = "YOUR_API_KEY";
// or, configure Bearer (JWT) authorization: oauth2
// config.AccessToken = "YOUR_BEARER_TOKEN";
var teamApi = new TeamApi(config);
var data = new TeamCreateRequest(
name: "New Team Name"
);
try
{
var result = teamApi.TeamCreate(data);
Console.WriteLine(result);
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
Console.WriteLine("Status Code: " + e.ErrorCode);
Console.WriteLine(e.StackTrace);
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Create Team
ApiResponse<TeamGetResponse> response = apiInstance.TeamCreateWithHttpInfo(teamCreateRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.TeamCreateWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
teamCreateRequest | TeamCreateRequest |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
4XX | failed_operation | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void TeamDelete ()
Delete Team
Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).
using System;
using System.Collections.Generic;
using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;
public class Example
{
public static void Main()
{
var config = new Configuration();
// Configure HTTP basic authorization: api_key
config.Username = "YOUR_API_KEY";
// or, configure Bearer (JWT) authorization: oauth2
// config.AccessToken = "YOUR_BEARER_TOKEN";
var teamApi = new TeamApi(config);
try
{
teamApi.TeamDelete();
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
Console.WriteLine("Status Code: " + e.ErrorCode);
Console.WriteLine(e.StackTrace);
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Delete Team
apiInstance.TeamDeleteWithHttpInfo();
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.TeamDeleteWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
This endpoint does not need any parameter.
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
4XX | failed_operation | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TeamGetResponse TeamGet ()
Get Team
Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of "not_found" will be returned.
using System;
using System.Collections.Generic;
using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;
public class Example
{
public static void Main()
{
var config = new Configuration();
// Configure HTTP basic authorization: api_key
config.Username = "YOUR_API_KEY";
// or, configure Bearer (JWT) authorization: oauth2
// config.AccessToken = "YOUR_BEARER_TOKEN";
var teamApi = new TeamApi(config);
try
{
var result = teamApi.TeamGet();
Console.WriteLine(result);
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
Console.WriteLine("Status Code: " + e.ErrorCode);
Console.WriteLine(e.StackTrace);
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get Team
ApiResponse<TeamGetResponse> response = apiInstance.TeamGetWithHttpInfo();
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.TeamGetWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
4XX | failed_operation | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TeamGetInfoResponse TeamInfo (string? teamId = null)
Get Team Info
Provides information about a team.
using System;
using System.Collections.Generic;
using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;
public class Example
{
public static void Main()
{
var config = new Configuration();
// Configure HTTP basic authorization: api_key
config.Username = "YOUR_API_KEY";
// or, configure Bearer (JWT) authorization: oauth2
// config.AccessToken = "YOUR_BEARER_TOKEN";
var teamApi = new TeamApi(config);
try
{
var result = teamApi.TeamInfo();
Console.WriteLine(result);
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
Console.WriteLine("Status Code: " + e.ErrorCode);
Console.WriteLine(e.StackTrace);
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get Team Info
ApiResponse<TeamGetInfoResponse> response = apiInstance.TeamInfoWithHttpInfo(teamId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.TeamInfoWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
teamId | string? | The id of the team. | [optional] |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
4XX | failed_operation | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TeamInvitesResponse TeamInvites (string? emailAddress = null)
List Team Invites
Provides a list of team invites (and their roles).
using System;
using System.Collections.Generic;
using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;
public class Example
{
public static void Main()
{
var config = new Configuration();
// Configure HTTP basic authorization: api_key
config.Username = "YOUR_API_KEY";
// or, configure Bearer (JWT) authorization: oauth2
// config.AccessToken = "YOUR_BEARER_TOKEN";
var teamApi = new TeamApi(config);
var emailAddress = "user@dropboxsign.com";
try
{
var result = teamApi.TeamInvites(emailAddress);
Console.WriteLine(result);
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
Console.WriteLine("Status Code: " + e.ErrorCode);
Console.WriteLine(e.StackTrace);
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// List Team Invites
ApiResponse<TeamInvitesResponse> response = apiInstance.TeamInvitesWithHttpInfo(emailAddress);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.TeamInvitesWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
emailAddress | string? | The email address for which to display the team invites. | [optional] |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
4XX | failed_operation | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TeamMembersResponse TeamMembers (string teamId, int? page = null, int? pageSize = null)
List Team Members
Provides a paginated list of members (and their roles) that belong to a given team.
using System;
using System.Collections.Generic;
using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;
public class Example
{
public static void Main()
{
var config = new Configuration();
// Configure HTTP basic authorization: api_key
config.Username = "YOUR_API_KEY";
// or, configure Bearer (JWT) authorization: oauth2
// config.AccessToken = "YOUR_BEARER_TOKEN";
var teamApi = new TeamApi(config);
var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c";
try
{
var result = teamApi.TeamMembers(teamId);
Console.WriteLine(result);
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
Console.WriteLine("Status Code: " + e.ErrorCode);
Console.WriteLine(e.StackTrace);
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// List Team Members
ApiResponse<TeamMembersResponse> response = apiInstance.TeamMembersWithHttpInfo(teamId, page, pageSize);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.TeamMembersWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
teamId | string | The id of the team that a member list is being requested from. | |
page | int? | Which page number of the team member list to return. Defaults to 1 . |
[optional] [default to 1] |
pageSize | int? | Number of objects to be returned per page. Must be between 1 and 100 . Default is 20 . |
[optional] [default to 20] |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
4XX | failed_operation | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TeamGetResponse TeamRemoveMember (TeamRemoveMemberRequest teamRemoveMemberRequest)
Remove User from Team
Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the new_owner_email_address
parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.
using System;
using System.Collections.Generic;
using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;
public class Example
{
public static void Main()
{
var config = new Configuration();
// Configure HTTP basic authorization: api_key
config.Username = "YOUR_API_KEY";
// or, configure Bearer (JWT) authorization: oauth2
// config.AccessToken = "YOUR_BEARER_TOKEN";
var teamApi = new TeamApi(config);
var data = new TeamRemoveMemberRequest(
emailAddress: "teammate@dropboxsign.com",
newOwnerEmailAddress: "new_teammate@dropboxsign.com"
);
try
{
var result = teamApi.TeamRemoveMember(data);
Console.WriteLine(result);
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
Console.WriteLine("Status Code: " + e.ErrorCode);
Console.WriteLine(e.StackTrace);
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Remove User from Team
ApiResponse<TeamGetResponse> response = apiInstance.TeamRemoveMemberWithHttpInfo(teamRemoveMemberRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.TeamRemoveMemberWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
teamRemoveMemberRequest | TeamRemoveMemberRequest |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
201 | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
4XX | failed_operation | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TeamSubTeamsResponse TeamSubTeams (string teamId, int? page = null, int? pageSize = null)
List Sub Teams
Provides a paginated list of sub teams that belong to a given team.
using System;
using System.Collections.Generic;
using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;
public class Example
{
public static void Main()
{
var config = new Configuration();
// Configure HTTP basic authorization: api_key
config.Username = "YOUR_API_KEY";
// or, configure Bearer (JWT) authorization: oauth2
// config.AccessToken = "YOUR_BEARER_TOKEN";
var teamApi = new TeamApi(config);
var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c";
try
{
var result = teamApi.TeamSubTeams(teamId);
Console.WriteLine(result);
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
Console.WriteLine("Status Code: " + e.ErrorCode);
Console.WriteLine(e.StackTrace);
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// List Sub Teams
ApiResponse<TeamSubTeamsResponse> response = apiInstance.TeamSubTeamsWithHttpInfo(teamId, page, pageSize);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.TeamSubTeamsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
teamId | string | The id of the parent Team. | |
page | int? | Which page number of the SubTeam List to return. Defaults to 1 . |
[optional] [default to 1] |
pageSize | int? | Number of objects to be returned per page. Must be between 1 and 100 . Default is 20 . |
[optional] [default to 20] |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
4XX | failed_operation | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TeamGetResponse TeamUpdate (TeamUpdateRequest teamUpdateRequest)
Update Team
Updates the name of your Team.
using System;
using System.Collections.Generic;
using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;
public class Example
{
public static void Main()
{
var config = new Configuration();
// Configure HTTP basic authorization: api_key
config.Username = "YOUR_API_KEY";
// or, configure Bearer (JWT) authorization: oauth2
// config.AccessToken = "YOUR_BEARER_TOKEN";
var teamApi = new TeamApi(config);
var data = new TeamUpdateRequest(
name: "New Team Name"
);
try
{
var result = teamApi.TeamUpdate(data);
Console.WriteLine(result);
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
Console.WriteLine("Status Code: " + e.ErrorCode);
Console.WriteLine(e.StackTrace);
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Update Team
ApiResponse<TeamGetResponse> response = apiInstance.TeamUpdateWithHttpInfo(teamUpdateRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.TeamUpdateWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
teamUpdateRequest | TeamUpdateRequest |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
4XX | failed_operation | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]