Create API App

Creates a new API App.

Manage accounts, signature requests, templates, teams, bulk sends, file downloads, fax, and event callbacks through the complete Dropbox Sign v3 API; the Hub provides documentation and a local SDK/CLI only.

Request

operationId: apiAppCreate
Server: https://api.hellosign.com/v3
Authentication: api_key, oauth2

Request parameters

No URL, query, or header parameters.

Request body

ApiAppCreateRequestrequired

Content-Type: application/json, multipart/form-data

Properties: callback_urlcustom_logo_filedomainsnameoauthoptionswhite_labeling_options

{
  "callback_url": "https://example.com/resource",
  "domains": [
    {}
  ],
  "name": "Example Name",
  "oauth": {
    "callback_url": "https://example.com/resource",
    "scopes": [
      "request_signature"
    ]
  },
  "options": {
    "can_insert_everywhere": false
  },
  "white_labeling_options": {
    "header_background_color": "#1a1a1a",
    "legal_version": "terms1",
    "link_color": "#0061FE",
    "page_background_color": "#f7f8f9",
    "primary_button_color": "#0061FE",
    "primary_button_color_hover": "#0061FE",
    "primary_button_text_color": "#ffffff",
    "primary_button_text_color_hover": "#ffffff"
  }
}

Responses

`201`

ApiAppGetResponseapplication/json

successful operation

Properties: api_appwarnings

`4XX`

ErrorResponseapplication/json

failed_operation

Properties: error

{
  "api_app": {
    "callback_url": "https://example.com/resource",
    "client_id": "example-client-id",
    "created_at": 0,
    "domains": [
      {}
    ],
    "name": "Example Name",
    "is_approved": false,
    "oauth": {
      "callback_url": "https://example.com/resource",
      "scopes": [
        {}
      ],
      "charges_users": false
    },
    "options": {
      "can_insert_everywhere": false
    }
  },
  "warnings": [
    {
      "warning_name": "Example Name"
    }
  ]
}