Mutations - Delete Records

The Delete mutation is used to remove existing records from Standard and External object types.

To delete records, the system provides a GraphQL mutation API in the format delete + API name, where the API name is defined during object creation. This mutation allows users to delete a record by providing its primary key value.

During execution, the input data is validated against the object schema to ensure correctness and authorization.

mutation MyMutation {
  deleteexternalObj_API(input: {externalObj_id: "4"}) {
    externalObj_API {
      name
      externalObj_external_id
    }
  }
}

On successful execution, the mutation returns the deleted record. The response includes only the fields explicitly selected in the query, allowing users to control which data is returned.

If the primary key is missing, invalid, or the record does not exist, the mutation fails and returns appropriate error messages.