Skip to content
Proud to collaborate with Microsoft for Startups

subscription.key_revoke ​

Revoke an integration key issued under the actor-seat pricing model

Revoke an integration key and decrement the seat counter.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-subscription
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
integration_key_uuiduuidYes—Integration key UUID to revoke
revoked_reasonstringNo—Reason for revocation (default: user_revoked)

Output Schema ​

FieldTypeRequiredDefaultDescription
integration_key_uuiduuidNo——
subscription_uuiduuidNo——
revoked_atstringNo——
revoked_reasonstringNo——
already_revokedbooleanNo——
failed_atstringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
pendingfailfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "subscription.key_revoke",
  "initial_data": {
    "integration_key_uuid": "value"
  }
}