¶ Description
Delete data on a SuiteCRM server.
¶ Parameters
¶ Parameters
Parameters:
- Module to delete from
- Column id
- URL
- Client ID
- Client secret
- Debug information level
- Optional: extra parameters for cURL
- Number of retries on connection error
- Error Management
¶ Description tab
Parameters:
- Script name
- Short description
- Revision
- Decription
¶ Configuration tab
See dedicated page for more information.
¶ About
This box deletes a single record from a selected SuiteCRM module (e.g., accounts, contacts, leads, etc.). It sends an authenticated call to your SuiteCRM API and marks the record as deleted.
¶ Prerequisites
- A SuiteCRM instance with REST API enabled.
- An OAuth Client ID and Client Secret for your ETL.
→ If you need help generating these, follow the credential steps in the suiteCRMDownload guide . - A user/account with permission to delete records in the target module.
Deleting in SuiteCRM is typically soft delete (record is flagged
deleted=1and hidden from the UI). Treat it as irreversible from the UI perspective; recovery, if needed, is a database-level operation.
¶ Minimum Setup
- Module to delete from – choose the module to delete from (e.g.,
accounts,contacts,leads, …). - Column id – the record ID (GUID) of the row you want to delete.
- url – your SuiteCRM base URL (e.g.,
https://yourcompany.suiteondemand.com). - Client ID and Client secret – your OAuth Client ID and Client Secret.
Everything else can remain at sensible defaults while you test.
¶ Step-by-Step (first successful run)
- Drag the suiteCRMDelete box into your pipeline.
- Pick the Module to delete from from the dropdown (e.g.,
accounts). - Paste the Column id (record GUID) you want to delete.
- Enter your SuiteCRM url.
- Paste Client ID (Client ID) and Client secret (Client Secret).
- (Optional but recommended) set Debug information level to
verbosefor your first test. - Leave Error Management as
continue with status ERRORwhile testing so the pipeline finishes and shows the error status/message. - Run the pipeline.
If everything is correct, the action completes without errors and the record is removed (soft deleted) from the module.
¶ How to find the record ID (GUID)
Pick whichever is fastest for you:
-
From the SuiteCRM UI
Open the record, copy the long hex ID from the URL afterrecord=(e.g.,…record=9c9c8e36-…). -
From the ETL using suiteCRMDownload
Add a Download box before Delete, filter to the row(s) you need, and read theidcolumn from the output. Then map thatidinto Column id. -
Via API/Reports
If you already fetch records programmatically, reuse the record’sidfield.
¶ Safety tips
- Dry run on a harmless module: Create a test record (e.g., in
notes) and delete that first. - Keep an audit trail: Consider writing the IDs you delete to a log (another step) before deletion.
- Access control: Use a dedicated OAuth client with limited scope/role if possible.
¶ Useful options (quick notes)
- Debug information level:
verboseprints request/response details to the log—useful for setup and troubleshooting. Switch back tonothinglater. - Number of retries on connection error: automatic retries for transient network hiccups.
- Optional: extra parameters for cURL: pass extra cURL flags if you need a proxy or special TLS options (e.g.,
--proxy http://…), same as in your other SuiteCRM actions.
¶ Common patterns
-
Delete after lookup
suiteCRMDownload(find ID) →suiteCRMDelete(delete record) → optional logger. -
Bulk delete
Feed a list of IDs (from CSV or a query) through a loop/iterate construct, callsuiteCRMDeleteper ID, collect results.
¶ FAQ
-
Does this remove related records?
No. It deletes only the chosen record in the selected module. Relationships remain; SuiteCRM hides links to deleted records. -
Can I “hard delete”?
The standard API performs soft delete. Hard delete is not supported from this action and is generally discouraged. -
Can I undo?
Not from the UI. Recovery would require database-level work; plan accordingly.
