TurboDocx icon

TurboDocx

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

TurboPartner: API Key → Update

AI-generated

Summary

Modifies an existing TurboPartner API key by updating its description, name, or scopes.

Inputs

  • apiKeyId (required) — UUID of the partner API key to update.
  • description — Updated description for the API key.
  • name — Updated name for the API key.
  • scopes — JSON array of partner scopes. Replaces the existing scopes. 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, audit:read.

Output shape

No data is returned by the operation; it confirms the update was successful.

The operation returns an empty response body on success.

Examples

Example 1: Update API key description

Select 'Update' operation, provide the API Key ID, and enter a new description in the 'Description' field.

Example 2: Replace API key scopes

Select 'Update' operation, provide the API Key ID, and input a JSON array of new scopes (e.g., ["org:read", "org:update"]) in the 'Scopes' field.

Links

Discussion