Update API App

put/api_app/{client_id}

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.

Securityapi_key or oauth2
Request
path Parameters
client_id
required
string

The client id of the API App to update.

Example: 0dd3b823a682527788c4e40cb7b6f7e9
Request Body schema:
callback_url
string

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

custom_logo_file
string <binary>

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

domains
Array of strings <= 2 items

The domain names the ApiApp will be associated with.

name
string

The name you want to assign to the ApiApp.

object (SubOAuth)

OAuth related parameters.

object (SubOptions)

Additional options supported by API App.

object (SubWhiteLabelingOptions)

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.

Responses
200

successful operation

4XX

failed_operation

Request samples
{
  • "name": "New Name",
  • "callback_url": "http://example.com/hellosign",
  • "white_labeling_options": {
    }
}
Response samples
application/json
{
  • "api_app": {
    }
}