Gmail email label profile

org.intentschema.communication.email.message.label.v1@com.google.gmail.v1

JSON: bare · @sha256:57ae6973adc7…
Hash: sha256:57ae6973adc7f5109263c009bbb60bb58c720445753c3095f06cb8a8a266e9cf

Gmail profile for email message label.

Implements: Label email message (org.intentschema.communication.email.message.label.v1)

Payload

FieldTypeDescription
target *Target (required: external_id)(system = "gmail", required: system)
object *object
idempotency_keystring
object
FieldTypeDescription
addstring[]Label identifiers to add.
removestring[]Label identifiers to remove.

Result

FieldTypeDescription
external_idstring
labelsstring[]Label set after the operation.
updated_atstring (date-time)

API mapping

FieldValue
base_urlhttps://gmail.googleapis.com
methodPOST
path/gmail/v1/users/me/messages/{id}/modify
scopeshttps://www.googleapis.com/auth/gmail.modify
docshttps://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify

Field mapping

Intent fieldAPI parameter
target.external_iduserId/messages/{id} path parameter
object.addaddLabelIds[]
object.removeremoveLabelIds[]