Function deleteWorkflowTransitionRuleConfigurations

deleteWorkflowTransitionRuleConfigurations(
    client: Client,
    parameters: {
        workflows: {
            workflowId: { draft?: boolean; name: string; [key: string]: unknown };
            workflowRuleIds: string[];
            [key: string]: unknown;
        }[];
    },
    options?: RequestOptions,
): Promise<
    {
        updateResults: {
            ruleUpdateErrors: Record<string, any>;
            updateErrors: string[];
            workflowId: { draft?: boolean; name: string; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Deletes workflow transition rules from one or more workflows. These rule types are supported:
Only rules created by the calling Connect app can be deleted.

Note: The draft parameter in the request body WorkflowId is deprecated and will be removed from this API on November 2, 2026.

Permissions required: Only Connect apps can use this operation.
Parameters
- client: Client
- parameters: {
      workflows: {
          workflowId: { draft?: boolean; name: string; [key: string]: unknown };
          workflowRuleIds: string[];
          [key: string]: unknown;
      }[];
  }
  - workflows: {
        workflowId: { draft?: boolean; name: string; [key: string]: unknown };
        workflowRuleIds: string[];
        [key: string]: unknown;
    }[]
    
    The list of workflows with transition rules to delete.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        updateResults: {
            ruleUpdateErrors: Record<string, any>;
            updateErrors: string[];
            workflowId: { draft?: boolean; name: string; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
- Defined in src/cloud/api/workflowTransitionRules.ts:115

Function deleteWorkflowTransitionRuleConfigurations

Parameters

workflows: { workflowId: { draft?: boolean; name: string; [key: string]: unknown }; workflowRuleIds: string[]; [key: string]: unknown;}[]

Returns Promise< { updateResults: { ruleUpdateErrors: Record<string, any>; updateErrors: string[]; workflowId: { draft?: boolean; name: string; [key: string]: unknown }; [key: string]: unknown; }[]; [key: string]: unknown; },>

Settings

workflows: {
workflowId: { draft?: boolean; name: string; [key: string]: unknown };
workflowRuleIds: string[];
[key: string]: unknown;
}[]

Returns Promise<
{
updateResults: {
ruleUpdateErrors: Record<string, any>;
updateErrors: string[];
workflowId: { draft?: boolean; name: string; [key: string]: unknown };
[key: string]: unknown;
}[];
[key: string]: unknown;
},
>