/resend-messaging | Type: Application | PCID required: Yes
Tools
resend_messaging_delete_automations_by_automation_id
Delete an automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
automation_id | string | Yes | — | The ID of the automation. |
resend_messaging_delete_broadcasts_by_id
Remove an existing broadcast that is in the draft status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Broadcast ID. |
resend_messaging_delete_events_by_identifier
Delete an event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
identifier | string | Yes | — | The event ID (UUID) or event name. |
resend_messaging_delete_templates_by_id
Remove an existing template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Template ID or alias. |
resend_messaging_get_automations
Retrieve a list of automations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | No | — | Filter automations by status. |
limit | integer | No | — | Number of items to return. |
after | string | No | — | Return items after this cursor. |
before | string | No | — | Return items before this cursor. |
resend_messaging_get_automations_by_automation_id
Retrieve a single automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
automation_id | string | Yes | — | The ID of the automation. |
resend_messaging_get_automations_by_automation_id_runs
Retrieve a list of automation runs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
automation_id | string | Yes | — | The ID of the automation. |
status | string | No | — | Filter runs by status. Comma-separated list of: running, completed, failed, cancelled. |
limit | integer | No | — | Number of items to return. |
after | string | No | — | Return items after this cursor. |
before | string | No | — | Return items before this cursor. |
resend_messaging_get_automations_by_automation_id_runs_by_run_id
Retrieve a single automation run Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
automation_id | string | Yes | — | The ID of the automation. |
run_id | string | Yes | — | The ID of the automation run. |
resend_messaging_get_broadcasts
Retrieve a list of broadcasts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of items to return. |
after | string | No | — | Return items after this cursor. |
before | string | No | — | Return items before this cursor. |
resend_messaging_get_broadcasts_by_id
Retrieve a single broadcast Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Broadcast ID. |
resend_messaging_get_emails
Retrieve a list of emails Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of items to return. |
after | string | No | — | Return items after this cursor. |
before | string | No | — | Return items before this cursor. |
resend_messaging_get_emails_by_email_id
Retrieve a single email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_id | string | Yes | — | The ID of the email. |
resend_messaging_get_emails_by_email_id_attachments
Retrieve a list of attachments for a sent email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_id | string | Yes | — | The ID of the email. |
limit | integer | No | — | Maximum number of attachments to return. |
after | string | No | — | Pagination cursor to fetch results after this attachment ID. Cannot be used with ‘before’. |
before | string | No | — | Pagination cursor to fetch results before this attachment ID. Cannot be used with ‘after’. |
resend_messaging_get_emails_by_email_id_attachments_by_attachment_id
Retrieve a single attachment for a sent email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_id | string | Yes | — | The ID of the email. |
attachment_id | string | Yes | — | The ID of the attachment. |
resend_messaging_get_emails_receiving
Retrieve a list of received emails Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Maximum number of received emails to return. |
after | string | No | — | Pagination cursor to fetch results after this email ID. Cannot be used with ‘before’. |
before | string | No | — | Pagination cursor to fetch results before this email ID. Cannot be used with ‘after’. |
resend_messaging_get_emails_receiving_by_email_id
Retrieve a single received email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_id | string | Yes | — | The ID of the received email. |
resend_messaging_get_emails_receiving_by_email_id_attachments
Retrieve a list of attachments for a received email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_id | string | Yes | — | The ID of the received email. |
limit | integer | No | — | Maximum number of attachments to return. |
after | string | No | — | Pagination cursor to fetch results after this attachment ID. Cannot be used with ‘before’. |
before | string | No | — | Pagination cursor to fetch results before this attachment ID. Cannot be used with ‘after’. |
resend_messaging_get_emails_receiving_by_email_id_attachments_by_attachment_id
Retrieve a single attachment for a received email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_id | string | Yes | — | The ID of the received email. |
attachment_id | string | Yes | — | The ID of the attachment. |
resend_messaging_get_events
Retrieve a list of events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of items to return. |
after | string | No | — | Return items after this cursor. |
before | string | No | — | Return items before this cursor. |
resend_messaging_get_events_by_identifier
Retrieve a single event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
identifier | string | Yes | — | The event ID (UUID) or event name. |
resend_messaging_get_logs
Retrieve a list of logs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of items to return. |
after | string | No | — | Return items after this cursor. |
before | string | No | — | Return items before this cursor. |
resend_messaging_get_logs_by_log_id
Retrieve a single log Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
log_id | string | Yes | — | The ID of the log. |
resend_messaging_get_templates
Retrieve a list of templates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of items to return. |
after | string | No | — | Return items after this cursor. |
before | string | No | — | Return items before this cursor. |
resend_messaging_get_templates_by_id
Retrieve a single template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Template ID or alias. |
resend_messaging_patch_automations_by_automation_id
Update an automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
automation_id | string | Yes | — | The ID of the automation. |
connections | object[] | No | — | The connections between steps in the automation graph. Must be provided together with steps. |
name | string | No | — | The name of the automation. |
status | string | No | — | The status of the automation. |
steps | object[] | No | — | The steps that compose the automation workflow. Must be provided together with connections. |
resend_messaging_patch_broadcasts_by_id
Update an existing broadcast Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Broadcast ID. |
audience_id | string | No | — | Use segment_id instead. Unique identifier of the audience this broadcast will be sent to. |
from | string | No | — | The email address of the sender. |
html | string | No | — | The HTML version of the message. |
name | string | No | — | Name of the broadcast. |
preview_text | string | No | — | The preview text of the email. |
reply_to | string[] | No | — | The email addresses to which replies should be sent. |
segment_id | string | No | — | Unique identifier of the segment this broadcast will be sent to. |
subject | string | No | — | The subject line of the email. |
text | string | No | — | The plain text version of the message. |
topic_id | string | No | — | The topic ID that the broadcast will be scoped to. |
resend_messaging_patch_emails_by_email_id
Update a single email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_id | string | Yes | — | The ID of the email. |
scheduled_at | string | Yes | — | Schedule email to be sent later. The date should be in ISO 8601 format. |
resend_messaging_patch_events_by_identifier
Update an event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
identifier | string | Yes | — | The event ID (UUID) or event name. |
schema | object | Yes | — | A flat key/type map defining the event payload schema. Set to null to clear the schema. Supported types are string, number, boolean, and date. |
resend_messaging_patch_templates_by_id
Update an existing template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Template ID or alias. |
alias | string | No | — | The alias of the template. |
from | string | No | — | Sender email address. To include a friendly name, use the format “Your Name <sender@domain.com>”. |
html | string | No | — | The HTML version of the template. |
name | string | No | — | The name of the template. |
reply_to | string[] | No | — | Reply-to email addresses. |
subject | string | No | — | Email subject. |
text | string | No | — | The plain text version of the template. |
variables | object[] | No | — | The variables value |
resend_messaging_post_automations
Create an automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
connections | object[] | Yes | — | The connections between steps in the automation graph. |
name | string | Yes | — | The name of the automation. |
status | string | No | — | The initial status of the automation. Defaults to disabled. |
steps | object[] | Yes | — | The steps that compose the automation workflow. Must include at least one trigger step. |
resend_messaging_post_automations_by_automation_id_stop
Stop an automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
automation_id | string | Yes | — | The ID of the automation. |
resend_messaging_post_broadcasts
Create a broadcast Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
audience_id | string | No | — | Use segment_id instead. Unique identifier of the segment this broadcast will be sent to. |
from | string | Yes | — | The email address of the sender. |
html | string | No | — | The HTML version of the message. |
name | string | No | — | Name of the broadcast. |
preview_text | string | No | — | The preview text of the email. |
reply_to | string[] | No | — | The email addresses to which replies should be sent. |
scheduled_at | string | No | — | Schedule time to send the broadcast. Can only be used if send is true. |
segment_id | string | Yes | — | Unique identifier of the segment this broadcast will be sent to. |
send | boolean | No | — | Whether to send the broadcast immediately or keep it as a draft. |
subject | string | Yes | — | The subject line of the email. |
text | string | No | — | The plain text version of the message. |
topic_id | string | No | — | The topic ID that the broadcast will be scoped to. |
resend_messaging_post_broadcasts_by_id_send
Send or schedule a broadcast Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Broadcast ID. |
scheduled_at | string | No | — | Schedule email to be sent later. The date should be in ISO 8601 format. |
resend_messaging_post_emails
Send an email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
attachments | object[] | No | — | The attachments value |
bcc | string[] | No | — | Bcc recipient email address. For multiple addresses, send as an array of strings. |
cc | string[] | No | — | Cc recipient email address. For multiple addresses, send as an array of strings. |
from | string | Yes | — | Sender email address. To include a friendly name, use the format “Your Name <sender@domain.com>”. |
headers | object | No | — | Custom headers to add to the email. |
html | string | No | — | The HTML version of the message. |
reply_to | string[] | No | — | Reply-to email address. For multiple addresses, send as an array of strings. |
scheduled_at | string | No | — | Schedule email to be sent later. The date should be in ISO 8601 format. |
subject | string | Yes | — | Email subject. |
tags | object[] | No | — | The tags value |
template | object | No | — | The template value |
text | string | No | — | The plain text version of the message. |
to | string[] | Yes | — | Recipient email address. For multiple addresses, send as an array of strings. Max 50. |
topic_id | string | No | — | The topic ID to scope the email to. If the recipient is a contact and opted-in to the topic, the email is sent. If opted-out, the email is not sent. If the recipient is not a contact, the email is sent if the topic’s default subscription is opt_in. |
resend_messaging_post_emails_batch
Trigger up to 100 batch emails at once. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object[] | No | — | Request body |
resend_messaging_post_emails_by_email_id_cancel
Cancel the schedule of the e-mail. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_id | string | Yes | — | The ID of the email. |
resend_messaging_post_events
Create an event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The name of the event. Cannot start with the reserved resend: prefix. |
schema | object | No | — | An optional flat key/type map defining the event payload schema. Supported types are string, number, boolean, and date. |
resend_messaging_post_events_send
Send an event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contact_id | string | No | — | The ID of the contact to associate with this event. Exactly one of contact_id or email must be provided. |
email | string | No | — | The email address to associate with this event. Exactly one of contact_id or email must be provided. |
event | string | Yes | — | The name of the event to send. |
payload | object | No | — | An optional payload of key/value pairs to include with the event. |
resend_messaging_post_templates
Create a template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
alias | string | No | — | The alias of the template. |
from | string | No | — | Sender email address. To include a friendly name, use the format “Your Name <sender@domain.com>”. |
html | string | Yes | — | The HTML version of the template. |
name | string | Yes | — | The name of the template. |
reply_to | string[] | No | — | Reply-to email addresses. |
subject | string | No | — | Email subject. |
text | string | No | — | The plain text version of the template. |
variables | object[] | No | — | The variables value |
resend_messaging_post_templates_by_id_duplicate
Duplicate a template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Template ID or alias. |
resend_messaging_post_templates_by_id_publish
Publish a template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Template ID or alias. |

