TurboDocx icon

TurboDocx

Interact with TurboDocx for document generation, e-signatures (TurboSign), quotes (TurboQuote), partner management, and webhooks

TurboPartner: API Key → Create

AI-generated

Summary

Creates a new Partner API key with a specified name and scope list.

Inputs

  • name (required) — Name for the new partner API key.
  • scopes (required) — JSON array of partner scopes to grant the key. Valid values include org:create, org:read, org:update, org:delete, entitlements:update, org-users:create, org-users:read, org-users:update, org-users:delete, partner-users:create, partner-users:read, partner-users:update, partner-users:delete, org-apikeys:create, org-apikeys:read, org-apikeys:update, org-apikeys:delete, partner-apikeys:create, partner-apikeys:read, partner-apikeys:update, partner-apikeys:delete, and audit:read.
  • additionalFields — A collection of additional fields. Currently supports 'description' as a string for the API key.

Output shape

an item containing the created partner API key object

The returned item includes the new key's details, typically including the key identifier or secret depending on the API response.

Examples

Example 1: Create a partner API key with read-only access to organizations and users.

Name: 'Read-Only Partner Key', Scopes: ['org:read', 'org-users:read']

Example 2: Create a partner API key with full organization management capabilities.

Name: 'Full Org Admin', Scopes: ['org:create', 'org:read', 'org:update', 'org:delete']

Links

Discussion