Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-173225164.2 KB
users

Patch the specified label.

patch/users/{userId}/labels/{id}

Path parameters

userIdstring required

The user's email address. The special value me can be used to indicate the authenticated user

idstring required

The ID of the label to update

Query parameters

$.xgafv'1' | '2'

V1 error format

V1 error format

access_tokenstring

OAuth access token

alt'json' | 'media' | 'proto'

Data format for response

Data format for response

callbackstring

JSONP

fieldsstring

Selector specifying which fields to include in a partial response

keystring

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token

oauth_tokenstring

OAuth 2.0 token for the current user

prettyPrintboolean

Returns response with indentations and line breaks

quotaUserstring

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters

upload_protocolstring

Upload protocol for media (e.g. "raw", "multipart")

uploadTypestring

Legacy upload protocol for media (e.g. "media", "multipart")

Request body

messageListVisibility'show' | 'hide'

The visibility of messages with this label in the message list in the Gmail web interface

messagesUnreadinteger

The number of unread messages with the label

threadsUnreadinteger

The number of unread threads with the label

threadsTotalinteger

The total number of threads with the label

namestring

The display name of the label

idstring

The immutable ID of the label

labelListVisibility'labelShow' | 'labelShowIfUnread' | 'labelHide'

The visibility of the label in the label list in the Gmail web interface

type'system' | 'user'

The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads

messagesTotalinteger

The total number of messages with the label

Response

Successful response

messageListVisibility'show' | 'hide'

The visibility of messages with this label in the message list in the Gmail web interface

messagesUnreadinteger

The number of unread messages with the label

threadsUnreadinteger

The number of unread threads with the label

threadsTotalinteger

The total number of threads with the label

namestring

The display name of the label

idstring

The immutable ID of the label

labelListVisibility'labelShow' | 'labelShowIfUnread' | 'labelHide'

The visibility of the label in the label list in the Gmail web interface

type'system' | 'user'

The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads

messagesTotalinteger

The total number of messages with the label