`dropbox_sign.TeamApi`

All URIs are relative to https://api.hellosign.com/v3

Method	HTTP request	Description
`team_add_member`	`PUT /team/add_member`	Add User to Team
`team_create`	`POST /team/create`	Create Team
`team_delete`	`DELETE /team/destroy`	Delete Team
`team_get`	`GET /team`	Get Team
`team_info`	`GET /team/info`	Get Team Info
`team_invites`	`GET /team/invites`	List Team Invites
`team_members`	`GET /team/members/{team_id}`	List Team Members
`team_remove_member`	`POST /team/remove_member`	Remove User from Team
`team_sub_teams`	`GET /team/sub_teams/{team_id}`	List Sub Teams
`team_update`	`PUT /team`	Update Team

`team_add_member`

TeamGetResponse team_add_member(team_add_member_request)

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.

Example

Basic Authentication (api_key):
Bearer (JWT) Authentication (oauth2):

from pprint import pprint

from dropbox_sign import \
    ApiClient, ApiException, Configuration, apis, models

configuration = Configuration(
    # Configure HTTP basic authorization: api_key
    username="YOUR_API_KEY",

    # or, configure Bearer (JWT) authorization: oauth2
    # access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
    team_api = apis.TeamApi(api_client)

    data = models.TeamAddMemberRequest(
        email_address="george@example.com",
    )

    try:
        response = team_api.team_add_member(data)
        pprint(response)
    except ApiException as e:
        print("Exception when calling Dropbox Sign API: %s\n" % e)

Parameters

Name	Type	Description	Notes
`team_add_member_request`	TeamAddMemberRequest
`team_id`	str	The id of the team.	[optional]

Return type

TeamGetResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

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]

`team_create`

TeamGetResponse team_create(team_create_request)

Create Team

Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.

Example

Basic Authentication (api_key):
Bearer (JWT) Authentication (oauth2):

from pprint import pprint

from dropbox_sign import \
    ApiClient, ApiException, Configuration, apis, models

configuration = Configuration(
    # Configure HTTP basic authorization: api_key
    username="YOUR_API_KEY",

    # or, configure Bearer (JWT) authorization: oauth2
    # access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
    team_api = apis.TeamApi(api_client)

    data = models.TeamCreateRequest(
        name="New Team Name",
    )

    try:
        response = team_api.team_create(data)
        pprint(response)
    except ApiException as e:
        print("Exception when calling Dropbox Sign API: %s\n" % e)

Parameters

Name	Type	Description	Notes
`team_create_request`	TeamCreateRequest

Return type

TeamGetResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

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]

`team_delete`

team_delete()

Delete Team

Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).

Example

Basic Authentication (api_key):
Bearer (JWT) Authentication (oauth2):

from dropbox_sign import \
    ApiClient, ApiException, Configuration, apis

configuration = Configuration(
    # Configure HTTP basic authorization: api_key
    username="YOUR_API_KEY",

    # or, configure Bearer (JWT) authorization: oauth2
    # access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
    team_api = apis.TeamApi(api_client)

    try:
        team_api.team_delete()
    except ApiException as e:
        print("Exception when calling Dropbox Sign API: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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]

`team_get`

TeamGetResponse team_get()

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.

Example

Basic Authentication (api_key):
Bearer (JWT) Authentication (oauth2):

from pprint import pprint

from dropbox_sign import \
    ApiClient, ApiException, Configuration, apis

configuration = Configuration(
    # Configure HTTP basic authorization: api_key
    username="YOUR_API_KEY",

    # or, configure Bearer (JWT) authorization: oauth2
    # access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
    team_api = apis.TeamApi(api_client)

    try:
        response = team_api.team_get()
        pprint(response)
    except ApiException as e:
        print("Exception when calling Dropbox Sign API: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

TeamGetResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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]

`team_info`

TeamGetInfoResponse team_info()

Get Team Info

Provides information about a team.

Example

Basic Authentication (api_key):
Bearer (JWT) Authentication (oauth2):

from pprint import pprint

from dropbox_sign import \
    ApiClient, ApiException, Configuration, apis

configuration = Configuration(
    # Configure HTTP basic authorization: api_key
    username="YOUR_API_KEY",

    # or, configure Bearer (JWT) authorization: oauth2
    # access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
    team_api = apis.TeamApi(api_client)

    try:
        response = team_api.team_info()
        pprint(response)
    except ApiException as e:
        print("Exception when calling Dropbox Sign API: %s\n" % e)

Parameters

Name	Type	Description	Notes
`team_id`	str	The id of the team.	[optional]

Return type

TeamGetInfoResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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]

`team_invites`

TeamInvitesResponse team_invites()

List Team Invites

Provides a list of team invites (and their roles).

Example

Basic Authentication (api_key):
Bearer (JWT) Authentication (oauth2):

from pprint import pprint

from dropbox_sign import \
    ApiClient, ApiException, Configuration, apis

configuration = Configuration(
    # Configure HTTP basic authorization: api_key
    username="YOUR_API_KEY",

    # or, configure Bearer (JWT) authorization: oauth2
    # access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
    team_api = apis.TeamApi(api_client)

    email_address = "user@dropboxsign.com"

    try:
        response = team_api.team_invites(email_address=email_address)
        pprint(response)
    except ApiException as e:
        print("Exception when calling Dropbox Sign API: %s\n" % e)

Parameters

Name	Type	Description	Notes
`email_address`	str	The email address for which to display the team invites.	[optional]

Return type

TeamInvitesResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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]

`team_members`

TeamMembersResponse team_members(team_id)

List Team Members

Provides a paginated list of members (and their roles) that belong to a given team.

Example

Basic Authentication (api_key):
Bearer (JWT) Authentication (oauth2):

from pprint import pprint

from dropbox_sign import \
    ApiClient, ApiException, Configuration, apis

configuration = Configuration(
    # Configure HTTP basic authorization: api_key
    username="YOUR_API_KEY",

    # or, configure Bearer (JWT) authorization: oauth2
    # access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
    team_api = apis.TeamApi(api_client)

    team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"

    try:
        response = team_api.team_members(team_id)
        pprint(response)
    except ApiException as e:
        print("Exception when calling Dropbox Sign API: %s\n" % e)

Parameters

Name	Type	Description	Notes
`team_id`	str	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]
`page_size`	int	Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.	[optional][default to 20]

Return type

TeamMembersResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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]

`team_remove_member`

TeamGetResponse team_remove_member(team_remove_member_request)

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.

Example

Basic Authentication (api_key):
Bearer (JWT) Authentication (oauth2):

from pprint import pprint

from dropbox_sign import \
    ApiClient, ApiException, Configuration, apis, models

configuration = Configuration(
    # Configure HTTP basic authorization: api_key
    username="YOUR_API_KEY",

    # or, configure Bearer (JWT) authorization: oauth2
    # access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
    team_api = apis.TeamApi(api_client)

    data = models.TeamRemoveMemberRequest(
        email_address="teammate@dropboxsign.com",
        new_owner_email_address="new_teammate@dropboxsign.com",
    )

    try:
        response = team_api.team_remove_member(data)
        pprint(response)
    except ApiException as e:
        print("Exception when calling Dropbox Sign API: %s\n" % e)

Parameters

Name	Type	Description	Notes
`team_remove_member_request`	TeamRemoveMemberRequest

Return type

TeamGetResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

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]

`team_sub_teams`

TeamSubTeamsResponse team_sub_teams(team_id)

List Sub Teams

Provides a paginated list of sub teams that belong to a given team.

Example

Basic Authentication (api_key):
Bearer (JWT) Authentication (oauth2):

from pprint import pprint

from dropbox_sign import \
    ApiClient, ApiException, Configuration, apis

configuration = Configuration(
    # Configure HTTP basic authorization: api_key
    username="YOUR_API_KEY",

    # or, configure Bearer (JWT) authorization: oauth2
    # access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
    team_api = apis.TeamApi(api_client)

    team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"

    try:
        response = team_api.team_sub_teams(team_id)
        pprint(response)
    except ApiException as e:
        print("Exception when calling Dropbox Sign API: %s\n" % e)

Parameters

Name	Type	Description	Notes
`team_id`	str	The id of the parent Team.
`page`	int	Which page number of the SubTeam List to return. Defaults to `1`.	[optional][default to 1]
`page_size`	int	Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.	[optional][default to 20]

Return type

TeamSubTeamsResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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]

`team_update`

TeamGetResponse team_update(team_update_request)

Update Team

Updates the name of your Team.

Example

Basic Authentication (api_key):
Bearer (JWT) Authentication (oauth2):

from pprint import pprint

from dropbox_sign import \
    ApiClient, ApiException, Configuration, apis, models

configuration = Configuration(
    # Configure HTTP basic authorization: api_key
    username="YOUR_API_KEY",

    # or, configure Bearer (JWT) authorization: oauth2
    # access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
    team_api = apis.TeamApi(api_client)

    data = models.TeamUpdateRequest(
        name="New Team Name",
    )

    try:
        response = team_api.team_update(data)
        pprint(response)
    except ApiException as e:
        print("Exception when calling Dropbox Sign API: %s\n" % e)

Parameters

Name	Type	Description	Notes
`team_update_request`	TeamUpdateRequest

Return type

TeamGetResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

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]

Files

TeamApi.md

Latest commit

History

TeamApi.md

File metadata and controls

dropbox_sign.TeamApi

team_add_member

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

team_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

team_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

team_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

team_info

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

team_invites

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

team_members

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

team_remove_member

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

team_sub_teams

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

team_update

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

`dropbox_sign.TeamApi`

`team_add_member`

`team_create`

`team_delete`

`team_get`

`team_info`

`team_invites`

`team_members`

`team_remove_member`

`team_sub_teams`

`team_update`