Dropbox Sign Developer Documentation

import json
from datetime import date, datetime
from pprint import pprint
from dropbox_sign import ApiClient, ApiException, Configuration, api, models
configuration = Configuration(
    username="YOUR_API_KEY",
    # access_token="YOUR_ACCESS_TOKEN",
)
with ApiClient(configuration) as api_client:
    oauth = models.SubOAuth(
        callback_url="https://example.com/oauth",
        scopes=[
            "basic_account_info",
            "request_signature",
        ],
    )
    white_labeling_options = models.SubWhiteLabelingOptions(
        primary_button_color="#00b3e6",
        primary_button_text_color="#ffffff",
    )
    api_app_update_request = models.ApiAppUpdateRequest(
        callback_url="https://example.com/dropboxsign",
        name="New Name",
        domains=[
            "example.com",
        ],
        custom_logo_file=open("CustomLogoFile.png", "rb").read(),
        oauth=oauth,
        white_labeling_options=white_labeling_options,
    )
    try:
        response = api.ApiAppApi(api_client).api_app_update(
            client_id="0dd3b823a682527788c4e40cb7b6f7e9",
            api_app_update_request=api_app_update_request,
        )
        pprint(response)
    except ApiException as e:
        print("Exception when calling ApiAppApi#api_app_update: %s\n" % e)

{
  "api_app": {
    "callback_url": "https://example.com/dropboxsign",
    "client_id": "0dd3b823a682527788c4e40cb7b6f7e9",
    "created_at": 1436232339,
    "domains": [
      "example.com"
    ],
    "name": "New Name",
    "is_approved": false,
    "oauth": {
      "callback_url": "https://example.com/oauth",
      "secret": "98891a1b59f312d04cd88e4e0c498d75",
      "scopes": [
        "basic_account_info",
        "request_signature"
      ]
    },
    "owner_account": {
      "account_id": "dc5deeb9e10b044c591ef2475aafad1d1d3bd888",
      "email_address": "john@example.com"
    },
    "white_labeling_options": {
      "primary_button_color": "#00b3e6",
      "primary_button_text_color": "#ffffff"
    }
  }
}

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.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

client_idstringRequired

The client id of the API App to update.

Request

This endpoint expects an object.

callback_urlstringOptional

The URL at which the API App should receive event callbacks.

custom_logo_filestringOptionalformat: "binary"

An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)

domainslist of stringsOptional

The domain names the ApiApp will be associated with.

namestringOptional

The name you want to assign to the ApiApp.

oauthobjectOptional

OAuth related parameters.

optionsobjectOptional

Additional options supported by API App.

white_labeling_optionsobjectOptional

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.

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](https://developers.hellosign.com/api/reference/premium-branding/) to learn more.

Response headers

X-RateLimit-Limitinteger

The maximum number of requests per hour that you can make.

X-RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window.

X-Ratelimit-Resetinteger

The Unix time at which the rate limit will reset to its maximum.

Response

successful operation

api_appobject

Contains information about an API App.

warningslist of objects or null

A list of warnings.

Update API App

Authentication

Path parameters

Request

Response headers

Response

Errors