Delete Provisioning Templates

Tool Name: airdroid_business_provisioning_template_delete

Risk Level: 🔴 High Risk

Execution Mode: ⚡ Synchronous

Category: Provisioning Templates

Quick Start (Copy & Use)

Summary: ⚠️ DESTRUCTIVE OPERATION — Bulk delete provisioning templates by their IDs (max 50 per request). Deleted templates are permanently removed and must be recreated manually if needed again. Supports partial success: each ID is validated and processed independently.

Prerequisites: ProvisioningIds (array of template IDs) — obtain and verify via List Provisioning Templates (check is_default). A valid OAuth2 AccessToken configured in the GI node Credential.

Confirmation behavior: By default this high-risk tool opens a manual confirmation form before execution (RequireConfirmation = true). The form requires a non-empty Reason for audit trail. StatusCode = -2 means execution rejected; StatusCode = -3 means the confirmation timed out (24 hours) before the tool ran. Set RequireConfirmation = false only when explicit user approval has already been obtained.

Success Criteria: StatusCode == 200 and ErrorMessage == "" and FailedCount == 0. A non-empty ErrorMessage with StatusCode == 200 means partial or full per-item failure — inspect FailedIds.

What to Do Next: Verify removal via List Provisioning Templates; for FailedIds, follow Hint (e.g. remove default-template IDs, switch credential).

Minimal Request Example (recommended to copy directly):

{
  "ProvisioningIds": [17563, 17562],
  "RequireConfirmation": true
}

Minimal Response Example (all deleted):

{
  "SuccessIds": [17563, 17562],
  "FailedIds": [],
  "SucceededCount": 2,
  "FailedCount": 0,
  "Hint": "",
  "Retryable": false,
  "OriginalStatusCode": 200,
  "StatusCode": 200,
  "ErrorMessage": ""
}

Recipes (Common Recipes)

Recipe 1: Delete Obsolete Templates (With Confirmation)

When to use: Standard cleanup of deprecated templates. The confirmation form opens and collects the deletion Reason.

{
  "ProvisioningIds": [17563],
  "RequireConfirmation": true
}

Recipe 2: Delete After Explicit User Approval (Skip Confirmation)

When to use: The user has already explicitly approved the deletion in conversation and wants immediate execution. The audit reason is auto-set to "Confirmation skipped by RequireConfirmation=false.".

{
  "ProvisioningIds": [17562, 17561],
  "RequireConfirmation": false
}

Recipe 3: Bulk Cleanup With Pre-Flight Verification

When to use: Deleting many templates. First call List Provisioning Templates, exclude any entry with is_default == "Yes" (default templates cannot be deleted and will land in FailedIds), then delete in batches of at most 50 IDs.

{
  "ProvisioningIds": [17550, 17551, 17552, 17553, 17554],
  "RequireConfirmation": true
}

1. Overview

1.1 Description

Bulk delete device provisioning templates by their IDs. Supports partial success: each ID is validated and processed independently, so valid IDs are deleted even if others fail. The result reports SuccessIds / FailedIds with per-item failure reasons.

1.2 When to Use

• Permanently removing obsolete or incorrect provisioning templates from the account

Don't use when:

• You are unsure which templates to delete — call List Provisioning Templates first to verify ProvisioningIds and default status
• The template is still being used for active enrollment campaigns

1.3 Execution Mode and Response

This operation is synchronous with partial success. Before the API call, the workflow routes through a manual confirmation step (unless RequireConfirmation = false):

1. A confirmation form is created describing the side effects; it requires a Reason (audit trail)
2. The workflow waits up to 24 hours for the form to be processed
3. On approval, the delete request executes; on rejection → StatusCode = -2; on timeout → StatusCode = -3

Response: SuccessIds, FailedIds, SucceededCount, FailedCount, plus the standard envelope (StatusCode, ErrorMessage, Hint, Retryable, OriginalStatusCode).

1.4 Prerequisites

1.5 Prerequisite Tools

1.6 Differences from Similar Tools

2. Inputs

2.1 Parameter List

2.2 Parameter Details

`ProvisioningIds`

Array of provisioning template IDs to delete.

• Type: number-array
• Required: Yes (must be a non-empty array)
• Limits: Maximum 50 templates per request; every element must be a positive integer. Violations return StatusCode = -1
• Source: The provisioning_id field of items returned by List Provisioning Templates
• Default templates: Templates with is_default == "Yes" in the list output cannot be deleted; they will appear in FailedIds with a per-item error message
• How to fill in GI node:
  • Constant: Provide an array directly, e.g. [17563, 17562]
  • Upstream reference: Map an array of provisioning_id values collected from a List Provisioning Templates node output
• Example:

[17563, 17562]

`RequireConfirmation`

Whether to enter the manual confirmation flow before executing this high-risk action.

• Type: bool
• Default: true — preserves the confirmation step (recommended)
• true: A confirmation form opens ("Confirm Tool Use") explaining the side effects. It requires a non-empty Reason field for the audit trail. The workflow waits up to 24 hours.
• false: Skips the form and executes immediately; the audit reason is automatically set to "Confirmation skipped by RequireConfirmation=false.". Set false only when the caller has already obtained explicit user approval.

Confirmation form (`Reason`)

This tool does not accept an external Reason input parameter. The deletion reason is collected in the confirmation form (required, non-empty) or auto-filled when confirmation is skipped. An empty reason at execution time returns StatusCode = -1 with ErrorMessage = "Reason is required for audit trail. Provide a brief explanation for this deletion.".

2.3 Parameter Combination Logic

• ProvisioningIds is the only business input; RequireConfirmation only controls the approval flow
• More than 50 IDs → StatusCode = -1; split larger batches into multiple requests

3. Outputs

3.1 Response Example

Success response (all deleted): see the Quick Start minimal response example.

Partial success response:

{
  "SuccessIds": [17563],
  "FailedIds": [
    {
      "id": 17560,
      "ErrorMessage": "Default template cannot be deleted"
    }
  ],
  "SucceededCount": 1,
  "FailedCount": 1,
  "Hint": "Default templates cannot be deleted; remove default template IDs from ProvisioningIds and retry.",
  "Retryable": false,
  "OriginalStatusCode": 200,
  "StatusCode": 200,
  "ErrorMessage": "Partial success: 1 deleted, 1 failed. ID 17560: Default template cannot be deleted"
}

Execution rejected before run:

{
  "SuccessIds": [],
  "FailedIds": [],
  "SucceededCount": 0,
  "FailedCount": 0,
  "Hint": "Do not retry automatically. Ask the user to confirm again only if they still want to perform this action.",
  "Retryable": false,
  "OriginalStatusCode": -2,
  "StatusCode": -2,
  "ErrorMessage": "The user canceled tool execution before the tool could run."
}

Confirmation timed out before run:

{
  "SuccessIds": [],
  "FailedIds": [],
  "SucceededCount": 0,
  "FailedCount": 0,
  "Hint": "Ask the user whether they still want to proceed. If yes, re-invoke this tool to create a new confirmation request.",
  "Retryable": false,
  "OriginalStatusCode": -3,
  "StatusCode": -3,
  "ErrorMessage": "The confirmation timed out before the tool could run."
}

3.2 Field Descriptions

Judgment logic: an agent should treat the batch as fully successful only when SucceededCount == len(ProvisioningIds) and FailedCount == 0 (equivalently, ErrorMessage == "" with StatusCode == 200).

3.3 Status Code / Enum Value Mapping

4. Examples

4.1 Basic Example: Delete Two Templates

Request Parameters:

{
  "ProvisioningIds": [17563, 17562],
  "RequireConfirmation": true
}

Response (after confirmation form approval):

{
  "SuccessIds": [17563, 17562],
  "FailedIds": [],
  "SucceededCount": 2,
  "FailedCount": 0,
  "Hint": "",
  "Retryable": false,
  "OriginalStatusCode": 200,
  "StatusCode": 200,
  "ErrorMessage": ""
}

4.2 Advanced Example: Partial Success With a Not-Found ID

Request Parameters:

{
  "ProvisioningIds": [17563, 99999],
  "RequireConfirmation": true
}

Response:

{
  "SuccessIds": [17563],
  "FailedIds": [
    {
      "id": 99999,
      "ErrorMessage": "Provisioning template not found"
    }
  ],
  "SucceededCount": 1,
  "FailedCount": 1,
  "Hint": "One or more provisioning templates were not found; verify ProvisioningIds via 'List Provisioning Templates' and retry.",
  "Retryable": false,
  "OriginalStatusCode": 200,
  "StatusCode": 200,
  "ErrorMessage": "Partial success: 1 deleted, 1 failed. ID 99999: Provisioning template not found"
}

4.3 Error Example: Batch Too Large

Request Parameters (error — more than 50 IDs):

{
  "ProvisioningIds": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51],
  "RequireConfirmation": true
}

Response:

{
  "SuccessIds": [],
  "FailedIds": [],
  "SucceededCount": 0,
  "FailedCount": 0,
  "Hint": "Obtain provisioning_ids via 'List Provisioning Templates', then retry.",
  "Retryable": false,
  "OriginalStatusCode": 0,
  "StatusCode": -1,
  "ErrorMessage": "Maximum 50 provisioning templates per request. Split into multiple requests for larger batches."
}

5. Error Handling

5.1 AB Three-Layer Error Codes

5.2 Common Errors

5.3 Agent Self-Healing Decision Table

6. Best Practices

6.1 Performance Optimization

• Batch limit: Max 50 IDs per request; split larger cleanups into multiple calls
• Pre-filter: Exclude is_default == "Yes" and permission-restricted templates up front to avoid predictable per-item failures

6.2 Security Considerations

⚠️ High-Risk Operation Warning: This operation permanently deletes the selected provisioning templates. Deleted templates cannot be recovered and must be recreated manually if needed again.

Pre-Execution Checklist:

1. ☐ Verify every ID via List Provisioning Templates (correct templates, correct account)
2. ☐ Confirm no target has is_default == "Yes" (default templates cannot be deleted)
3. ☐ Confirm none of the templates are used by active enrollment campaigns
4. ☐ Record the template configurations (via Get a Provisioning Template) if they may need to be recreated
5. ☐ Obtain explicit user confirmation (or let the confirmation form collect it)
6. ☐ Understand the irreversibility — there is no undo

6.3 Idempotency

Idempotency: Not idempotent.

• First call: deletes the templates, returns them in SuccessIds
• Repeat call with the same IDs: the IDs no longer exist, so they are reported as per-item failures in FailedIds (not-found)

Note: Do not blindly retry after a timeout. If unsure whether the deletion succeeded, call List Provisioning Templates to check whether the IDs still exist, then retry only the remaining ones.

7. Related Tools

7.1 Prerequisite Tools

7.2 Follow-up Tools

7.3 Similar Tool Comparison

8. Tool Chains

8.1 Safe Template Cleanup Flow

Scenario: Remove obsolete templates with full verification.

Tool Chain:

List Provisioning Templates → Get a Provisioning Template (optional snapshot) → Delete Provisioning Templates → List Provisioning Templates (verify)

Steps:

1. Call List Provisioning Templates and select target templates; exclude is_default == "Yes"
2. (Optional) Call Get a Provisioning Template for each target to record its configuration
3. Call Delete Provisioning Templates with the verified IDs; approve the confirmation form with a reason
4. Check SuccessIds / FailedIds; call List Provisioning Templates to confirm removal

8.2 Handling Partial Failures

Scenario: Some IDs failed to delete in a batch.

Tool Chain:

Delete Provisioning Templates → (inspect FailedIds) → List Provisioning Templates → Delete Provisioning Templates (remaining valid IDs)

Steps:

1. After the first delete, group FailedIds by ErrorMessage
2. Drop default-template and permission-denied IDs; verify not-found IDs via List Provisioning Templates
3. Re-invoke Delete Provisioning Templates with only the remaining deletable IDs

Appendix Reference:

• Field Reference: ./Field Reference.md
• Error Code Quick Reference: ./Error Codes.md