Label email message

org.intentschema.communication.email.message.label.v1

JSON: bare · @sha256:29dabbdfe1b0…
Hash: sha256:29dabbdfe1b0858957e52ccbc025c906a208480dd9adedae07f1d1ae6a2036eb

Adds or removes labels (Gmail) or categories (Outlook) on an existing email message. Label identifiers are provider-specific strings.

Payload

Field	Type	Description
`target` *	`Target` (required: `external_id`)
`object` *	`object`
`idempotency_key`	`string`

object

Field	Type	Description
`add`	`string[]`	Label identifiers to add.
`remove`	`string[]`	Label identifiers to remove.

Result

Field	Type	Description
`external_id`	`string`
`labels`	`string[]`	Label set after the operation.
`updated_at`	`string` (date-time)

Examples

add one label

{
  "target": {
    "system": "gmail",
    "external_id": "msg_abc123"
  },
  "object": {
    "add": [
      "Label_9"
    ]
  }
}

add and remove labels

{
  "target": {
    "system": "gmail",
    "external_id": "msg_abc123"
  },
  "object": {
    "add": [
      "Label_5"
    ],
    "remove": [
      "Label_2"
    ]
  }
}

Profiles

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