Create API App

post/api_app

Creates a new API App.

Securityapi_key or oauth2

Request

Request Body schema:
application/json

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": ["example.com"
],
"oauth": {"callback_url": "https://example.com/oauth",
"scopes": ["basic_account_info",
"request_signature"
]
},
"white_labeling_options": {"primary_button_color": "#00b3e6",
"primary_button_text_color": "#ffffff"
}
}

Response samples

application/json

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

Create API App

Request Body schema: application/jsonmultipart/form-dataapplication/json

Request Body schema:
application/json