@messagebird/n8n-nodes-bird 0.39.0 → 0.41.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -469,7 +469,7 @@ exports.birdProperties = [
469
469
  typeOptions: { multipleValues: true },
470
470
  placeholder: "Add Attachment",
471
471
  default: {},
472
- description: "Files to attach, up to 20 per message. A message can be at most 20 MB once it has been generated, and we refuse a send that would go over. That figure covers the HTML body, the text body and every attachment and inline image, all measured after base64 encoding, which adds roughly a third. So 15 MB of raw files already accounts for most of the budget, and the body competes for the same space. A batch send is held to the same 20 MB per message, and the whole request body is capped at 20 MB as well.",
472
+ description: "Files to attach, up to 20 per message. A generated message is capped at 20 MB, and a send over it is refused. The cap counts the HTML and text bodies and every attachment and inline image after base64 encoding, which adds about a third, so 15 MB of raw files uses most of it. Each batch item has the same cap, and the whole request body is capped at 20 MB too.",
473
473
  options: [
474
474
  {
475
475
  displayName: "Attachment",
@@ -544,7 +544,7 @@ exports.birdProperties = [
544
544
  { name: "Transactional", value: "transactional" },
545
545
  ],
546
546
  default: "",
547
- description: "Content classification, which controls suppression policy: - `marketing`: Blocks on all suppression reasons. - `transactional`: Allows delivery through complaint and unsubscribe suppressions, for receipts, password resets, and similar operational mail. When you send with `template` and omit this field, the message takes the template's own classification, so a template created as `transactional` sends as transactional. Set this field to classify a single send differently from its template. It always takes precedence. A send with no template and no category defaults to `marketing`.",
547
+ description: "Content classification, which sets the suppression policy: - `marketing`: blocked by every suppression reason. A send with no template and no category defaults to it. - `transactional`: delivered through complaint and unsubscribe suppressions, for receipts, password resets and similar operational mail. A `template` send that omits it takes the template's classification. Set it to classify one send differently from its template; it always takes precedence.",
548
548
  },
549
549
  {
550
550
  displayName: "Cc",
@@ -603,7 +603,7 @@ exports.birdProperties = [
603
603
  typeOptions: { multipleValues: true },
604
604
  placeholder: "Add Pair",
605
605
  default: {},
606
- description: "Arbitrary JSON object returned on API reads and included in webhook payloads. You can query its paths in analytics, such as `metadata.order_id`, but it is not a dashboard filter. The serialized object is limited to 2 KB. Use metadata for per-send context such as order IDs, customer references, and structured event data. For low-cardinality filterable labels, use `tags` instead.",
606
+ description: "JSON object returned on reads and in webhook payloads, up to 2 KB serialized. Analytics can query its paths, such as `metadata.order_id`, but the dashboard cannot filter by it. Use it for per-send context such as order IDs and customer references, and `tags` for low-cardinality labels you filter by.",
607
607
  options: [
608
608
  {
609
609
  displayName: "Pair",
@@ -632,7 +632,7 @@ exports.birdProperties = [
632
632
  typeOptions: { multipleValues: true },
633
633
  placeholder: "Add Pair",
634
634
  default: {},
635
- description: "Parameter values used to personalize inline content, shared across all recipients of this send. Tokens such as `{{ animal }}` are replaced with matching values; missing values render empty. Include this object, even as `{}`, to use Liquid, or omit it to leave tokens unchanged. Use single-word names other than `bird`. Cap: 16 KB serialized. For a stored template, use `template.parameters` instead. See [inline personalization](https://bird.com/docs/guides/email/sending-email#content) for validation and URL encoding examples.",
635
+ description: "Values for the Liquid tokens in inline content, shared by every recipient: `{{ animal }}` takes the `animal` value, and a missing value renders empty. Include the object, even as `{}`, to render Liquid, or omit it to leave tokens unchanged. Names are single words other than `bird`, and the object is capped at 16 KB serialized. A stored template takes `template.parameters` instead. [Inline personalization](https://bird.com/docs/guides/email/sending-email#content) covers validation and URL encoding.",
636
636
  options: [
637
637
  {
638
638
  displayName: "Pair",
@@ -673,7 +673,7 @@ exports.birdProperties = [
673
673
  name: "scheduled_at",
674
674
  type: "dateTime",
675
675
  default: "",
676
- description: "Schedule the message to send at a future time instead of immediately. Must be at least 30 seconds and at most 30 days ahead. Outside that range the request is rejected with `422`. The message returns with status `accepted` and shows as `scheduled` on reads until it sends. Cancel it before then with the message cancel endpoint. Scheduled sends count against your plan's monthly scheduled-email allowance. Exceeding it is rejected with a `422`. For a stored template, the published version, language and parameter values are pinned when we accept the request, so a later publication does not change what sends. If the template is deleted before the message is due, the message is rejected with `generation_failure`. We also check sender eligibility and send-volume allowance when the message is due. Batch items take this field too, so one batch can mix scheduled and immediate messages.",
676
+ description: "Send at this future time instead of immediately, at least 30 seconds and at most 30 days ahead; outside that range returns `422`. The message returns `accepted` and reads as `scheduled` until it sends, and the message cancel endpoint cancels it before then. Scheduled sends count against your plan's monthly scheduled-email allowance, and a send over it returns `422`. A stored template's published version, language and parameter values are pinned at acceptance, so a later publication does not change what sends; deleting the template before the message is due rejects it with `generation_failure`. Sender eligibility and send-volume allowance are checked again when it is due. Batch items take this field too, so one batch can mix scheduled and immediate messages.",
677
677
  },
678
678
  {
679
679
  displayName: "Subject",
@@ -689,7 +689,7 @@ exports.birdProperties = [
689
689
  typeOptions: { multipleValues: true },
690
690
  placeholder: "Add Tag",
691
691
  default: {},
692
- description: "Structured `{name, value}` labels for **filtering and analytics**. Tags become first-class query dimensions: - Filter the list endpoint by tag name. - Slice analytics rollups by tag. - Surface in webhook payloads. Cap: 20 tags per send. Use tags for low-cardinality dimensions (`category`, `experiment_variant`, `template_id`). For arbitrary structured context that you do not need as a filter dimension, use `metadata` instead.",
692
+ description: "Structured `{name, value}` labels, up to 20 per send. You can filter the list endpoint by tag name, slice analytics by tag, and read them in webhook payloads. Use them for low-cardinality dimensions such as `category`, `experiment_variant` or `template_id`, and `metadata` for context you do not filter by.",
693
693
  options: [
694
694
  {
695
695
  displayName: "Tag",
@@ -749,7 +749,7 @@ exports.birdProperties = [
749
749
  typeOptions: { multipleValues: true },
750
750
  placeholder: "Add Pair",
751
751
  default: {},
752
- description: "Values for caller parameters, keyed by name. A parameter name is a single word. Caller parameters have `system` set to false or absent in the template's `variables` list. Supply each required caller parameter used by the resolved send language; omitting one or supplying null returns `422`. A version's list covers all its languages, and values unused by the resolved language are ignored. The `bird` namespace is reserved for values filled by Bird, so a send that sets it is rejected. `parameters` is capped at 16 KB once serialized. Bird resolves the referenced `bird.contact` attributes from each original To recipient's matching contact in this workspace. Each To receives its own personalized email; Cc and Bcc receive a copy of each To's email and do not need matching contacts. A missing To contact rejects the send with `422` (`E04099`), including when Liquid uses a default or condition. Empty name fields on an existing contact render empty unless Liquid supplies a default; configured contact-property fallbacks still apply. Values are saved at acceptance and reused for delivery and content history. Individual, batch, and scheduled sends support this behavior.",
752
+ description: "Values for the template's caller parameters, keyed by single-word name. Caller parameters are those with `system` false or absent in the template's `variables`. Supply every required one the resolved language uses; omitting one or sending `null` returns `422`, and values the resolved language does not use are ignored. The `bird` namespace is reserved, so a send that sets it is rejected, and the object is capped at 16 KB serialized. Referenced `bird.contact` attributes come from each To recipient's contact in this workspace, so each To receives its own email, and Cc and Bcc receive a copy of each without needing a contact of their own. A To with no contact rejects the send with `422` (`E04099`), even when Liquid sets a default or condition. Empty name fields on an existing contact render empty unless Liquid supplies a default, and configured contact-property fallbacks still apply. Values are saved at acceptance and reused for delivery and content history, for individual, batch and scheduled sends alike.",
753
753
  options: [
754
754
  {
755
755
  displayName: "Pair",
@@ -2854,14 +2854,14 @@ exports.birdProperties = [
2854
2854
  name: "from",
2855
2855
  type: "string",
2856
2856
  default: "",
2857
- description: "Sender to send from. It must be a sender the workspace holds: a number it owns in E.164, such as `+15557654321`, a short code it holds, such as `24680`, or an alphanumeric sender ID it has claimed, such as `MyBrand`. A sender the workspace does not hold returns a `422` `SMSSenderNotConfigured`, and an alphanumeric sender must also be permitted, and where required registered, for the destination country. Required on a free-text send and when sending a workspace template, unless `messaging_profile_id` is set and the profile selects a sender for the destination country or has a default sender. Omitting it otherwise returns `422`. A built-in template selects its sender automatically and rejects `from`.",
2857
+ description: "Sender the workspace holds: a number it owns in E.164, such as `+15557654321`, a short code, such as `24680`, or an alphanumeric sender ID it has claimed, such as `MyBrand`. Any other sender returns `422` `SMSSenderNotConfigured`, and an alphanumeric sender must also be permitted, and where required registered, for the destination country. Required on a free-text send and a workspace-template send, unless the profile in `messaging_profile_id` selects a sender for the destination country or has a default sender; omitting it otherwise returns `422`. A built-in template selects its sender itself and rejects `from`.",
2858
2858
  },
2859
2859
  {
2860
2860
  displayName: "Messaging Profile ID",
2861
2861
  name: "messaging_profile_id",
2862
2862
  type: "string",
2863
2863
  default: "",
2864
- description: "The messaging profile that supplies this message's sender and defaults. When `from` is omitted, Bird sends from the profile's sender for the destination country, or its default sender. An omitted `category` on a free-text send takes the profile's default category, and `smart_encoding`, `cost_center` and `validity_period` take the profile's settings. So do `options.callback_url` and `options.ignore_suppression`, which apply to the message. Values you set on the message take precedence. A built-in template sends from Bird's system sender and ignores the profile's senders. A profile that does not exist in this workspace returns `422` `SMSMessagingProfileNotFound`; a `from` bound to a different profile returns `422` `SMSMessagingProfileSenderBound`.",
2864
+ description: "The messaging profile that supplies this message's sender and defaults. Without `from`, Bird sends from the profile's sender for the destination country, or its default sender. An omitted `category` on a free-text send, `smart_encoding`, `cost_center`, `validity_period`, `options.callback_url` and `options.ignore_suppression` take the profile's settings, and values set on the message take precedence. A built-in template sends from Bird's system sender and ignores the profile's senders. A profile that does not exist in this workspace returns `422` `SMSMessagingProfileNotFound`, and a `from` bound to a different profile returns `422` `SMSMessagingProfileSenderBound`.",
2865
2865
  },
2866
2866
  {
2867
2867
  displayName: "Metadata",
@@ -2905,21 +2905,21 @@ exports.birdProperties = [
2905
2905
  name: "smart_encoding",
2906
2906
  type: "boolean",
2907
2907
  default: false,
2908
- description: "Whether to replace characters outside the GSM-7 alphabet with their closest GSM-7 equivalent before sending: typically curly quotes, dashes, ellipses, fullwidth forms, and non-breaking spaces. One such character forces the whole body into `UCS2`, which more than halves the characters that fit in a segment, so replacing them often lowers the segment count and the cost. Disabled by default, because it alters the body you composed. The replacement is all-or-nothing: a body that still holds a character outside the alphabet afterwards, such as an emoji or a non-Latin script, is sent exactly as you supplied it. Read the message back to see what was applied: `text` is the body as sent.",
2908
+ description: "Whether to replace characters outside the GSM-7 alphabet, typically curly quotes, dashes, ellipses, fullwidth forms and non-breaking spaces, with their closest GSM-7 equivalent before sending. One such character forces the whole body into `UCS2`, which more than halves the characters per segment, so replacing them often lowers the segment count and the cost. Off by default, because it alters the body you composed. The replacement is all-or-nothing: a body that still holds a character outside the alphabet, such as an emoji or a non-Latin script, is sent exactly as supplied. The message's `text` on a read is the body as sent.",
2909
2909
  },
2910
2910
  {
2911
2911
  displayName: "Ignore Suppression",
2912
2912
  name: "ignore_suppression",
2913
2913
  type: "boolean",
2914
2914
  default: false,
2915
- description: "Whether to send this message even if the recipient is suppressed for the sender, including after replying STOP. Bird skips every suppression reason and records the flag on the message; communication preferences the recipient revoked still apply. Only `authentication` and `transactional` messages can use it; setting it to `true` on a `marketing` or `service` message returns `422`. Bird must enable it for your workspace first; until then, a message that uses it is refused with `422`. Omit it to use the setting of the messaging profile in `messaging_profile_id`.",
2915
+ description: "Whether to send even if the recipient is suppressed for the sender, including after replying STOP: Bird skips every suppression reason and records the flag on the message, while communication preferences the recipient revoked still apply. Only `authentication` and `transactional` messages take it; `true` on a `marketing` or `service` message returns `422`, as does any use before Bird enables it for your workspace. Omit it to use the setting of the profile in `messaging_profile_id`.",
2916
2916
  },
2917
2917
  {
2918
2918
  displayName: "Callback URL",
2919
2919
  name: "callback_url",
2920
2920
  type: "string",
2921
2921
  default: "",
2922
- description: "An HTTPS URL that receives this message's events instead of your webhook endpoints. It must be a public address: a private, loopback or link-local host returns `422`. Bird fixes the URL when it accepts the message, so later profile changes do not reroute it. Each event is a signed POST, retried on failure, and signed with your workspace callback signing secret, which `rotateWebhookCallbackSigningSecret` creates and returns once. While a URL applies, this message's events skip your plain webhook endpoints, and a failed callback never falls back to them. MCP Events subscriptions and connector endpoints still receive them. The `callback_events` of the messaging profile in `messaging_profile_id` choose which events go to the URL. Omit the field to use the callback URL of that profile; send `null` to send this message's events to your webhook subscriptions.",
2922
+ description: "An HTTPS URL that receives this message's events instead of your webhook endpoints; a private, loopback or link-local host returns `422`. The URL is fixed when Bird accepts the message, so later profile changes do not reroute it. Each event is a POST, retried on failure and signed with your workspace callback signing secret, which `rotateWebhookCallbackSigningSecret` creates and returns once. While the URL applies, the message's events skip your plain webhook endpoints, with no fallback when the callback fails; MCP Events subscriptions and connector endpoints still receive them. The `callback_events` of the profile in `messaging_profile_id` choose which events go to the URL. Omit it to use that profile's callback URL, or send `null` to send the events to your webhook subscriptions.",
2923
2923
  },
2924
2924
  ],
2925
2925
  },
@@ -2937,7 +2937,7 @@ exports.birdProperties = [
2937
2937
  typeOptions: { multipleValues: true },
2938
2938
  placeholder: "Add Tag",
2939
2939
  default: {},
2940
- description: "Structured `{name, value}` labels for filtering and analytics. Tags become first-class query dimensions: filter the list endpoint by tag name, slice analytics by tag, and surface in webhook payloads. Maximum 20 tags per send. Use tags for low-cardinality dimensions (`category`, `experiment_variant`). For arbitrary structured context you do not need as a filter dimension, use `metadata` instead.",
2940
+ description: "Structured `{name, value}` labels, up to 20 per send. You can filter the list endpoint by tag name, slice analytics by tag, and read them in webhook payloads. Use them for low-cardinality dimensions such as `category` or `experiment_variant`, and `metadata` for context you do not filter by.",
2941
2941
  options: [
2942
2942
  {
2943
2943
  displayName: "Tag",
@@ -3033,7 +3033,7 @@ exports.birdProperties = [
3033
3033
  name: "text",
3034
3034
  type: "string",
3035
3035
  default: "",
3036
- description: "Free-text message body. Required unless `template` is supplied (the two are mutually exclusive). At least 1 character, up to a 12-segment cap (roughly 1836 GSM-7 or 804 UCS-2 characters). Bird does not truncate; a body exceeding 12 segments is rejected with a 422. The cap applies to segments because GSM-7 and UCS-2 encodings differ in characters per segment.",
3036
+ description: "Free-text message body, required unless `template` is set; the two are mutually exclusive. From 1 character up to 12 segments, roughly 1836 GSM-7 or 804 UCS-2 characters, since the two encodings fit different numbers of characters in a segment. Bird does not truncate: a longer body returns `422`.",
3037
3037
  },
3038
3038
  {
3039
3039
  displayName: "To Country Code",
@@ -3047,7 +3047,7 @@ exports.birdProperties = [
3047
3047
  name: "validity_period",
3048
3048
  type: "number",
3049
3049
  default: "",
3050
- description: "How long, in seconds (60-172800), the message may wait for delivery, counted from acceptance. Bird does not submit the message to the carrier after this deadline and passes the remaining time to the carrier where the route supports it. A message that misses the deadline before reaching the carrier ends `rejected` or `failed`, not `expired`; `expired` comes only from a carrier report. Omit it to use the validity period of the messaging profile in `messaging_profile_id`, or the carrier's own validity rules when the profile sets none.",
3050
+ description: "How long, in seconds (60-172800), the message may wait for delivery after acceptance. Bird does not submit it to the carrier after that deadline, and passes the remaining time to the carrier where the route supports it. A message that misses the deadline before reaching the carrier ends `rejected` or `failed`; `expired` comes only from a carrier report. Omit it to use the validity period of the profile in `messaging_profile_id`, or the carrier's own rules when the profile sets none.",
3051
3051
  },
3052
3052
  ],
3053
3053
  },
@@ -8787,7 +8787,7 @@ exports.birdProperties = [
8787
8787
  name: "q",
8788
8788
  type: "string",
8789
8789
  default: "",
8790
- description: "Case-insensitive search matching the mailbox's address or display name (substring)",
8790
+ description: "Case-insensitive substring match on the mailbox's `address`, `name`, or `display_name`",
8791
8791
  },
8792
8792
  {
8793
8793
  displayName: "State",
@@ -8823,7 +8823,7 @@ exports.birdProperties = [
8823
8823
  name: "display_name",
8824
8824
  type: "string",
8825
8825
  default: "",
8826
- description: "Display name used as the sender name on mail from this mailbox",
8826
+ description: "Name shown to your team in the dashboard and tools. Defaults to `name` when omitted. When `name` is unset, outgoing mail uses this value as the sender name.",
8827
8827
  },
8828
8828
  {
8829
8829
  displayName: "Domain",
@@ -8868,6 +8868,13 @@ exports.birdProperties = [
8868
8868
  },
8869
8869
  ],
8870
8870
  },
8871
+ {
8872
+ displayName: "Name",
8873
+ name: "name",
8874
+ type: "string",
8875
+ default: "",
8876
+ description: "Sender name shown alongside the address in outgoing mail. Must contain a non-whitespace character and cannot contain carriage returns or line feeds.",
8877
+ },
8871
8878
  {
8872
8879
  displayName: "Receive Policy",
8873
8880
  name: "receive_policy",
@@ -8956,7 +8963,7 @@ exports.birdProperties = [
8956
8963
  name: "display_name",
8957
8964
  type: "string",
8958
8965
  default: "",
8959
- description: "Display name used as the sender name on mail from this mailbox. `null` clears it.",
8966
+ description: "Name shown to your team in the dashboard and tools. `null` clears the override and uses `name`. When `name` is unset, outgoing mail uses this value as the sender name.",
8960
8967
  },
8961
8968
  {
8962
8969
  displayName: "Metadata",
@@ -8987,6 +8994,13 @@ exports.birdProperties = [
8987
8994
  },
8988
8995
  ],
8989
8996
  },
8997
+ {
8998
+ displayName: "Name",
8999
+ name: "name",
9000
+ type: "string",
9001
+ default: "",
9002
+ description: "Sender name shown alongside the address in outgoing mail. Must contain a non-whitespace character and cannot contain carriage returns or line feeds. `null` clears it.",
9003
+ },
8990
9004
  {
8991
9005
  displayName: "Receive Policy",
8992
9006
  name: "receive_policy",
@@ -9582,18 +9596,27 @@ exports.birdProperties = [
9582
9596
  description: "Filter to conversations linked to a specific contact",
9583
9597
  },
9584
9598
  {
9585
- displayName: "Has Unread",
9586
- name: "has_unread",
9587
- type: "boolean",
9588
- default: false,
9589
- description: "Whether only conversations with unread messages are returned. This filters on the conversation's unread state, so you can combine it with `label`, for example to get unread conversations in the archive. The `unread` label itself lives on individual messages; this filter uses the conversation's aggregate unread state.",
9599
+ displayName: "Folder",
9600
+ name: "folder",
9601
+ type: "options",
9602
+ options: [
9603
+ { name: "Archive", value: "archive" },
9604
+ { name: "Blocked", value: "blocked" },
9605
+ { name: "Inbox", value: "inbox" },
9606
+ { name: "Not Set", value: "" },
9607
+ { name: "Sent", value: "sent" },
9608
+ { name: "Spam", value: "spam" },
9609
+ { name: "Trash", value: "trash" },
9610
+ ],
9611
+ default: "",
9612
+ description: "Filter to a folder. Defaults to inbox when neither folder nor custom labels are supplied.",
9590
9613
  },
9591
9614
  {
9592
- displayName: "Label",
9593
- name: "label",
9615
+ displayName: "Labels",
9616
+ name: "labels",
9594
9617
  type: "string",
9595
9618
  default: "",
9596
- description: "Filter to conversations that have this label. Separate values with a comma to ask for more than one: only conversations that have every label you list are returned. A placement label picks a folder: `inbox`, `archive`, `spam`, or `blocked`. A custom label matches a conversation in any folder. Leave this out and you get the inbox.",
9619
+ description: "Match every listed custom label. Repeat labels to supply more than one. System label names are refused. Separate multiple values with a comma.",
9597
9620
  },
9598
9621
  {
9599
9622
  displayName: "Mailbox ID",
@@ -9609,6 +9632,18 @@ exports.birdProperties = [
9609
9632
  default: "",
9610
9633
  description: "Conversations involving this address, matching the sender or any recipient. The match is case-insensitive and matches on any part of the address, so a fragment works as well as the whole address.",
9611
9634
  },
9635
+ {
9636
+ displayName: "Read State",
9637
+ name: "read_state",
9638
+ type: "options",
9639
+ options: [
9640
+ { name: "Not Set", value: "" },
9641
+ { name: "Read", value: "read" },
9642
+ { name: "Unread", value: "unread" },
9643
+ ],
9644
+ default: "",
9645
+ description: "Filter to read or unread conversations. Omit for either state.",
9646
+ },
9612
9647
  {
9613
9648
  displayName: "Subject",
9614
9649
  name: "subject",
@@ -9672,13 +9707,33 @@ exports.birdProperties = [
9672
9707
  default: {},
9673
9708
  displayOptions: { show: { resource: ["email"], operation: ["threads_update"] } },
9674
9709
  options: [
9710
+ {
9711
+ displayName: "Read",
9712
+ name: "read",
9713
+ type: "boolean",
9714
+ default: false,
9715
+ description: "Whether to mark all retained received messages read or unread. Includes trash, spam and blocked messages; unread_count continues to exclude them.",
9716
+ },
9717
+ {
9718
+ displayName: "Folder",
9719
+ name: "folder",
9720
+ type: "options",
9721
+ options: [
9722
+ { name: "Not Set", value: "" },
9723
+ { name: "Inbox", value: "inbox" },
9724
+ { name: "Archive", value: "archive" },
9725
+ { name: "Spam", value: "spam" },
9726
+ ],
9727
+ default: "",
9728
+ description: "Move a non-trashed conversation to inbox, archive or spam. Use DELETE to trash it and POST restore to recover it. Blocked and sent folders are assigned automatically.",
9729
+ },
9675
9730
  {
9676
9731
  displayName: "Labels",
9677
9732
  name: "labels",
9678
9733
  type: "collection",
9679
9734
  placeholder: "Add Field",
9680
9735
  default: {},
9681
- description: "Label changes to apply. Labels in `add` are applied and labels in `remove` are taken off; other labels are left untouched. Adding a label that is already present, or removing one that is not, has no effect. System labels express state changes. On a conversation, adding `spam` files it as spam. Adding `archive` files it away without deleting it. Adding `inbox`, or removing `spam`, `blocked`, or `archive`, returns it to the inbox. Removing `unread` marks all retained received messages as read in one call. On a message, adding or removing `unread` flips read state. Adding or removing `trash` moves it to or out of the trash. The API rejects changes that contradict this model. A request cannot add more than one placement label. It cannot add `blocked`, because blocking a sender is a receive-rule decision. Removing `inbox` requires adding a destination. A conversation cannot add `trash` or `unread`; removing `unread` is the mark-all-read shortcut, and `trash` uses the `DELETE` verb. A message cannot use placement labels; move its conversation instead. A sent message cannot use `unread`. Custom labels are 1-64 characters with no commas, control characters, or leading or trailing whitespace. System label names and a small reserved set (`all`, `archived`, `deleted`, `draft`, `drafts`, `flagged`, `important`, `junk`, `muted`, `none`, `outbox`, `pinned`, `read`, `scheduled`, `snoozed`, `starred`) cannot be used as custom labels, in any casing. A conversation or message has at most 20 labels, system labels included.",
9736
+ description: "Custom labels to add or remove. System and reserved names are refused; use read and folder for thread state. The resulting custom-label set must contain at most 20 labels; larger sets return 422.",
9682
9737
  options: [
9683
9738
  {
9684
9739
  displayName: "Add",
@@ -10015,6 +10070,13 @@ exports.birdProperties = [
10015
10070
  },
10016
10071
  ],
10017
10072
  },
10073
+ {
10074
+ displayName: "Bcc",
10075
+ name: "bcc",
10076
+ type: "string",
10077
+ default: "",
10078
+ description: "Blind-copy recipients. Addresses already on the derived To or merged Cc line are dropped (case-insensitive). Bcc addresses are omitted from conversation participants, visible recipient headers, and the 202 response. Bcc delivery outcomes are excluded from the message's `recipients` list. Separate multiple values with a comma.",
10079
+ },
10018
10080
  {
10019
10081
  displayName: "Cancel On Reply",
10020
10082
  name: "cancel_on_reply",
@@ -10034,6 +10096,13 @@ exports.birdProperties = [
10034
10096
  default: "",
10035
10097
  description: "Content classification, which controls suppression policy: - `marketing`: Blocks on all suppression reasons. - `transactional`: Allows delivery through complaint and unsubscribe suppressions, for receipts, password resets, and similar operational mail.",
10036
10098
  },
10099
+ {
10100
+ displayName: "Cc",
10101
+ name: "cc",
10102
+ type: "string",
10103
+ default: "",
10104
+ description: "Additional Cc recipients, merged with recipients derived by `reply_all`. Addresses already on the derived To line are dropped (case-insensitive). The merged Cc set must contain at most 50 addresses; larger sets return 422. Separate multiple values with a comma.",
10105
+ },
10037
10106
  {
10038
10107
  displayName: "Html",
10039
10108
  name: "html",
@@ -10743,7 +10812,7 @@ exports.birdProperties = [
10743
10812
  type: "collection",
10744
10813
  placeholder: "Add Field",
10745
10814
  default: {},
10746
- description: "Label changes to apply. Labels in `add` are applied and labels in `remove` are taken off; other labels are left untouched. Adding a label that is already present, or removing one that is not, has no effect. System labels express state changes. On a conversation, adding `spam` files it as spam. Adding `archive` files it away without deleting it. Adding `inbox`, or removing `spam`, `blocked`, or `archive`, returns it to the inbox. Removing `unread` marks all retained received messages as read in one call. On a message, adding or removing `unread` flips read state. Adding or removing `trash` moves it to or out of the trash. The API rejects changes that contradict this model. A request cannot add more than one placement label. It cannot add `blocked`, because blocking a sender is a receive-rule decision. Removing `inbox` requires adding a destination. A conversation cannot add `trash` or `unread`; removing `unread` is the mark-all-read shortcut, and `trash` uses the `DELETE` verb. A message cannot use placement labels; move its conversation instead. A sent message cannot use `unread`. Custom labels are 1-64 characters with no commas, control characters, or leading or trailing whitespace. System label names and a small reserved set (`all`, `archived`, `deleted`, `draft`, `drafts`, `flagged`, `important`, `junk`, `muted`, `none`, `outbox`, `pinned`, `read`, `scheduled`, `snoozed`, `starred`) cannot be used as custom labels, in any casing. A conversation or message has at most 20 labels, system labels included.",
10815
+ description: "Label changes to apply. Labels in `add` are applied and labels in `remove` are taken off; other labels are left untouched. Adding a label that is already present, or removing one that is not, has no effect. On a message, adding or removing `unread` flips read state. Adding or removing `trash` moves it to or out of the trash. Placement labels cannot be applied to a message; use `folder` on [Update a thread](/docs/api/reference/update-email-thread) (`PATCH /v1/email/threads/{thread_id}`) to move its conversation. A sent message cannot use unread. Custom labels are 1-64 characters with no commas, control characters, or leading or trailing whitespace. System label names and a small reserved set (`all`, `archived`, `deleted`, `draft`, `drafts`, `flagged`, `important`, `junk`, `muted`, `none`, `outbox`, `pinned`, `read`, `scheduled`, `snoozed`, `starred`) cannot be used as custom labels, in any casing. A conversation or message has at most 20 labels, system labels included.",
10747
10816
  options: [
10748
10817
  {
10749
10818
  displayName: "Add",
@@ -137,9 +137,9 @@ exports.birdRoutes = {
137
137
  "audiences:remove_contacts": { method: "POST", path: "/v1/audiences/{audience_id}/contacts/remove", pathParams: ["audience_id"], topLevel: ["audience_id", "contact_ids"], collections: ["additionalFields"], query: [], body: ["contact_ids"], jsonFields: [], structured: {}, renames: {}, arrayFields: ["contact_ids"], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["email_marketing"] },
138
138
  "audiences:remove_contact": { method: "DELETE", path: "/v1/audiences/{audience_id}/contacts/{contact_id}", pathParams: ["audience_id", "contact_id"], topLevel: ["audience_id", "contact_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["email_marketing"] },
139
139
  "email:mailboxes_list": { method: "GET", path: "/v1/email/mailboxes", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["address", "q", "state", "domain", "include_deleted", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["mailbox"] },
140
- "email:mailboxes_create": { method: "POST", path: "/v1/email/mailboxes", pathParams: [], topLevel: [], collections: ["additionalFields"], query: [], body: ["local_part", "domain", "display_name", "default_reply_to", "receive_policy", "retention_tier", "metadata"], jsonFields: [], structured: { "metadata": "map" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox_management"] },
140
+ "email:mailboxes_create": { method: "POST", path: "/v1/email/mailboxes", pathParams: [], topLevel: [], collections: ["additionalFields"], query: [], body: ["local_part", "domain", "name", "display_name", "default_reply_to", "receive_policy", "retention_tier", "metadata"], jsonFields: [], structured: { "metadata": "map" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox_management"] },
141
141
  "email:mailboxes_get": { method: "GET", path: "/v1/email/mailboxes/{mailbox_id}", pathParams: ["mailbox_id"], topLevel: ["mailbox_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["mailbox"] },
142
- "email:mailboxes_update": { method: "PATCH", path: "/v1/email/mailboxes/{mailbox_id}", pathParams: ["mailbox_id"], topLevel: ["mailbox_id"], collections: ["updateFields"], query: ["confirm"], body: ["display_name", "default_reply_to", "receive_policy", "retention_tier", "metadata"], jsonFields: [], structured: { "metadata": "map" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: ["display_name", "default_reply_to"], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox_management"] },
142
+ "email:mailboxes_update": { method: "PATCH", path: "/v1/email/mailboxes/{mailbox_id}", pathParams: ["mailbox_id"], topLevel: ["mailbox_id"], collections: ["updateFields"], query: ["confirm"], body: ["name", "display_name", "default_reply_to", "receive_policy", "retention_tier", "metadata"], jsonFields: [], structured: { "metadata": "map" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: ["name", "display_name", "default_reply_to"], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox_management"] },
143
143
  "email:mailboxes_delete": { method: "DELETE", path: "/v1/email/mailboxes/{mailbox_id}", pathParams: ["mailbox_id"], topLevel: ["mailbox_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox_management"] },
144
144
  "email:mailboxes_restore": { method: "POST", path: "/v1/email/mailboxes/{mailbox_id}/restore", pathParams: ["mailbox_id"], topLevel: ["mailbox_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox_management"] },
145
145
  "email:mailboxes_resume": { method: "POST", path: "/v1/email/mailboxes/{mailbox_id}/resume", pathParams: ["mailbox_id"], topLevel: ["mailbox_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox_management"] },
@@ -150,14 +150,14 @@ exports.birdRoutes = {
150
150
  "email:mailboxes_receive_rules_list": { method: "GET", path: "/v1/email/mailboxes/{mailbox_id}/receive-rules", pathParams: ["mailbox_id"], topLevel: ["mailbox_id"], collections: ["additionalFields"], query: ["action", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["mailbox_management"] },
151
151
  "email:mailboxes_receive_rules_create": { method: "POST", path: "/v1/email/mailboxes/{mailbox_id}/receive-rules", pathParams: ["mailbox_id"], topLevel: ["mailbox_id", "action", "entry"], collections: ["additionalFields"], query: [], body: ["action", "entry", "note"], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox_management"] },
152
152
  "email:mailboxes_receive_rules_delete": { method: "DELETE", path: "/v1/email/mailboxes/{mailbox_id}/receive-rules/{rule_id}", pathParams: ["mailbox_id", "rule_id"], topLevel: ["mailbox_id", "rule_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox_management"] },
153
- "email:threads_list": { method: "GET", path: "/v1/email/threads", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["mailbox_id", "contact_id", "label", "has_unread", "participant", "subject", "after", "before", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["label"], dateTimeFields: ["after", "before"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["mailbox"] },
153
+ "email:threads_list": { method: "GET", path: "/v1/email/threads", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["mailbox_id", "contact_id", "folder", "read_state", "labels", "participant", "subject", "after", "before", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["labels"], dateTimeFields: ["after", "before"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["mailbox"] },
154
154
  "email:threads_get": { method: "GET", path: "/v1/email/threads/{thread_id}", pathParams: ["thread_id"], topLevel: ["thread_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["mailbox"] },
155
- "email:threads_update": { method: "PATCH", path: "/v1/email/threads/{thread_id}", pathParams: ["thread_id"], topLevel: ["thread_id"], collections: ["updateFields"], query: [], body: ["labels", "contact_id"], jsonFields: [], structured: { "labels": "struct" }, renames: {}, arrayFields: ["labels.add", "labels.remove"], dateTimeFields: [], nullableFields: ["contact_id"], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox"] },
155
+ "email:threads_update": { method: "PATCH", path: "/v1/email/threads/{thread_id}", pathParams: ["thread_id"], topLevel: ["thread_id"], collections: ["updateFields"], query: [], body: ["read", "folder", "labels", "contact_id"], jsonFields: [], structured: { "labels": "struct" }, renames: {}, arrayFields: ["labels.add", "labels.remove"], dateTimeFields: [], nullableFields: ["contact_id"], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox"] },
156
156
  "email:threads_delete": { method: "DELETE", path: "/v1/email/threads/{thread_id}", pathParams: ["thread_id"], topLevel: ["thread_id"], collections: ["additionalFields"], query: ["permanent"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox"] },
157
157
  "email:threads_messages_list": { method: "GET", path: "/v1/email/threads/{thread_id}/messages", pathParams: ["thread_id"], topLevel: ["thread_id"], collections: ["additionalFields"], query: ["direction", "label", "include", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["mailbox"] },
158
158
  "email:threads_messages_get": { method: "GET", path: "/v1/email/threads/{thread_id}/messages/{message_id}", pathParams: ["thread_id", "message_id"], topLevel: ["thread_id", "message_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["mailbox"] },
159
159
  "email:threads_messages_body": { method: "GET", path: "/v1/email/threads/{thread_id}/messages/{message_id}/body", pathParams: ["thread_id", "message_id"], topLevel: ["thread_id", "message_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["mailbox"] },
160
- "email:threads_messages_reply": { method: "POST", path: "/v1/email/threads/{thread_id}/messages/{message_id}/reply", pathParams: ["thread_id", "message_id"], topLevel: ["thread_id", "message_id"], collections: ["additionalFields"], query: [], body: ["scheduled_at", "html", "text", "reply_all", "tags", "metadata", "category", "attachments", "cancel_on_reply"], jsonFields: [], structured: { "tags": "list", "metadata": "map", "attachments": "list" }, renames: {}, arrayFields: [], dateTimeFields: ["scheduled_at"], nullableFields: [], binaryFields: ["attachments"], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox"] },
160
+ "email:threads_messages_reply": { method: "POST", path: "/v1/email/threads/{thread_id}/messages/{message_id}/reply", pathParams: ["thread_id", "message_id"], topLevel: ["thread_id", "message_id"], collections: ["additionalFields"], query: [], body: ["scheduled_at", "html", "text", "cc", "bcc", "reply_all", "tags", "metadata", "category", "attachments", "cancel_on_reply"], jsonFields: [], structured: { "tags": "list", "metadata": "map", "attachments": "list" }, renames: {}, arrayFields: ["cc", "bcc"], dateTimeFields: ["scheduled_at"], nullableFields: [], binaryFields: ["attachments"], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox"] },
161
161
  "email:threads_messages_attachments": { method: "GET", path: "/v1/email/threads/{thread_id}/messages/{message_id}/attachments", pathParams: ["thread_id", "message_id"], topLevel: ["thread_id", "message_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["mailbox"] },
162
162
  "email:content": { method: "GET", path: "/v1/email/messages/{message_id}/content", pathParams: ["message_id"], topLevel: ["message_id"], collections: ["additionalFields"], query: ["recipient_id"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["emails"] },
163
163
  "email:recipients": { method: "GET", path: "/v1/email/messages/{message_id}/recipients", pathParams: ["message_id"], topLevel: ["message_id"], collections: ["additionalFields"], query: ["limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@messagebird/n8n-nodes-bird",
3
- "version": "0.39.0",
3
+ "version": "0.41.0",
4
4
  "description": "The official Bird node for n8n: email, SMS, WhatsApp, and verification, plus a webhook trigger for Bird events.",
5
5
  "license": "MIT",
6
6
  "author": {