Update API App
Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string.
Your API key can be used to make calls to the Dropbox Sign API. See Authentication for more information.
ā
Supported by Try it console (calls sent in test_mode only).
In: header
Path Parameters
The client id of the API App to update.
The URL at which the API App should receive event callbacks.
An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)
The domain names the ApiApp will be associated with.
items <= 10The name you want to assign to the ApiApp.
OAuth related parameters.
Additional options supported by API App.
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.
Response Body
application/json
application/json
curl -X PUT "https://example.com/api_app/0dd3b823a682527788c4e40cb7b6f7e9" \ -H "Content-Type: application/json" \ -d '{ "name": "New Name", "callback_url": "https://example.com/dropboxsign", "custom_logo_file": "CustomLogoFile.png", "domains": [ "example.com" ], "oauth": { "callback_url": "https://example.com/oauth", "scopes": [ "basic_account_info", "request_signature" ] }, "white_labeling_options": { "primary_button_color": "#00b3e6", "primary_button_text_color": "#ffffff" } }'{ "api_app": { "callback_url": "https://example.com/dropboxsign", "client_id": "0dd3b823a682527788c4e40cb7b6f7e9", "created_at": 1436232339, "domains": [ "example.com" ], "is_approved": false, "name": "New Name", "oauth": { "callback_url": "https://example.com/oauth", "scopes": [ "basic_account_info", "request_signature" ], "secret": "98891a1b59f312d04cd88e4e0c498d75" }, "owner_account": { "account_id": "dc5deeb9e10b044c591ef2475aafad1d1d3bd888", "email_address": "john@example.com" }, "white_labeling_options": { "primary_button_color": "#00b3e6", "primary_button_text_color": "#ffffff" } }}