Delete Recycle Bin Records

Parameters

• idsstring, optional

  To delete specific records based on their unique ID. You can specify up to 100 records IDs to be deleted.
  Possible values: Valid unique IDs of records, in comma separated format. Example: 4150868000001944196,487687600000327055

• filtersJSON object, optional

  To delete records that meet the defined criterion, using logical operators and comparators to filter by fields such as display name, module, deleted by, and deleted time.

  Note :  Make sure to encode the filters parameter value before making the API call.

  JSON keys in filters param:

  • group_operator string, optional

    Defines how to combine the multiple conditions defined in the group array. 
    Possible Value:AND

  • groupJSON array, mandatory

    An array of filter conditions, where each condition specifies the field, comparator and value.

    • fieldJSON object

      Represents the field by which the records should be filtered. Refer to the Filter Attributes section to know the possible values.

    • comparatorstring

      Represents the comparator operator, such as equal, not_equal, contains, etc. Refer to the Filter Attributes section to know the possible values for each field.

    • valuestring/JSON object

      Represents the value to compare the field against. This can be a string or a JSON object, depending on the field. Refer to the sample section for more details.

  Filter Attributes:

  • display_name

    The display name of the record. The conditions that can be applied for display_name are equal, not_equal, contains, not_contains, starts_with, and ends_with.

  • module

    The API name of the module. Records from this module in the recycle bin will be filtered for deletion. The conditions that can be applied for module are equal and not_equal

  • deleted_by

    The name of the user who deleted the record. The conditions that can be applied for deleted_by are equal, not_equal, contains, not_contains, starts_with, and ends_with.

  • deleted_time

    The date and time the record was deleted, in ISO 8601 DateTime format. The conditions that can be applied for deleted_time are equal, not_equal, greater_than, and less_than.

Possible Errors

• INVALID_DATAHTTP 400
  • The ID given seems to be invalid.
    Resolution: Specify valid record ID.
  • The given group operator not supported. Only 'AND' operator is supported 
    Resolution: Construct the filters parameter value with AND group operator.
  • The given API name seems to be invalid 
    Resolution: Specify valid API names for the fields in the filters parameter.
• INVALID_REQUEST_METHODHTTP 400

  The request method is incorrect.
  Resolution: Use the HTTP DELETE method to make this API call. Any other request method will result in this error.

• OAUTH_SCOPE_MISMATCHHTTP 401

  The access token you have used to make this API call does not have the required scope.
  Resolution: Generate a new access token with the required scopes for this API. Refer to the Scope section at the beginning of this page for the list of required scopes.

• INVALID_URL_PATTERNHTTP 404

  The request URL is incorrect.
  Resolution: Specify a valid request URL. Refer to the request URL section at the beginning of this page for more details.

• INTERNAL_ERRORHTTP 500

  Unexpected and unhandled exception in the server. 
  Resolution: Contact the support team at support@zohocrm.com.