AccountApi.md

Dropbox\Sign\AccountApi

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

Method	HTTP request	Description
accountCreate()	POST /account/create	Create Account
accountGet()	GET /account	Get Account
accountUpdate()	PUT /account	Update Account
accountVerify()	POST /account/verify	Verify Account

accountCreate()

accountCreate($account_create_request): \Dropbox\Sign\Model\AccountCreateResponse

Create Account

Creates a new Dropbox Sign Account that is associated with the specified email_address.

Example

<?php

namespace Dropbox\SignSandbox;

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

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$account_create_request = (new Dropbox\Sign\Model\AccountCreateRequest())
    ->setEmailAddress("newuser@dropboxsign.com");

try {
    $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountCreate(
        account_create_request: $account_create_request,
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling AccountApi#accountCreate: {$e->getMessage()}";
}

Parameters

Name	Type	Description	Notes
account_create_request	\Dropbox\Sign\Model\AccountCreateRequest

Return type

\Dropbox\Sign\Model\AccountCreateResponse

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]

accountGet()

accountGet($account_id, $email_address): \Dropbox\Sign\Model\AccountGetResponse

Get Account

Returns the properties and settings of your Account.

Example

<?php

namespace Dropbox\SignSandbox;

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

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

try {
    $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountGet();

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling AccountApi#accountGet: {$e->getMessage()}";
}

Parameters

Name	Type	Description	Notes
account_id	string	account_id or email_address is required. If both are provided, the account id prevails. The ID of the Account.	[optional]
email_address	string	account_id or email_address is required, If both are provided, the account id prevails. The email address of the Account.	[optional]

Return type

\Dropbox\Sign\Model\AccountGetResponse

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]

accountUpdate()

accountUpdate($account_update_request): \Dropbox\Sign\Model\AccountGetResponse

Update Account

Updates the properties and settings of your Account. Currently only allows for updates to the Callback URL and locale.

Example

<?php

namespace Dropbox\SignSandbox;

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

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$account_update_request = (new Dropbox\Sign\Model\AccountUpdateRequest())
    ->setCallbackUrl("https://www.example.com/callback")
    ->setLocale("en-US");

try {
    $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountUpdate(
        account_update_request: $account_update_request,
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling AccountApi#accountUpdate: {$e->getMessage()}";
}

Parameters

Name	Type	Description	Notes
account_update_request	\Dropbox\Sign\Model\AccountUpdateRequest

Return type

\Dropbox\Sign\Model\AccountGetResponse

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]

accountVerify()

accountVerify($account_verify_request): \Dropbox\Sign\Model\AccountVerifyResponse

Verify Account

Verifies whether an Dropbox Sign Account exists for the given email address.

Example

<?php

namespace Dropbox\SignSandbox;

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

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$account_verify_request = (new Dropbox\Sign\Model\AccountVerifyRequest())
    ->setEmailAddress("some_user@dropboxsign.com");

try {
    $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountVerify(
        account_verify_request: $account_verify_request,
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling AccountApi#accountVerify: {$e->getMessage()}";
}

Parameters

Name	Type	Description	Notes
account_verify_request	\Dropbox\Sign\Model\AccountVerifyRequest

Return type

\Dropbox\Sign\Model\AccountVerifyResponse

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]