Create a new API Key

Creates a new API key for partner integration. The complete key is returned only once!

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

API Key creation parameters

Request to create a new API Key

string | null
required

Descriptive name for the API key

scopes
array of strings | null
required

List of permission scopes for the key.
Available scopes: read:documents, write:documents, read:envelopes, write:envelopes,
read:signatures, verify:signatures, read:templates, write:templates,
read:workflows, write:workflows, read:playbooks, write:playbooks,
read:webhook_events, manage:webhooks, read:webhook_logs,
read:audit_log, send:reminders, full_access

scopes*
int32 | null

Optional number of days until the key expires. Null means no expiration.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

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