Create API Application

Creates an API Application in the workspace, owned by the member the API key or OAuth token belongs to. Requires the owner, admin or manager role, as in Settings > API.

Body Params
string
required
length ≤ 255

Name of the API Application, at most 255 characters. When the application has an OAuth client, renaming it renames the client too, as shown on the consent screen.

callback_urls
array of strings
length ≤ 5

Callback URLs that receive this API Application's webhook events. Document events are sent for the documents created with this API Application, and the workspace's own webhooks are then skipped for those documents. Template events are sent to every callback URL in the workspace, whichever API Application created the template. Public addresses only, no duplicates, at most 5. On update the list replaces the stored one: a URL that stays keeps its delivery history and whether it is enabled, and [] removes every URL. A callback URL disabled after repeated delivery failures is not re-enabled by sending it again: enable it from the email SignWell sends or in Settings > API. A callback URL added while the API Application is deactivated stays off until it is reactivated.

callback_urls
preferences
object

Branding for the documents created with this API Application: the logo and colors in the signature request and completed emails and on the signing page. Applies only while the API Application is active, and on Free plans the logo is left out of emails. Changing any style from its SignWell default also removes the SignWell branding from those emails. On create, a style you omit takes the SignWell default; on update, only the properties you send change, and null resets a style to its SignWell default or removes the logo.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json