/dropbox-sign-admin | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
dropbox_sign_admin_account_create | Create Account |
dropbox_sign_admin_account_get | Get Account |
dropbox_sign_admin_account_update | Update Account |
dropbox_sign_admin_account_verify | Verify Account |
dropbox_sign_admin_api_app_create | Create API App |
dropbox_sign_admin_api_app_delete | Delete API App |
dropbox_sign_admin_api_app_get | Get API App |
dropbox_sign_admin_api_app_list | List API Apps |
dropbox_sign_admin_api_app_update | Update API App |
dropbox_sign_admin_report_create | Create Report |
dropbox_sign_admin_team_add_member | Add User to Team |
dropbox_sign_admin_team_create | Create Team |
dropbox_sign_admin_team_delete | Delete Team |
dropbox_sign_admin_team_get | Get Team |
dropbox_sign_admin_team_info | Get Team Info |
dropbox_sign_admin_team_invites | List Team Invites |
dropbox_sign_admin_team_members | List Team Members |
dropbox_sign_admin_team_remove_member | Remove User from Team |
dropbox_sign_admin_team_sub_teams | List Sub Teams |
dropbox_sign_admin_team_update | Update Team |
dropbox_sign_admin_account_create
Create Account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
client_id | string | No | — | Used when creating a new account with OAuth authorization. See OAuth 2.0 Authorization |
client_secret | string | No | — | Used when creating a new account with OAuth authorization. See OAuth 2.0 Authorization |
email_address | string | Yes | — | The email address which will be associated with the new Account. |
locale | string | No | — | The locale used in this Account. Check out the list of supported locales to learn more about the possible values. |
dropbox_sign_admin_account_get
Get Account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | No | — | account_id or email_address is required. If both are provided, the account id prevails. The ID of the Account. |
email_address | string | No | — | account_id or email_address is required, If both are provided, the account id prevails. The email address of the Account. |
dropbox_sign_admin_account_update
Update Account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | No | — | The ID of the Account |
callback_url | string | No | — | The URL that Dropbox Sign should POST events to. |
locale | string | No | — | The locale used in this Account. Check out the list of supported locales to learn more about the possible values. |
dropbox_sign_admin_account_verify
Verify Account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_address | string | Yes | — | Email address to run the verification for. |
dropbox_sign_admin_api_app_create
Create API App Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
callback_url | string | No | — | The URL at which the ApiApp should receive event callbacks. |
custom_logo_file | string | No | — | An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) |
domains | string[] | Yes | — | The domain names the ApiApp will be associated with. |
name | string | Yes | — | The name you want to assign to the ApiApp. |
oauth | object | No | — | OAuth related parameters. |
options | object | No | — | Additional options supported by API App. |
white_labeling_options | object | No | — | An array of elements and values serialized to a string, to be used to customize the app’s signer page. (Only applies to some API plans) Take a look at our white labeling guide to learn more. |
dropbox_sign_admin_api_app_delete
Delete API App Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
client_id | string | Yes | — | The client id of the API App to delete. |
dropbox_sign_admin_api_app_get
Get API App Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
client_id | string | Yes | — | The client id of the API App to retrieve. |
dropbox_sign_admin_api_app_list
List API Apps Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Which page number of the API App List to return. Defaults to 1. |
page_size | integer | No | — | Number of objects to be returned per page. Must be between 1 and 100. Default is 20. |
dropbox_sign_admin_api_app_update
Update API App Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
client_id | string | Yes | — | The client id of the API App to update. |
callback_url | string | No | — | The URL at which the API App should receive event callbacks. |
custom_logo_file | string | No | — | An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) |
domains | string[] | No | — | The domain names the ApiApp will be associated with. |
name | string | No | — | The name you want to assign to the ApiApp. |
oauth | object | No | — | OAuth related parameters. |
options | object | No | — | Additional options supported by API App. |
white_labeling_options | object | No | — | An array of elements and values serialized to a string, to be used to customize the app’s signer page. (Only applies to some API plans) Take a look at our white labeling guide to learn more. |
dropbox_sign_admin_report_create
Create Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
end_date | string | Yes | — | The (inclusive) end date for the report data in MM/DD/YYYY format. |
report_type | string[] | Yes | — | The type(s) of the report you are requesting. Allowed values are user_activity and document_status. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status). |
start_date | string | Yes | — | The (inclusive) start date for the report data in MM/DD/YYYY format. |
dropbox_sign_admin_team_add_member
Add User to Team Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | string | No | — | The id of the team. |
account_id | string | No | — | account_id or email_address is required. If both are provided, the account id prevails. Account id of the user to invite to your Team. |
email_address | string | No | — | account_id or email_address is required, If both are provided, the account id prevails. Email address of the user to invite to your Team. |
role | string | No | — | A role member will take in a new Team. NOTE: This parameter is used only if team_id is provided. |
dropbox_sign_admin_team_create
Create Team Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | No | — | The name of your Team. |
dropbox_sign_admin_team_delete
Delete Teamdropbox_sign_admin_team_get
Get Teamdropbox_sign_admin_team_info
Get Team Info Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | string | No | — | The id of the team. |
dropbox_sign_admin_team_invites
List Team Invites Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_address | string | No | — | The email address for which to display the team invites. |
dropbox_sign_admin_team_members
List Team Members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | string | Yes | — | The id of the team that a member list is being requested from. |
page | integer | No | — | Which page number of the team member list to return. Defaults to 1. |
page_size | integer | No | — | Number of objects to be returned per page. Must be between 1 and 100. Default is 20. |
dropbox_sign_admin_team_remove_member
Remove User from Team Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | No | — | account_id or email_address is required. If both are provided, the account id prevails. Account id to remove from your Team. |
email_address | string | No | — | account_id or email_address is required. If both are provided, the account id prevails. Email address of the Account to remove from your Team. |
new_owner_email_address | string | No | — | The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account. NOTE: Only available for Enterprise plans. |
new_role | string | No | — | A new role member will take in a new Team. NOTE: This parameter is used only if new_team_id is provided. |
new_team_id | string | No | — | Id of the new Team. |
dropbox_sign_admin_team_sub_teams
List Sub Teams Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | string | Yes | — | The id of the parent Team. |
page | integer | No | — | Which page number of the SubTeam List to return. Defaults to 1. |
page_size | integer | No | — | Number of objects to be returned per page. Must be between 1 and 100. Default is 20. |
dropbox_sign_admin_team_update
Update Team Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | No | — | The name of your Team. |

