---
title: "Update API App"
method: PUT
path: "/api_app/{client_id}"
tags: ["Api App"]
---

# 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.

## Path parameters

- `client_id` string, required

## Request body

- ApiAppUpdateRequest
  - `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` string[] — The domain names the ApiApp will be associated with.
  - `name` string — The name you want to assign to the ApiApp.
  - `oauth` SubOAuth — OAuth related parameters.
    - `callback_url` string — The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided)
    - `scopes` string[] — A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided).
  - `options` SubOptions — Additional options supported by API App.
    - `can_insert_everywhere` boolean — Determines if signers can use "Insert Everywhere" when signing a document.
  - `white_labeling_options` 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](https://developers.hellosign.com/api/reference/premium-branding/) to learn more.
    - `header_background_color` string
    - `legal_version` 'terms1' | 'terms2'
    - `link_color` string
    - `page_background_color` string
    - `primary_button_color` string
    - `primary_button_color_hover` string
    - `primary_button_text_color` string
    - `primary_button_text_color_hover` string
    - `secondary_button_color` string
    - `secondary_button_color_hover` string
    - `secondary_button_text_color` string
    - `secondary_button_text_color_hover` string
    - `text_color1` string
    - `text_color2` string
    - `reset_to_default` boolean — Resets white labeling options to defaults. Only useful when updating an API App.

## Response `200`

successful operation

- ApiAppGetResponse
  - `api_app` ApiAppResponse, required — Contains information about an API App.
    - `callback_url` string, nullable — The app's callback URL (for events)
    - `client_id` string — The app's client id
    - `created_at` integer — The time that the app was created
    - `domains` string[] — The domain name(s) associated with the app
    - `name` string — The name of the app
    - `is_approved` boolean — Boolean to indicate if the app has been approved
    - `oauth` ApiAppResponseOAuth, nullable — An object describing the app's OAuth properties, or null if OAuth is not configured for the app.
      - `callback_url` string — The app's OAuth callback URL.
      - `secret` string, nullable — The app's OAuth secret, or null if the app does not belong to user.
      - `scopes` string[] — Array of OAuth scopes used by the app.
      - `charges_users` boolean — Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests.
    - `options` ApiAppResponseOptions, nullable — An object with options that override account settings.
      - `can_insert_everywhere` boolean — Boolean denoting if signers can "Insert Everywhere" in one click while signing a document
    - `owner_account` ApiAppResponseOwnerAccount — An object describing the app's owner
      - `account_id` string — The owner account's ID
      - `email_address` string — The owner account's email address
    - `white_labeling_options` ApiAppResponseWhiteLabelingOptions, nullable — An object with options to customize the app's signer page
      - `header_background_color` string
      - `legal_version` string
      - `link_color` string
      - `page_background_color` string
      - `primary_button_color` string
      - `primary_button_color_hover` string
      - `primary_button_text_color` string
      - `primary_button_text_color_hover` string
      - `secondary_button_color` string
      - `secondary_button_color_hover` string
      - `secondary_button_text_color` string
      - `secondary_button_text_color_hover` string
      - `text_color1` string
      - `text_color2` string
  - `warnings` WarningResponse[] — A list of warnings.
    - `warning_msg` string, required — Warning message
    - `warning_name` string, required — Warning name

## Other responses

- `4XX` — failed_operation

---

[API](https://skmtc.net/hellosign/apis/dropbox-sign-api.md) · [All operations](https://skmtc.net/hellosign/apis/dropbox-sign-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hellosign/dropbox-sign-api/revisions/7535b8f1a188/schema)