sendgrid-automation

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

SendGrid Automation via Rube MCP

通过Rube MCP实现SendGrid自动化

Automate SendGrid email delivery workflows including marketing campaigns (Single Sends), contact and list management, sender identity setup, and email analytics through Composio's SendGrid toolkit.
通过Composio的SendGrid工具包自动化SendGrid邮件交付工作流,包括营销活动(单次发送)、联系人与列表管理、发件人身份设置及邮件数据分析。

Prerequisites

前提条件

  • Rube MCP must be connected (RUBE_SEARCH_TOOLS available)
  • Active SendGrid connection via
    RUBE_MANAGE_CONNECTIONS
    with toolkit
    sendgrid
  • Always call
    RUBE_SEARCH_TOOLS
    first to get current tool schemas
  • 必须已连接Rube MCP(需提供RUBE_SEARCH_TOOLS)
  • 已通过
    RUBE_MANAGE_CONNECTIONS
    连接活跃的SendGrid,工具包为
    sendgrid
  • 请始终先调用
    RUBE_SEARCH_TOOLS
    获取最新的工具架构

Setup

设置步骤

Get Rube MCP: Add
https://rube.app/mcp
as an MCP server in your client configuration. No API keys needed — just add the endpoint and it works.
  1. Verify Rube MCP is available by confirming
    RUBE_SEARCH_TOOLS
    responds
  2. Call
    RUBE_MANAGE_CONNECTIONS
    with toolkit
    sendgrid
  3. If connection is not ACTIVE, follow the returned auth link to complete SendGrid API key authentication
  4. Confirm connection status shows ACTIVE before running any workflows
获取Rube MCP:在客户端配置中添加
https://rube.app/mcp
作为MCP服务器。无需API密钥 —— 只需添加端点即可使用。
  1. 确认
    RUBE_SEARCH_TOOLS
    可响应,以此验证Rube MCP是否可用
  2. 调用
    RUBE_MANAGE_CONNECTIONS
    ,工具包指定为
    sendgrid
  3. 如果连接状态不是ACTIVE,请按照返回的认证链接完成SendGrid API密钥认证
  4. 在运行任何工作流之前,确认连接状态显示为ACTIVE

Core Workflows

核心工作流

1. Create and Send Marketing Campaigns (Single Sends)

1. 创建并发送营销活动(单次发送)

When to use: User wants to create and send a marketing email campaign to a contact list or segment.
Tool sequence:
  1. SENDGRID_RETRIEVE_ALL_LISTS
    - List available marketing lists to target [Prerequisite]
  2. SENDGRID_CREATE_A_LIST
    - Create a new list if needed [Optional]
  3. SENDGRID_ADD_OR_UPDATE_A_CONTACT
    - Add contacts to the list [Optional]
  4. SENDGRID_GET_ALL_SENDER_IDENTITIES
    - Get verified sender ID [Prerequisite]
  5. SENDGRID_CREATE_SINGLE_SEND
    - Create the campaign with content, sender, and recipients [Required]
Key parameters for SENDGRID_CREATE_SINGLE_SEND:
  • name
    : Campaign name (required)
  • email__config__subject
    : Email subject line
  • email__config__html__content
    : HTML body content
  • email__config__plain__content
    : Plain text version
  • email__config__sender__id
    : Verified sender identity ID
  • email__config__design__id
    : Use instead of html_content for pre-built designs
  • send__to__list__ids
    : Array of list UUIDs to send to
  • send__to__segment__ids
    : Array of segment UUIDs
  • send__to__all
    : true to send to all contacts
  • email__config__suppression__group__id
    or
    email__config__custom__unsubscribe__url
    : One required for compliance
Pitfalls:
  • Setting
    send_at
    on CREATE does NOT schedule the send; it only prepopulates the UI date; use the Schedule endpoint separately
  • send_at: "now"
    is only valid with the Schedule endpoint, not CREATE
  • Must provide either
    suppression_group_id
    or
    custom_unsubscribe_url
    for unsubscribe compliance
  • Sender must be verified before use; check with
    SENDGRID_GET_ALL_SENDER_IDENTITIES
  • Nested params use double-underscore notation (e.g.,
    email__config__subject
    )
适用场景:用户需要创建并向联系人列表或细分群体发送营销邮件活动。
工具执行顺序
  1. SENDGRID_RETRIEVE_ALL_LISTS
    - 列出可用的营销目标列表 [前提步骤]
  2. SENDGRID_CREATE_A_LIST
    - 按需创建新列表 [可选]
  3. SENDGRID_ADD_OR_UPDATE_A_CONTACT
    - 向列表中添加联系人 [可选]
  4. SENDGRID_GET_ALL_SENDER_IDENTITIES
    - 获取已验证的发件人ID [前提步骤]
  5. SENDGRID_CREATE_SINGLE_SEND
    - 创建包含内容、发件人和收件人的活动 [必填]
SENDGRID_CREATE_SINGLE_SEND关键参数
  • name
    : 活动名称(必填)
  • email__config__subject
    : 邮件主题
  • email__config__html__content
    : HTML邮件正文
  • email__config__plain__content
    : 纯文本版本
  • email__config__sender__id
    : 已验证的发件人身份ID
  • email__config__design__id
    : 若使用预构建模板,可替代html_content
  • send__to__list__ids
    : 目标列表UUID数组
  • send__to__segment__ids
    : 目标细分群体UUID数组
  • send__to__all
    : 设置为true则发送给所有联系人
  • email__config__suppression__group__id
    email__config__custom__unsubscribe__url
    : 合规要求二选一
注意事项
  • 在CREATE操作中设置
    send_at
    不会调度发送;仅会填充UI日期,需单独使用Schedule端点
  • send_at: "now"
    仅在Schedule端点有效,CREATE操作不支持
  • 必须提供
    suppression_group_id
    custom_unsubscribe_url
    以满足退订合规要求
  • 发件人必须先验证才能使用;可通过
    SENDGRID_GET_ALL_SENDER_IDENTITIES
    检查
  • 嵌套参数使用双下划线表示(例如:
    email__config__subject

2. Manage Contacts and Lists

2. 管理联系人与列表

When to use: User wants to create contact lists, add/update contacts, search for contacts, or remove contacts from lists.
Tool sequence:
  1. SENDGRID_RETRIEVE_ALL_LISTS
    - List all marketing lists [Required]
  2. SENDGRID_CREATE_A_LIST
    - Create a new contact list [Optional]
  3. SENDGRID_GET_A_LIST_BY_ID
    - Get list details and sample contacts [Optional]
  4. SENDGRID_ADD_OR_UPDATE_A_CONTACT
    - Upsert contacts with list association [Required]
  5. SENDGRID_GET_CONTACTS_BY_EMAILS
    - Look up contacts by email [Optional]
  6. SENDGRID_GET_CONTACTS_BY_IDENTIFIERS
    - Look up contacts by email, phone, or external ID [Optional]
  7. SENDGRID_GET_LIST_CONTACT_COUNT
    - Verify contact count after operations [Optional]
  8. SENDGRID_REMOVE_CONTACTS_FROM_A_LIST
    - Remove contacts from a list without deleting [Optional]
  9. SENDGRID_REMOVE_LIST_AND_OPTIONAL_CONTACTS
    - Delete an entire list [Optional]
  10. SENDGRID_IMPORT_CONTACTS
    - Bulk import from CSV [Optional]
Key parameters for SENDGRID_ADD_OR_UPDATE_A_CONTACT:
  • contacts
    : Array of contact objects (max 30,000 or 6MB), each with at least one identifier:
    email
    ,
    phone_number_id
    ,
    external_id
    , or
    anonymous_id
    (required)
  • list_ids
    : Array of list UUID strings to associate contacts with
Pitfalls:
  • SENDGRID_ADD_OR_UPDATE_A_CONTACT
    is asynchronous; returns 202 with
    job_id
    ; contacts may take 10-30 seconds to appear
  • List IDs are UUIDs (e.g., "ca7a3796-e8a8-4029-9ccb-df8937940562"), not integers
  • List names must be unique; duplicate names cause 400 errors
  • SENDGRID_ADD_A_SINGLE_RECIPIENT_TO_A_LIST
    uses the legacy API; prefer
    SENDGRID_ADD_OR_UPDATE_A_CONTACT
    with
    list_ids
  • SENDGRID_REMOVE_LIST_AND_OPTIONAL_CONTACTS
    is irreversible; require explicit user confirmation
  • Email addresses are automatically lowercased by SendGrid
适用场景:用户需要创建联系人列表、添加/更新联系人、搜索联系人或从列表中移除联系人。
工具执行顺序
  1. SENDGRID_RETRIEVE_ALL_LISTS
    - 列出所有营销列表 [必填]
  2. SENDGRID_CREATE_A_LIST
    - 创建新联系人列表 [可选]
  3. SENDGRID_GET_A_LIST_BY_ID
    - 获取列表详情及联系人样本 [可选]
  4. SENDGRID_ADD_OR_UPDATE_A_CONTACT
    - 批量插入/更新联系人并关联列表 [必填]
  5. SENDGRID_GET_CONTACTS_BY_EMAILS
    - 通过邮箱查找联系人 [可选]
  6. SENDGRID_GET_CONTACTS_BY_IDENTIFIERS
    - 通过邮箱、电话或外部ID查找联系人 [可选]
  7. SENDGRID_GET_LIST_CONTACT_COUNT
    - 操作后验证联系人数量 [可选]
  8. SENDGRID_REMOVE_CONTACTS_FROM_A_LIST
    - 从列表中移除联系人但不删除 [可选]
  9. SENDGRID_REMOVE_LIST_AND_OPTIONAL_CONTACTS
    - 删除整个列表 [可选]
  10. SENDGRID_IMPORT_CONTACTS
    - 从CSV批量导入联系人 [可选]
SENDGRID_ADD_OR_UPDATE_A_CONTACT关键参数
  • contacts
    : 联系人对象数组(最多30,000个或6MB),每个对象至少包含一个标识符:
    email
    phone_number_id
    external_id
    anonymous_id
    (必填)
  • list_ids
    : 联系人需关联的列表UUID字符串数组
注意事项
  • SENDGRID_ADD_OR_UPDATE_A_CONTACT
    为异步操作;返回202状态码及
    job_id
    ;联系人可能需要10-30秒才会显示
  • 列表ID为UUID格式(例如:"ca7a3796-e8a8-4029-9ccb-df8937940562"),而非整数
  • 列表名称必须唯一;重复名称会导致400错误
  • SENDGRID_ADD_A_SINGLE_RECIPIENT_TO_A_LIST
    使用旧版API;优先使用带
    list_ids
    参数的
    SENDGRID_ADD_OR_UPDATE_A_CONTACT
  • SENDGRID_REMOVE_LIST_AND_OPTIONAL_CONTACTS
    操作不可逆;需用户明确确认
  • SendGrid会自动将邮箱地址转换为小写

3. Manage Sender Identities

3. 管理发件人身份

When to use: User wants to set up or view sender identities (From addresses) for sending emails.
Tool sequence:
  1. SENDGRID_GET_ALL_SENDER_IDENTITIES
    - List all existing sender identities [Required]
  2. SENDGRID_CREATE_A_SENDER_IDENTITY
    - Create a new sender identity [Optional]
  3. SENDGRID_VIEW_A_SENDER_IDENTITY
    - View details for a specific sender [Optional]
  4. SENDGRID_UPDATE_A_SENDER_IDENTITY
    - Update sender details [Optional]
  5. SENDGRID_CREATE_VERIFIED_SENDER_REQUEST
    - Create and verify a new sender [Optional]
  6. SENDGRID_AUTHENTICATE_A_DOMAIN
    - Set up domain authentication for auto-verification [Optional]
Key parameters for SENDGRID_CREATE_A_SENDER_IDENTITY:
  • from__email
    : From email address (required)
  • from__name
    : Display name (required)
  • reply__to__email
    : Reply-to address (required)
  • nickname
    : Internal identifier (required)
  • address
    ,
    city
    ,
    country
    : Physical address for CAN-SPAM compliance (required)
Pitfalls:
  • New senders must be verified before use; if domain is not authenticated, a verification email is sent
  • Up to 100 unique sender identities per account
  • Avoid using domains with strict DMARC policies (gmail.com, yahoo.com) as from addresses
  • SENDGRID_CREATE_VERIFIED_SENDER_REQUEST
    sends a verification email; sender is unusable until verified
适用场景:用户需要设置或查看用于发送邮件的发件人身份(发件地址)。
工具执行顺序
  1. SENDGRID_GET_ALL_SENDER_IDENTITIES
    - 列出所有现有发件人身份 [必填]
  2. SENDGRID_CREATE_A_SENDER_IDENTITY
    - 创建新的发件人身份 [可选]
  3. SENDGRID_VIEW_A_SENDER_IDENTITY
    - 查看特定发件人的详情 [可选]
  4. SENDGRID_UPDATE_A_SENDER_IDENTITY
    - 更新发件人详情 [可选]
  5. SENDGRID_CREATE_VERIFIED_SENDER_REQUEST
    - 创建并验证新的发件人 [可选]
  6. SENDGRID_AUTHENTICATE_A_DOMAIN
    - 设置域名认证以实现自动验证 [可选]
SENDGRID_CREATE_A_SENDER_IDENTITY关键参数
  • from__email
    : 发件邮箱地址(必填)
  • from__name
    : 显示名称(必填)
  • reply__to__email
    : 回复邮箱地址(必填)
  • nickname
    : 内部标识符(必填)
  • address
    ,
    city
    ,
    country
    : 符合CAN-SPAM合规要求的物理地址(必填)
注意事项
  • 新的发件人必须先验证才能使用;若域名未认证,系统会发送验证邮件
  • 每个账户最多支持100个唯一的发件人身份
  • 避免使用带有严格DMARC策略的域名(如gmail.com、yahoo.com)作为发件地址
  • SENDGRID_CREATE_VERIFIED_SENDER_REQUEST
    会发送验证邮件;发件人在验证完成前无法使用

4. View Email Statistics and Activity

4. 查看邮件统计与活动记录

When to use: User wants to review email delivery stats, bounce rates, open/click metrics, or message activity.
Tool sequence:
  1. SENDGRID_RETRIEVE_GLOBAL_EMAIL_STATISTICS
    - Get account-wide delivery metrics [Required]
  2. SENDGRID_GET_ALL_CATEGORIES
    - Discover available categories for filtering [Optional]
  3. SENDGRID_RETRIEVE_EMAIL_STATISTICS_FOR_CATEGORIES
    - Get stats broken down by category [Optional]
  4. SENDGRID_FILTER_ALL_MESSAGES
    - Search email activity feed by recipient, status, or date [Optional]
  5. SENDGRID_FILTER_MESSAGES_BY_MESSAGE_ID
    - Get detailed events for a specific message [Optional]
  6. SENDGRID_REQUEST_CSV
    - Export activity data as CSV for large datasets [Optional]
  7. SENDGRID_DOWNLOAD_CSV
    - Download the exported CSV file [Optional]
Key parameters for SENDGRID_RETRIEVE_GLOBAL_EMAIL_STATISTICS:
  • start_date
    : Start date YYYY-MM-DD (required)
  • end_date
    : End date YYYY-MM-DD
  • aggregated_by
    : "day", "week", or "month"
  • limit
    /
    offset
    : Pagination (default 500)
Key parameters for SENDGRID_FILTER_ALL_MESSAGES:
  • query
    : SQL-like query string, e.g.,
    status="delivered"
    ,
    to_email="user@example.com"
    , date ranges with
    BETWEEN TIMESTAMP
  • limit
    : 1-1000 (default 10)
Pitfalls:
  • SENDGRID_FILTER_ALL_MESSAGES
    requires the "30 Days Additional Email Activity History" paid add-on; returns 403 without it
  • Global statistics are nested under
    details[].stats[0].metrics
    , not a flat structure
  • Category statistics are only available for the previous 13 months
  • Maximum 10 categories per request in
    SENDGRID_RETRIEVE_EMAIL_STATISTICS_FOR_CATEGORIES
  • CSV export is limited to one request per 12 hours; link expires after 3 days
适用场景:用户需要查看邮件交付统计、退信率、打开/点击指标或消息活动记录。
工具执行顺序
  1. SENDGRID_RETRIEVE_GLOBAL_EMAIL_STATISTICS
    - 获取账户级别的交付指标 [必填]
  2. SENDGRID_GET_ALL_CATEGORIES
    - 查看可用于筛选的分类 [可选]
  3. SENDGRID_RETRIEVE_EMAIL_STATISTICS_FOR_CATEGORIES
    - 获取按分类拆分的统计数据 [可选]
  4. SENDGRID_FILTER_ALL_MESSAGES
    - 按收件人、状态或日期搜索邮件活动记录 [可选]
  5. SENDGRID_FILTER_MESSAGES_BY_MESSAGE_ID
    - 获取特定消息的详细事件记录 [可选]
  6. SENDGRID_REQUEST_CSV
    - 将活动数据导出为CSV格式(适用于大型数据集)[可选]
  7. SENDGRID_DOWNLOAD_CSV
    - 下载导出的CSV文件 [可选]
SENDGRID_RETRIEVE_GLOBAL_EMAIL_STATISTICS关键参数
  • start_date
    : 开始日期(格式YYYY-MM-DD,必填)
  • end_date
    : 结束日期(格式YYYY-MM-DD)
  • aggregated_by
    : 聚合维度,可选"day"、"week"或"month"
  • limit
    /
    offset
    : 分页参数(默认500条)
SENDGRID_FILTER_ALL_MESSAGES关键参数
  • query
    : SQL风格的查询字符串,例如
    status="delivered"
    to_email="user@example.com"
    ,日期范围使用
    BETWEEN TIMESTAMP
  • limit
    : 1-1000条(默认10条)
注意事项
  • SENDGRID_FILTER_ALL_MESSAGES
    需要付费附加功能“30天额外邮件活动历史”;若无此功能会返回403错误
  • 全局统计数据嵌套在
    details[].stats[0].metrics
    下,并非扁平结构
  • 分类统计数据仅可查询过去13个月的记录
  • SENDGRID_RETRIEVE_EMAIL_STATISTICS_FOR_CATEGORIES
    每次请求最多支持10个分类
  • CSV导出限制为每12小时一次;下载链接3天后过期

5. Manage Suppressions

5. 管理退订列表

When to use: User wants to check or manage unsubscribe groups for email compliance.
Tool sequence:
  1. SENDGRID_GET_SUPPRESSION_GROUPS
    - List all suppression groups [Required]
  2. SENDGRID_RETRIEVE_ALL_SUPPRESSION_GROUPS_FOR_AN_EMAIL_ADDRESS
    - Check suppression status for a specific email [Optional]
Pitfalls:
  • Suppressed addresses remain undeliverable even if present on marketing lists
  • Campaign send counts may be lower than list counts due to suppressions
适用场景:用户需要检查或管理用于邮件合规的退订组。
工具执行顺序
  1. SENDGRID_GET_SUPPRESSION_GROUPS
    - 列出所有退订组 [必填]
  2. SENDGRID_RETRIEVE_ALL_SUPPRESSION_GROUPS_FOR_AN_EMAIL_ADDRESS
    - 检查特定邮箱的退订状态 [可选]
注意事项
  • 已退订的地址即使在营销列表中也无法收到邮件
  • 由于退订原因,活动实际发送数量可能低于列表中的联系人数量

Common Patterns

通用模式

ID Resolution

ID解析

Always resolve names to IDs before operations:
  • List name -> list_id:
    SENDGRID_RETRIEVE_ALL_LISTS
    and match by name
  • Sender name -> sender_id:
    SENDGRID_GET_ALL_SENDER_IDENTITIES
    and match
  • Contact email -> contact_id:
    SENDGRID_GET_CONTACTS_BY_EMAILS
    with email array
  • Template name -> template_id: Use the SendGrid UI or template endpoints
在执行操作前,务必将名称解析为对应的ID:
  • 列表名称 -> list_id: 使用
    SENDGRID_RETRIEVE_ALL_LISTS
    并按名称匹配
  • 发件人名称 -> sender_id: 使用
    SENDGRID_GET_ALL_SENDER_IDENTITIES
    并匹配
  • 联系人邮箱 -> contact_id: 使用
    SENDGRID_GET_CONTACTS_BY_EMAILS
    并传入邮箱数组
  • 模板名称 -> template_id: 使用SendGrid UI或模板端点获取

Pagination

分页

  • SENDGRID_RETRIEVE_ALL_LISTS
    : Token-based with
    page_token
    and
    page_size
    (max 1000)
  • SENDGRID_RETRIEVE_GLOBAL_EMAIL_STATISTICS
    : Offset-based with
    limit
    (max 500) and
    offset
  • Always paginate list retrieval to avoid missing existing lists
  • SENDGRID_RETRIEVE_ALL_LISTS
    : 基于令牌的分页,参数为
    page_token
    page_size
    (最大1000条)
  • SENDGRID_RETRIEVE_GLOBAL_EMAIL_STATISTICS
    : 基于偏移量的分页,参数为
    limit
    (最大500条)和
    offset
  • 检索列表时务必使用分页,避免遗漏现有列表

Async Operations

异步操作

Contact operations (
ADD_OR_UPDATE_A_CONTACT
,
IMPORT_CONTACTS
) are asynchronous:
  • Returns 202 with a
    job_id
  • Wait 10-30 seconds before verifying with
    GET_CONTACTS_BY_EMAILS
  • Use
    GET_LIST_CONTACT_COUNT
    to confirm list growth
联系人操作(
ADD_OR_UPDATE_A_CONTACT
IMPORT_CONTACTS
)为异步操作:
  • 返回202状态码及
    job_id
  • 等待10-30秒后,使用
    GET_CONTACTS_BY_EMAILS
    验证操作结果
  • 使用
    GET_LIST_CONTACT_COUNT
    确认列表联系人数量增长

Known Pitfalls

已知注意事项

ID Formats

ID格式

  • Marketing list IDs are UUIDs (e.g., "ca7a3796-e8a8-4029-9ccb-df8937940562")
  • Legacy list IDs are integers; do not mix with Marketing API endpoints
  • Sender identity IDs are integers
  • Template IDs: Dynamic templates start with "d-", legacy templates are UUIDs
  • Contact IDs are UUIDs
  • 营销列表ID为UUID格式(例如:"ca7a3796-e8a8-4029-9ccb-df8937940562")
  • 旧版列表ID为整数;请勿与营销API端点混用
  • 发件人身份ID为整数
  • 模板ID:动态模板以"d-"开头,旧版模板为UUID格式
  • 联系人ID为UUID格式

Rate Limits

速率限制

  • SendGrid may return HTTP 429; respect
    Retry-After
    headers
  • CSV export limited to one request per 12 hours
  • Bulk contact upsert max: 30,000 contacts or 6MB per request
  • SendGrid可能返回HTTP 429错误;请遵循
    Retry-After
    响应头的指示
  • CSV导出限制为每12小时一次
  • 批量联系人插入/更新上限:每次请求最多30,000个联系人或6MB数据

Parameter Quirks

参数特殊说明

  • Nested params use double-underscore:
    email__config__subject
    ,
    from__email
  • send_at
    on CREATE_SINGLE_SEND only sets a UI default, does NOT schedule
  • SENDGRID_ADD_A_SINGLE_RECIPIENT_TO_A_LIST
    uses legacy API;
    recipient_id
    is Base64-encoded lowercase email
  • SENDGRID_RETRIEVE_ALL_LISTS
    and
    SENDGRID_GET_ALL_LISTS
    both exist; prefer RETRIEVE_ALL_LISTS for Marketing API
  • Contact adds are async (202); always verify after a delay
  • 嵌套参数使用双下划线:
    email__config__subject
    from__email
  • CREATE_SINGLE_SEND中的
    send_at
    仅设置UI默认值,不会实际调度发送
  • SENDGRID_ADD_A_SINGLE_RECIPIENT_TO_A_LIST
    使用旧版API;
    recipient_id
    为Base64编码的小写邮箱
  • 同时存在
    SENDGRID_RETRIEVE_ALL_LISTS
    SENDGRID_GET_ALL_LISTS
    ;优先使用RETRIEVE_ALL_LISTS(营销API)
  • 联系人添加为异步操作(返回202);务必延迟后验证结果

Legacy vs Marketing API

旧版API vs 营销API

  • Some tools use the legacy Contact Database API (
    /v3/contactdb/
    ) which may return 403 on newer accounts
  • Prefer Marketing API tools:
    SENDGRID_ADD_OR_UPDATE_A_CONTACT
    ,
    SENDGRID_RETRIEVE_ALL_LISTS
    ,
    SENDGRID_CREATE_SINGLE_SEND
  • 部分工具使用旧版联系人数据库API(
    /v3/contactdb/
    ),在新账户上可能返回403错误
  • 优先使用营销API工具:
    SENDGRID_ADD_OR_UPDATE_A_CONTACT
    SENDGRID_RETRIEVE_ALL_LISTS
    SENDGRID_CREATE_SINGLE_SEND

Quick Reference

快速参考

TaskTool SlugKey Params
List marketing lists
SENDGRID_RETRIEVE_ALL_LISTS
page_size
,
page_token
Create list
SENDGRID_CREATE_A_LIST
name
Get list by ID
SENDGRID_GET_A_LIST_BY_ID
id
Get list count
SENDGRID_GET_LIST_CONTACT_COUNT
id
Add/update contacts
SENDGRID_ADD_OR_UPDATE_A_CONTACT
contacts
,
list_ids
Search contacts by email
SENDGRID_GET_CONTACTS_BY_EMAILS
emails
Search by identifiers
SENDGRID_GET_CONTACTS_BY_IDENTIFIERS
identifier_type
,
identifiers
Remove from list
SENDGRID_REMOVE_CONTACTS_FROM_A_LIST
id
,
contact_ids
Delete list
SENDGRID_REMOVE_LIST_AND_OPTIONAL_CONTACTS
id
,
delete_contacts
Import contacts CSV
SENDGRID_IMPORT_CONTACTS
field mappings
Create Single Send
SENDGRID_CREATE_SINGLE_SEND
name
,
email__config__*
,
send__to__list__ids
List sender identities
SENDGRID_GET_ALL_SENDER_IDENTITIES
(none)
Create sender
SENDGRID_CREATE_A_SENDER_IDENTITY
from__email
,
from__name
,
address
Verify sender
SENDGRID_CREATE_VERIFIED_SENDER_REQUEST
from_email
,
nickname
,
address
Authenticate domain
SENDGRID_AUTHENTICATE_A_DOMAIN
domain
Global email stats
SENDGRID_RETRIEVE_GLOBAL_EMAIL_STATISTICS
start_date
,
aggregated_by
Category stats
SENDGRID_RETRIEVE_EMAIL_STATISTICS_FOR_CATEGORIES
start_date
,
categories
Filter email activity
SENDGRID_FILTER_ALL_MESSAGES
query
,
limit
Message details
SENDGRID_FILTER_MESSAGES_BY_MESSAGE_ID
msg_id
Export CSV
SENDGRID_REQUEST_CSV
query
Download CSV
SENDGRID_DOWNLOAD_CSV
download_uuid
List categories
SENDGRID_GET_ALL_CATEGORIES
(none)
Suppression groups
SENDGRID_GET_SUPPRESSION_GROUPS
(none)
Get template
SENDGRID_RETRIEVE_A_SINGLE_TRANSACTIONAL_TEMPLATE
template_id
Duplicate template
SENDGRID_DUPLICATE_A_TRANSACTIONAL_TEMPLATE
template_id
,
name
任务工具标识关键参数
列出营销列表
SENDGRID_RETRIEVE_ALL_LISTS
page_size
,
page_token
创建列表
SENDGRID_CREATE_A_LIST
name
通过ID获取列表
SENDGRID_GET_A_LIST_BY_ID
id
获取列表联系人数量
SENDGRID_GET_LIST_CONTACT_COUNT
id
添加/更新联系人
SENDGRID_ADD_OR_UPDATE_A_CONTACT
contacts
,
list_ids
通过邮箱搜索联系人
SENDGRID_GET_CONTACTS_BY_EMAILS
emails
通过标识符搜索联系人
SENDGRID_GET_CONTACTS_BY_IDENTIFIERS
identifier_type
,
identifiers
从列表移除联系人
SENDGRID_REMOVE_CONTACTS_FROM_A_LIST
id
,
contact_ids
删除列表
SENDGRID_REMOVE_LIST_AND_OPTIONAL_CONTACTS
id
,
delete_contacts
CSV导入联系人
SENDGRID_IMPORT_CONTACTS
字段映射
创建单次发送活动
SENDGRID_CREATE_SINGLE_SEND
name
,
email__config__*
,
send__to__list__ids
列出发件人身份
SENDGRID_GET_ALL_SENDER_IDENTITIES
创建发件人
SENDGRID_CREATE_A_SENDER_IDENTITY
from__email
,
from__name
,
address
验证发件人
SENDGRID_CREATE_VERIFIED_SENDER_REQUEST
from_email
,
nickname
,
address
域名认证
SENDGRID_AUTHENTICATE_A_DOMAIN
domain
全局邮件统计
SENDGRID_RETRIEVE_GLOBAL_EMAIL_STATISTICS
start_date
,
aggregated_by
分类统计
SENDGRID_RETRIEVE_EMAIL_STATISTICS_FOR_CATEGORIES
start_date
,
categories
筛选邮件活动
SENDGRID_FILTER_ALL_MESSAGES
query
,
limit
消息详情
SENDGRID_FILTER_MESSAGES_BY_MESSAGE_ID
msg_id
导出CSV
SENDGRID_REQUEST_CSV
query
下载CSV
SENDGRID_DOWNLOAD_CSV
download_uuid
列出分类
SENDGRID_GET_ALL_CATEGORIES
退订组
SENDGRID_GET_SUPPRESSION_GROUPS
获取模板
SENDGRID_RETRIEVE_A_SINGLE_TRANSACTIONAL_TEMPLATE
template_id
复制模板
SENDGRID_DUPLICATE_A_TRANSACTIONAL_TEMPLATE
template_id
,
name