Skip to main content

Delete Record

Description

FreshDesk: Delete Record step deletes one or more FreshDesk records matching the criteria query.

References

To check the Field Value type required for the specified Field Name supported for the given Form Name, use the following links:

  • https://developers.freshdesk.com/api/#filter_tickets
  • https://developers.freshdesk.com/api/#delete_a_ticket
  • https://developers.freshdesk.com/api/#bulk_delete_tickets

Configurations

No.Field NameDescription
Configuration
1Step NameSpecify the name of the step. This name has to be unique in a single workflow.
Connection:
2Base URLSpecify the base URL of the FreshDesk cloud instance. For example, https://XXXXX. freshdesk.com.
The field data type is String. This field is mandatory.
3Accept value as variable/staticLeave checkbox unchecked to accept API Key value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for API Key field to appear as text box.
4API KeySpecify the API Key to authenticate FreshDesk cloud instance.
The field data type is String. This field is mandatory.
5Test ConnectionVerifies whether the connection is established or not.
Note: For the purpose of verification, fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. The Test Connection button will only work with static (hardcoded) values and environment variables.
Input Tab:
1Form NameSpecify the name of the form to get the matching records.
The field data type is String. This field is mandatory.
2Criteria QueryProvide the criteria query to fetch all FreshDesk records. For Criteria Query sample, see Annexure.
The field data type is String. This field is mandatory.
Note: You can fetch a maximum 300 records at a time.
3Delete Multiple Records (Max: 300)Select Yes or No. If you select Yes, multiple records matching the specified criteria is deleted.
Note:
- Default value is No.
- You can delete a maximum 300 records at a time.
Output Tab:
1Delete Record IDsHolds the ID of the deleted records in the FreshDesk cloud instance.
Default value: DeletedRecordIDs

Annexure

Criteria query sample syntax format "(ticket_field:integer OR ticket_field:'string') AND ticket_field:boolean" Sample criteria query

  • priority: 3
  • status: 3 or status: 4
  • group_id: 11
  • (type:'Question' OR type:'Problem') AND (due_by:>'2017-10-01' AND due_by:<'2024-10-07')

Known issues

  • Of the 300 records retrieved using the criteria query some records may be duplicate records. [API behavior]
  • Out of 300, only distinct records will be deleted.