Dropbox\Sign\TeamApi

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

`teamAddMember()`

teamAddMember($team_add_member_request, $team_id): \Dropbox\Sign\Model\TeamGetResponse

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

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$teamApi = new Dropbox\Sign\Api\TeamApi($config);

$data = new Dropbox\Sign\Model\TeamAddMemberRequest();
$data->setEmailAddress("george@example.com");

try {
    $result = $teamApi->teamAddMember($data);
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

Name	Type	Description	Notes
team_add_member_request	\Dropbox\Sign\Model\TeamAddMemberRequest
team_id	string	The id of the team.	[optional]

Return type

\Dropbox\Sign\Model\TeamGetResponse

Authorization

api_key, oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`teamCreate()`

teamCreate($team_create_request): \Dropbox\Sign\Model\TeamGetResponse

Create Team

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

Example

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$teamApi = new Dropbox\Sign\Api\TeamApi($config);

$data = new Dropbox\Sign\Model\TeamCreateRequest();
$data->setName("New Team Name");

try {
    $result = $teamApi->teamCreate($data);
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

Name	Type	Description	Notes
team_create_request	\Dropbox\Sign\Model\TeamCreateRequest

Return type

\Dropbox\Sign\Model\TeamGetResponse

Authorization

api_key, oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`teamDelete()`

teamDelete()

Delete Team

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

Example

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$teamApi = new Dropbox\Sign\Api\TeamApi($config);

try {
    $teamApi->teamDelete();
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`teamGet()`

teamGet(): \Dropbox\Sign\Model\TeamGetResponse

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

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$teamApi = new Dropbox\Sign\Api\TeamApi($config);

try {
    $result = $teamApi->teamGet();
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

|This endpoint does not need any parameter. |

Return type

\Dropbox\Sign\Model\TeamGetResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`teamInfo()`

teamInfo($team_id): \Dropbox\Sign\Model\TeamGetInfoResponse

Get Team Info

Provides information about a team.

Example

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$teamApi = new Dropbox\Sign\Api\TeamApi($config);

try {
    $result = $teamApi->teamInfo();
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

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

Return type

\Dropbox\Sign\Model\TeamGetInfoResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`teamInvites()`

teamInvites($email_address): \Dropbox\Sign\Model\TeamInvitesResponse

List Team Invites

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

Example

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$teamApi = new Dropbox\Sign\Api\TeamApi($config);

$emailAddress = "user@dropboxsign.com";

try {
    $result = $teamApi->teamInvites($emailAddress);
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

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

Return type

\Dropbox\Sign\Model\TeamInvitesResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`teamMembers()`

teamMembers($team_id, $page, $page_size): \Dropbox\Sign\Model\TeamMembersResponse

List Team Members

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

Example

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$teamApi = new Dropbox\Sign\Api\TeamApi($config);

$teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c";

try {
    $result = $teamApi->teamMembers($teamId);
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

Name	Type	Description	Notes
team_id	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]
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

\Dropbox\Sign\Model\TeamMembersResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`teamRemoveMember()`

teamRemoveMember($team_remove_member_request): \Dropbox\Sign\Model\TeamGetResponse

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

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$teamApi = new Dropbox\Sign\Api\TeamApi($config);

$data = new Dropbox\Sign\Model\TeamRemoveMemberRequest();
$data->setEmailAddress("teammate@dropboxsign.com")
    ->setNewOwnerEmailAddress("new_teammate@dropboxsign.com");

try {
    $result = $teamApi->teamRemoveMember($data);
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

Name	Type	Description	Notes
team_remove_member_request	\Dropbox\Sign\Model\TeamRemoveMemberRequest

Return type

\Dropbox\Sign\Model\TeamGetResponse

Authorization

api_key, oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`teamSubTeams()`

teamSubTeams($team_id, $page, $page_size): \Dropbox\Sign\Model\TeamSubTeamsResponse

List Sub Teams

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

Example

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$teamApi = new Dropbox\Sign\Api\TeamApi($config);

$teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c";

try {
    $result = $teamApi->teamSubTeams($teamId);
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

Name	Type	Description	Notes
team_id	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]
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

\Dropbox\Sign\Model\TeamSubTeamsResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`teamUpdate()`

teamUpdate($team_update_request): \Dropbox\Sign\Model\TeamGetResponse

Update Team

Updates the name of your Team.

Example

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$teamApi = new Dropbox\Sign\Api\TeamApi($config);

$data = new Dropbox\Sign\Model\TeamUpdateRequest();
$data->setName("New Team Name");

try {
    $result = $teamApi->teamUpdate($data);
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

Name	Type	Description	Notes
team_update_request	\Dropbox\Sign\Model\TeamUpdateRequest

Return type

\Dropbox\Sign\Model\TeamGetResponse

Authorization

api_key, oauth2

HTTP request headers

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

[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

teamAddMember()

Example

Parameters

Return type

Authorization

HTTP request headers

teamCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

teamDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

teamGet()

Example

Parameters

Return type

Authorization

HTTP request headers

teamInfo()

Example

Parameters

Return type

Authorization

HTTP request headers

teamInvites()

Example

Parameters

Return type

Authorization

HTTP request headers

teamMembers()

Example

Parameters

Return type

Authorization

HTTP request headers

teamRemoveMember()

Example

Parameters

Return type

Authorization

HTTP request headers

teamSubTeams()

Example

Parameters

Return type

Authorization

HTTP request headers

teamUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

`teamAddMember()`

`teamCreate()`

`teamDelete()`

`teamGet()`

`teamInfo()`

`teamInvites()`

`teamMembers()`

`teamRemoveMember()`

`teamSubTeams()`

`teamUpdate()`