API
tryapis.com
Find anything
⌘ K
Gmail API Endpoints
users
Lists the drafts in the user's mailbox.

GET

Creates a new draft with the `DRAFT` label.

POST

Sends the specified, existing draft to the recipients in the `To`, `Cc`, and `Bcc` headers.

POST

Immediately and permanently deletes the specified draft. Does not simply trash it.

DELETE

Gets the specified draft.

GET

Replaces a draft's content.

PUT

Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing `historyId`).

GET

Lists all labels in the user's mailbox.

GET

Creates a new label.

POST

Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to.

DELETE

Gets the specified label.

GET

Patch the specified label.

PATCH

Updates the specified label.

PUT

Lists the messages in the user's mailbox.

GET

Directly inserts a message into only this user's mailbox similar to `IMAP APPEND`, bypassing most scanning and classification. Does not send a message.

POST

Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.

POST

Modifies the labels on the specified messages.

POST

Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing. This method does not send a message. Note: This function doesn't trigger forwarding rules or filters set up by the user.

POST

Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers.

POST

Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer `messages.trash` instead.

DELETE

Gets the specified message.

GET

Modifies the labels on the specified message.

POST

Moves the specified message to the trash.

POST

Removes the specified message from the trash.

POST

Gets the specified message attachment.

GET

Gets the current user's Gmail profile.

GET

Gets the auto-forwarding setting for the specified account.

GET

Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority.

PUT

Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.

GET

Adds a delegate with its verification status set directly to `accepted`, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is only available to service account clients that have been delegated domain-wide authority.

POST

Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority.

DELETE

Gets the specified delegate. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority.

GET

Lists the message filters of a Gmail user.

GET

Creates a filter. Note: you can only create a maximum of 1,000 filters.

POST

Deletes a filter.

DELETE

Gets a filter.

GET

Lists the forwarding addresses for the specified account.

GET

Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to `pending`; otherwise, the resource will be created with verification status set to `accepted`. This method is only available to service account clients that have been delegated domain-wide authority.

POST

Deletes the specified forwarding address and revokes any verification that may have been required. This method is only available to service account clients that have been delegated domain-wide authority.

DELETE

Gets the specified forwarding address.

GET

Gets IMAP settings.

GET

Updates IMAP settings.

PUT

Gets language settings.

GET

Updates language settings. If successful, the return object contains the `displayLanguage` that was saved for the user, which may differ from the value passed into the request. This is because the requested `displayLanguage` may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead.

PUT

Gets POP settings.

GET

Updates POP settings.

PUT

Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases.

GET

Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to `pending`; otherwise, the resource will be created with verification status set to `accepted`. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method is only available to service account clients that have been delegated domain-wide authority.

POST

Deletes the specified send-as alias. Revokes any verification that may have been required for using it. This method is only available to service account clients that have been delegated domain-wide authority.

DELETE

Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.

GET

Patch the specified send-as alias.

PATCH

Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority.

PUT

Lists S/MIME configs for the specified send-as alias.

GET

Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key.

POST

Deletes the specified S/MIME config for the specified send-as alias.

DELETE

Gets the specified S/MIME config for the specified send-as alias.

GET

Sets the default S/MIME config for the specified send-as alias.

POST

Sends a verification email to the specified send-as alias address. The verification status must be `pending`. This method is only available to service account clients that have been delegated domain-wide authority.

POST

Gets vacation responder settings.

GET

Updates vacation responder settings.

PUT

Stop receiving push notifications for the given user mailbox.

POST

Lists the threads in the user's mailbox.

GET

Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer `threads.trash` instead.

DELETE

Gets the specified thread.

GET

Modifies the labels applied to the thread. This applies to all messages in the thread.

POST

Moves the specified thread to the trash.

POST

Removes the specified thread from the trash.

POST

Set up or update a push notification watch on the given user mailbox.

POST

DELETE

https://gmail.googleapis.com/gmail/v1/users/userId/settings/forwardingAddresses/forwardingEmail

Deletes the specified forwarding address and revokes any verification that may have been required. This method is only available to service account clients that have been delegated domain-wide authority.

Scopes requested: https://mail.google.com/
Authorization
tryapis.com never stores your requests or responses