Delete a Record

Use mutations to delete a record. Within mutations, the RecordDelete field enables you to update all object types your Salesforce user has access to. Only objects supported by UI API are available for mutations.

Example Delete Request

To delete a record, use RecordDelete with the Id for the record you want to delete.

mutation AccountDeleteExample{
  uiapi {
    AccountDelete(input: {
      Id: "001RM000005eiZZZZZ"
    })
      {
         Id
      }
  }
}

Example Response on Deletion

The response body returns the Id value of the record you deleted.

{
  "data": {
    "uiapi": {
      "AccountDelete": {
        "Id": "001RM000005eiZZZZZ"
      }
    }
  },
  "errors": []
}

Record Delete Guidelines

Consider these guidelines for deleting a record.

• Sending a delete request with an incorrect Id value returns a DataFetchingException error.
• Sending a delete request for a record that’s already deleted returns a DataFetchingException error.

See Also

Send Mutation Requests