Skip to main content
Google Workspace
  • Google Workspace
Home Gmail All products
  • Google Workspace apps
  • Admin console
  • Cloud Search
  • Gmail
  • Google Calendar
  • Google Chat
  • Google Classroom
  • Google Docs
  • Google Drive
  •  
  • Google Forms
  • Google Keep
  • Google Meet
  • Google Sheets
  • Google Sites
  • Google Slides
  • Google Tasks
  • Google Vault
  • Extend, automate & share
  • Add-ons
  • Apps Script
  • Chat apps
  • Drive apps
  • Marketplace
Resources
  • Tools
  • Admin console
  • Apps Script dashboard
  • Google Cloud console
  • APIs Explorer
  • Card Builder
  • Training & support
  • How to get started
  • Codelabs
  • Developer support
  • Updates
  • Release notes
  • Developer Previews
  • YouTube
  • Newsletter
  • X (Twitter)
  • Blog
/
  • English
  • Deutsch
  • Español
  • Español – América Latina
  • Français
  • Indonesia
  • Italiano
  • Polski
  • Português – Brasil
  • Tiếng Việt
  • Türkçe
  • Русский
  • עברית
  • العربيّة
  • فارسی
  • हिंदी
  • বাংলা
  • ภาษาไทย
  • 中文 – 简体
  • 中文 – 繁體
  • 日本語
  • 한국어
Sign in
  • Gmail
Overview Guides Reference Samples Support
Google Workspace
  • Google Workspace
  • Home
  • Gmail
    • Overview
    • Guides
    • Reference
    • Samples
    • Support
  • All products
    • More
  • Resources
    • More
  • Gmail API
  • v1
    • Resource summary
    • REST Resources
    • users
      • Overview
      • getProfile
      • stop
      • watch
    • users.drafts
      • Overview
      • create
      • delete
      • get
      • list
      • send
      • update
    • users.history
      • Overview
      • list
    • users.labels
      • Overview
      • create
      • delete
      • get
      • list
      • patch
      • update
    • users.messages
      • Overview
      • batchDelete
      • batchModify
      • delete
      • get
      • import
      • insert
      • list
      • modify
      • send
      • trash
      • untrash
    • users.messages.attachments
      • Overview
      • get
    • users.settings
      • Overview
      • getAutoForwarding
      • getImap
      • getLanguage
      • getPop
      • getVacation
      • updateAutoForwarding
      • updateImap
      • updateLanguage
      • updatePop
      • updateVacation
    • users.settings.cse.identities
      • Overview
      • create
      • delete
      • get
      • list
      • patch
    • users.settings.cse.keypairs
      • Overview
      • create
      • disable
      • enable
      • get
      • list
      • obliterate
    • users.settings.delegates
      • Overview
      • create
      • delete
      • get
      • list
    • users.settings.filters
      • Overview
      • create
      • delete
      • get
      • list
    • users.settings.forwardingAddresses
      • Overview
      • create
      • delete
      • get
      • list
    • users.settings.sendAs
      • Overview
      • create
      • delete
      • get
      • list
      • patch
      • update
      • verify
    • users.settings.sendAs.smimeInfo
      • Overview
      • delete
      • get
      • insert
      • list
      • setDefault
    • users.threads
      • Overview
      • delete
      • get
      • list
      • modify
      • trash
      • untrash
    • Types
    • AutoForwarding
    • Format
    • ImapSettings
    • InternalDateSource
    • LanguageSettings
    • PopSettings
    • VacationSettings
    • Query parameters
  • Client libraries
    • Overview
    • Browser
    • Go
    • Java
      • Core library
      • API library
    • .NET
      • Core library
      • API library
    • Node.js
    • PHP
    • Python
      • Core library
      • API library
    • Ruby
  • API usage limits
  • Postmaster Tools API
  • v1
    • Resource summary
    • REST Resources
    • domains
      • Overview
      • get
      • list
    • domains.trafficStats
      • Overview
      • get
      • list
  • Email Markup
  • Markup Types
  • Actions
    • One-Click Action
    • Go-To Action
  • Orders
    • Order
    • Parcel Delivery
    • Invoice
  • Reservations
    • Bus
    • Event
    • Flight
    • Hotel
    • Rental Car
    • Restaurant
    • Train
  • Supported Formats
    • JSON-LD
    • Microdata
    • DateTime Formatting
  • Types
    • APIReference
    • AboutPage
    • AcceptAction
    • AccountingService
    • AchieveAction
    • Action
    • ActionHandler
    • ActionStatusType
    • ActivateAction
    • AddAction
    • AdministrativeArea
    • AdultEntertainment
    • AggregateOffer
    • AggregateRating
    • AgreeAction
    • Airline
    • Airport
    • AlignmentObject
    • AllocateAction
    • AmusementPark
    • AnatomicalStructure
    • AnatomicalSystem
    • AnimalShelter
    • Answer
    • ApartmentComplex
    • AppendAction
    • ApplyAction
    • ApprovedIndication
    • Aquarium
    • ArriveAction
    • ArtGallery
    • Artery
    • AskAction
    • AssessAction
    • AssignAction
    • Attorney
    • Audience
    • AudioObject
    • AuthorizeAction
    • AutoBodyShop
    • AutoDealer
    • AutoPartsStore
    • AutoRental
    • AutoRepair
    • AutoWash
    • AutomatedTeller
    • AutomotiveBusiness
    • Bakery
    • BankOrCreditUnion
    • BarOrPub
    • Beach
    • BeautySalon
    • BedAndBreakfast
    • BefriendAction
    • BikeStore
    • Blog
    • BlogPosting
    • BloodTest
    • BodyOfWater
    • Bone
    • Book
    • BookFormatType
    • BookSeries
    • BookStore
    • BookmarkAction
    • Boolean
    • BorrowAction
    • BowlingAlley
    • BrainStructure
    • Brand
    • BreadcrumbList
    • Brewery
    • BroadcastEvent
    • BroadcastService
    • BuddhistTemple
    • BusReservation
    • BusStation
    • BusStop
    • BusTrip
    • BusinessAudience
    • BusinessEntityType
    • BusinessEvent
    • BusinessFunction
    • BuyAction
    • CafeOrCoffeeShop
    • Campground
    • Canal
    • CancelAction
    • Car
    • Casino
    • CatholicChurch
    • Cemetery
    • CheckAction
    • CheckInAction
    • CheckOutAction
    • CheckoutPage
    • ChildCare
    • ChildrensEvent
    • ChooseAction
    • Church
    • City
    • CityHall
    • CivicStructure
    • Class
    • Clip
    • ClothingStore
    • Code
    • CollectionPage
    • CollegeOrUniversity
    • ComedyClub
    • ComedyEvent
    • Comment
    • CommentAction
    • CommunicateAction
    • ComputerStore
    • ConfirmAction
    • ConsumeAction
    • ContactPage
    • ContactPoint
    • ContactPointOption
    • Continent
    • ControlAction
    • ConvenienceStore
    • CookAction
    • Corporation
    • Country
    • Courthouse
    • CreateAction
    • CreativeWork
    • CreditCard
    • Crematorium
    • DDxElement
    • DanceEvent
    • DanceGroup
    • DataCatalog
    • DataDownload
    • DataType
    • Dataset
    • Date
    • DateTime
    • DatedMoneySpecification
    • DayOfWeek
    • DaySpa
    • DeactivateAction
    • DefenceEstablishment
    • DeleteAction
    • DeliveryChargeSpecification
    • DeliveryEvent
    • DeliveryMethod
    • Demand
    • Dentist
    • DepartAction
    • DepartmentStore
    • DiagnosticLab
    • DiagnosticProcedure
    • Diet
    • DietarySupplement
    • DisagreeAction
    • DiscoverAction
    • DislikeAction
    • Distance
    • DonateAction
    • DoseSchedule
    • DownloadAction
    • DrawAction
    • DrinkAction
    • Drug
    • DrugClass
    • DrugCost
    • DrugCostCategory
    • DrugLegalStatus
    • DrugPregnancyCategory
    • DrugPrescriptionStatus
    • DrugStrength
    • DryCleaningOrLaundry
    • Duration
    • EatAction
    • EducationEvent
    • EducationalAudience
    • EducationalOrganization
    • Electrician
    • ElectronicsStore
    • ElementarySchool
    • EmailMessage
    • EmailMessage2
    • Embassy
    • EmergencyService
    • EmployeeRole
    • EmploymentAgency
    • EndorseAction
    • Energy
    • EntertainmentBusiness
    • EntryPoint
    • Enumeration
    • Episode
    • Event
    • EventReservation
    • EventStatusType
    • EventVenue
    • ExerciseAction
    • ExerciseGym
    • ExercisePlan
    • FastFoodRestaurant
    • Festival
    • FilmAction
    • FinancialService
    • FindAction
    • FireStation
    • Flight
    • FlightReservation
    • Float
    • Florist
    • FollowAction
    • FoodEstablishment
    • FoodEstablishmentReservation
    • FoodEvent
    • FurnitureStore
    • Game
    • GamePlayMode
    • GameServer
    • GameServerStatus
    • GardenStore
    • GasStation
    • GatedResidenceCommunity
    • GeneralContractor
    • GeoCoordinates