Users.threads: delete

Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead. Try it now or see an example.

Request

HTTP request

DELETE https://www.googleapis.com/gmail/v1/users/userId/threads/id

Parameters

Parameter name Value Description
Path parameters
id string ID of the Thread to delete.
userId string The user's email address. The special value me can be used to indicate the authenticated user.

Authorization

This request requires authorization with the following scope:

Scope
https://mail.google.com/

For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).

Java

Uses the Java client library.

import com.google.api.services.gmail.Gmail;

import java.io.IOException;

// ...

public class MyClass {

  // ...


  /**
   * Immediately and permanently deletes the specified thread. This operation cannot
   * be undone. Prefer threads.trash instead.
   *
   * @param service Authorized Gmail API instance.
   * @param userId User's email address. The special value "me"
   * can be used to indicate the authenticated user.
   * @param threadId ID of Thread to delete.
   * @throws IOException
   */
  public static void deleteThread(Gmail service, String userId, String threadId)
      throws IOException {
    service.users().threads().delete(userId, threadId).execute();
    System.out.println("Thread with id: " + threadId + " deleted successfully.");
  }

  // ...
}

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Send feedback about...

Need help? Visit our support page.