Skip to main content
Server path: /dropbox-sign-admin | Type: Application | PCID required: Yes

Tools


dropbox_sign_admin_account_create

Create Account Parameters:
ParameterTypeRequiredDefaultDescription
client_idstringNoUsed when creating a new account with OAuth authorization. See OAuth 2.0 Authorization
client_secretstringNoUsed when creating a new account with OAuth authorization. See OAuth 2.0 Authorization
email_addressstringYesThe email address which will be associated with the new Account.
localestringNoThe 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:
ParameterTypeRequiredDefaultDescription
account_idstringNoaccount_id or email_address is required. If both are provided, the account id prevails. The ID of the Account.
email_addressstringNoaccount_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:
ParameterTypeRequiredDefaultDescription
account_idstringNoThe ID of the Account
callback_urlstringNoThe URL that Dropbox Sign should POST events to.
localestringNoThe 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:
ParameterTypeRequiredDefaultDescription
email_addressstringYesEmail address to run the verification for.

dropbox_sign_admin_api_app_create

Create API App Parameters:
ParameterTypeRequiredDefaultDescription
callback_urlstringNoThe URL at which the ApiApp should receive event callbacks.
custom_logo_filestringNoAn image file to use as a custom logo in embedded contexts. (Only applies to some API plans)
domainsstring[]YesThe domain names the ApiApp will be associated with.
namestringYesThe name you want to assign to the ApiApp.
oauthobjectNoOAuth related parameters.
optionsobjectNoAdditional options supported by API App.
white_labeling_optionsobjectNoAn 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:
ParameterTypeRequiredDefaultDescription
client_idstringYesThe client id of the API App to delete.

dropbox_sign_admin_api_app_get

Get API App Parameters:
ParameterTypeRequiredDefaultDescription
client_idstringYesThe client id of the API App to retrieve.

dropbox_sign_admin_api_app_list

List API Apps Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoWhich page number of the API App List to return. Defaults to 1.
page_sizeintegerNoNumber 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:
ParameterTypeRequiredDefaultDescription
client_idstringYesThe client id of the API App to update.
callback_urlstringNoThe URL at which the API App should receive event callbacks.
custom_logo_filestringNoAn image file to use as a custom logo in embedded contexts. (Only applies to some API plans)
domainsstring[]NoThe domain names the ApiApp will be associated with.
namestringNoThe name you want to assign to the ApiApp.
oauthobjectNoOAuth related parameters.
optionsobjectNoAdditional options supported by API App.
white_labeling_optionsobjectNoAn 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:
ParameterTypeRequiredDefaultDescription
end_datestringYesThe (inclusive) end date for the report data in MM/DD/YYYY format.
report_typestring[]YesThe 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_datestringYesThe (inclusive) start date for the report data in MM/DD/YYYY format.

dropbox_sign_admin_team_add_member

Add User to Team Parameters:
ParameterTypeRequiredDefaultDescription
team_idstringNoThe id of the team.
account_idstringNoaccount_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_addressstringNoaccount_id or email_address is required, If both are provided, the account id prevails. Email address of the user to invite to your Team.
rolestringNoA 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:
ParameterTypeRequiredDefaultDescription
namestringNoThe name of your Team.

dropbox_sign_admin_team_delete

Delete Team

dropbox_sign_admin_team_get

Get Team

dropbox_sign_admin_team_info

Get Team Info Parameters:
ParameterTypeRequiredDefaultDescription
team_idstringNoThe id of the team.

dropbox_sign_admin_team_invites

List Team Invites Parameters:
ParameterTypeRequiredDefaultDescription
email_addressstringNoThe email address for which to display the team invites.

dropbox_sign_admin_team_members

List Team Members Parameters:
ParameterTypeRequiredDefaultDescription
team_idstringYesThe id of the team that a member list is being requested from.
pageintegerNoWhich page number of the team member list to return. Defaults to 1.
page_sizeintegerNoNumber 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:
ParameterTypeRequiredDefaultDescription
account_idstringNoaccount_id or email_address is required. If both are provided, the account id prevails. Account id to remove from your Team.
email_addressstringNoaccount_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_addressstringNoThe 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_rolestringNoA new role member will take in a new Team. NOTE: This parameter is used only if new_team_id is provided.
new_team_idstringNoId of the new Team.

dropbox_sign_admin_team_sub_teams

List Sub Teams Parameters:
ParameterTypeRequiredDefaultDescription
team_idstringYesThe id of the parent Team.
pageintegerNoWhich page number of the SubTeam List to return. Defaults to 1.
page_sizeintegerNoNumber of objects to be returned per page. Must be between 1 and 100. Default is 20.

dropbox_sign_admin_team_update

Update Team Parameters:
ParameterTypeRequiredDefaultDescription
namestringNoThe name of your Team.