Create API App

post/api_app

Creates a new API App.

Securityapi_key or oauth2
Request
Request Body schema:
required
name
required
string

The name you want to assign to the ApiApp.

domains
required
Array of strings [ 1 .. 2 ] items

The domain names the ApiApp will be associated with.

callback_url
string

The URL at which the ApiApp 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)

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
201

successful operation

4XX

failed_operation

Request samples
{
  • "name": "My Production App",
  • "domains": [
    ],
  • "oauth": {},
  • "white_labeling_options": {
    }
}
Response samples
application/json
{
  • "api_app": {
    }
}