Official Resend API for transactional email, domains, contacts, broadcasts, templates, webhooks and inboxes. Each command makes one request using your API key.
Example workflows
Copy a prompt into your connected AI client after connecting this integration. Choose resources you can access and review the supported command before running it.
Retrieve a list of emails
Help me with this task in Resend: Retrieve a list of emails. Ask me for any required inputs and confirm the resources and scope before calling the command. Read one response page. Turn the returned data into a concise working summary with original IDs, dates and source links when available. Separate missing information from confirmed results and tell me whether more pages remain. Do not invent fields or change data.
Explore this command: resend.emails.list
Retrieve a single email
Help me with this task in Resend: Retrieve a single email. Ask me for any required inputs and confirm the resources and scope before calling the command. Read one response page. Turn the returned data into a concise working summary with original IDs, dates and source links when available. Separate missing information from confirmed results and tell me whether more pages remain. Do not invent fields or change data.
Explore this command: resend.emails.get
What you can do (137)
What you can do
Available commands: 137 (60 read, 77 write). Enable only the commands your application needs.
| Command | Effect |
|---|---|
Send an email — resend.emails.send |
Write |
Retrieve a list of emails — resend.emails.list |
Read |
Retrieve a single email — resend.emails.get |
Read |
Update a single email — resend.emails.update |
Write |
Cancel the schedule of the e-mail. — resend.emails.cancel |
Write |
Create a shareable link for a sent or received email. — resend.emails.share |
Write |
Trigger up to 100 batch emails at once. — resend.emails.send-batch |
Write |
Retrieve a list of attachments for a sent email — resend.emails.list-attachments |
Read |
Retrieve a single attachment for a sent email — resend.emails.get-attachment |
Read |
Retrieve a list of received emails — resend.emails.list-receiving |
Read |
Retrieve a single received email — resend.emails.get-receiving |
Read |
Retrieve a list of attachments for a received email — resend.emails.list-receiving-attachments |
Read |
Retrieve a single attachment for a received email — resend.emails.get-receiving-attachment |
Read |
Retrieve account-level email metrics — resend.emails.metrics |
Read |
Create a new domain — resend.domains.create |
Write |
Retrieve a list of domains — resend.domains.list |
Read |
Retrieve a single domain — resend.domains.get |
Read |
Update an existing domain — resend.domains.update |
Write |
Remove an existing domain — resend.domains.remove |
Write |
Verify an existing domain — resend.domains.verify |
Write |
Claim a domain — resend.domains.create-claim |
Write |
Retrieve a domain claim — resend.domains.get-claim |
Read |
Verify a domain claim — resend.domains.verify-claim |
Write |
Create a new API key — resend.api-keys.create |
Write |
Retrieve a list of API keys — resend.api-keys.list |
Read |
Update an existing API key — resend.api-keys.update |
Write |
Remove an existing API key — resend.api-keys.remove |
Write |
Retrieve a list of OAuth grants — resend.oauth.list-grants |
Read |
Revoke an OAuth grant — resend.oauth.revoke-grant |
Write |
Create a template — resend.templates.create |
Write |
Retrieve a list of templates — resend.templates.list |
Read |
Retrieve a single template — resend.templates.get |
Read |
Update an existing template — resend.templates.update |
Write |
Remove an existing template — resend.templates.remove |
Write |
Publish a template — resend.templates.publish |
Write |
Duplicate a template — resend.templates.duplicate |
Write |
Create a new contact — resend.contacts.create |
Write |
Retrieve a list of contacts — resend.contacts.list |
Read |
Retrieve a list of contact imports — resend.contacts.list-imports |
Read |
Retrieve a single contact import — resend.contacts.get-import |
Read |
Retrieve a single contact by ID or email — resend.contacts.get |
Read |
Update a single contact by ID or email — resend.contacts.update |
Write |
Remove an existing contact by ID or email — resend.contacts.remove |
Write |
Create a broadcast — resend.broadcasts.create |
Write |
Retrieve a list of broadcasts — resend.broadcasts.list |
Read |
Remove an existing broadcast that is in the draft status — resend.broadcasts.remove |
Write |
Retrieve a single broadcast — resend.broadcasts.get |
Read |
Update an existing broadcast — resend.broadcasts.update |
Write |
Send or schedule a broadcast — resend.broadcasts.send |
Write |
Cancel a broadcast — resend.broadcasts.cancel |
Write |
Duplicate a broadcast — resend.broadcasts.duplicate |
Write |
Retrieve broadcast recipients — resend.broadcasts.recipients |
Read |
Retrieve a broadcast's clicked links — resend.broadcasts.list-clicked-links |
Read |
Create a new webhook — resend.webhooks.create |
Write |
Retrieve a list of webhooks — resend.webhooks.list |
Read |
Retrieve a single webhook — resend.webhooks.get |
Read |
Update an existing webhook — resend.webhooks.update |
Write |
Remove an existing webhook — resend.webhooks.remove |
Write |
Rotate a webhook signing secret — resend.webhooks.rotate-signing-secret |
Write |
Retrieve a list of webhook events — resend.webhooks.list-events |
Read |
Retrieve a single webhook event — resend.webhooks.get-event |
Read |
Replay a webhook event — resend.webhooks.replay-event |
Write |
Retrieve a list of webhook event attempts — resend.webhooks.list-event-attempts |
Read |
Create a new segment — resend.segments.create |
Write |
Retrieve a list of segments — resend.segments.list |
Read |
Retrieve a single segment — resend.segments.get |
Read |
Update an existing segment — resend.segments.update |
Write |
Remove an existing segment — resend.segments.remove |
Write |
Retrieve a list of contacts in a segment — resend.segments.list-contacts |
Read |
Create a new topic — resend.topics.create |
Write |
Retrieve a list of topics — resend.topics.list |
Read |
Retrieve a single topic — resend.topics.get |
Read |
Update an existing topic — resend.topics.update |
Write |
Remove an existing topic — resend.topics.remove |
Write |
Create a new contact property — resend.contact-properties.create |
Write |
Retrieve a list of contact properties — resend.contact-properties.list |
Read |
Retrieve a single contact property — resend.contact-properties.get |
Read |
Update an existing contact property — resend.contact-properties.update |
Write |
Remove an existing contact property — resend.contact-properties.remove |
Write |
Retrieve a list of segments for a contact — resend.contacts.list-segments |
Read |
Add a contact to a segment — resend.contacts.add-segment |
Write |
Remove a contact from a segment — resend.contacts.remove-segment |
Write |
Retrieve topics for a contact — resend.contacts.list-topics |
Read |
Update topics for a contact — resend.contacts.update-topics |
Write |
Retrieve a list of logs — resend.logs.list |
Read |
Retrieve a single log — resend.logs.get |
Read |
Create an automation — resend.automations.create |
Write |
Retrieve a list of automations — resend.automations.list |
Read |
Retrieve a single automation — resend.automations.get |
Read |
Update an automation — resend.automations.update |
Write |
Delete an automation — resend.automations.remove |
Write |
Duplicate an automation — resend.automations.duplicate |
Write |
Stop an automation — resend.automations.stop |
Write |
Retrieve a list of automation runs — resend.automations.list-runs |
Read |
Retrieve a single automation run — resend.automations.get-run |
Read |
Create an event — resend.events.create |
Write |
Retrieve a list of events — resend.events.list |
Read |
Send an event — resend.events.send |
Write |
Retrieve a single event — resend.events.get |
Read |
Update an event — resend.events.update |
Write |
Delete an event — resend.events.remove |
Write |
Create a suppression — resend.suppressions.add |
Write |
Retrieve a list of suppressions — resend.suppressions.list |
Read |
Add up to 100 suppressions at once — resend.suppressions.batch-add |
Write |
Remove up to 100 suppressions at once — resend.suppressions.batch-remove |
Write |
Retrieve a single suppression by ID or email — resend.suppressions.get |
Read |
Remove a single suppression by ID or email — resend.suppressions.remove |
Write |
Retrieve account usage — resend.usage.get |
Read |
Create an inbox — resend.inboxes.create |
Write |
Retrieve a list of inboxes — resend.inboxes.list |
Read |
Retrieve a single inbox by ID or email address — resend.inboxes.get |
Read |
Update an existing inbox by ID or email address — resend.inboxes.update |
Write |
Remove an existing inbox by ID or email address — resend.inboxes.remove |
Write |
Retrieve the agent settings for an inbox — resend.inboxes.get-agent |
Read |
Update the agent settings for an inbox — resend.inboxes.update-agent |
Write |
Retrieve a list of inbox labels — resend.inboxes.list-labels |
Read |
Create a label on an inbox — resend.inboxes.create-label |
Write |
Update an existing inbox label — resend.inboxes.update-label |
Write |
Remove an existing inbox label — resend.inboxes.remove-label |
Write |
Retrieve a list of inbox threads — resend.inboxes.list-threads |
Read |
Search the threads of an inbox — resend.inboxes.search-threads |
Read |
Retrieve a single inbox thread — resend.inboxes.get-thread |
Read |
Update an existing inbox thread — resend.inboxes.update-thread |
Write |
Remove an existing inbox thread — resend.inboxes.remove-thread |
Write |
Add labels to an inbox thread — resend.inboxes.add-thread-labels |
Write |
Set the labels of an inbox thread — resend.inboxes.set-thread-labels |
Write |
Remove a label from an inbox thread — resend.inboxes.remove-thread-label |
Write |
Retrieve a list of thread emails — resend.inboxes.list-thread-emails |
Read |
Retrieve a single thread email — resend.inboxes.get-thread-email |
Read |
Reply to a thread email — resend.inboxes.reply-thread-email |
Write |
Forward a thread email — resend.inboxes.forward-thread-email |
Write |
Retrieve a list of drafts — resend.inboxes.list-drafts |
Read |
Create a draft — resend.inboxes.create-draft |
Write |
Retrieve a single draft — resend.inboxes.get-draft |
Read |
Update an existing draft — resend.inboxes.update-draft |
Write |
Remove an existing draft — resend.inboxes.remove-draft |
Write |
Send a draft — resend.inboxes.send-draft |
Write |
Connect and use
This connection uses your provider account.
Connect this integration, enter your provider credentials, choose commands and save. Complete provider authorization if prompted.
Get your provider credentials
Follow these steps for Resend, then enter the issued values in the connection form below.
- In the Resend dashboard, open API Keys → Create API Key. Choose Sending access for sending-only commands or Full access for the administration commands you need, and restrict domains where supported. Paste the key into this connection’s Resend API key field. Verify your sending domain before sending to real recipients; account testing restrictions still apply. Enable commands and create a Tooluse.net API key. Use an explicit Idempotency-Key for email sends; Tooluse.net does not automatically retry them.
Where to enter credentials
In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.
| Connection field | Requirement |
|---|---|
| Resend API key | Required |
Open API keys and create a Tooluse.net key for the enabled commands.
Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.
Configure Claude Code, Codex or Cursor once
Permissions and results
If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.
Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.
Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.
Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.
Call from your client
Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.
Configure Claude Code, Codex or Cursor once
Discover your enabled tools
List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.
curl 'https://api.tooluse.net/v1/tools' \
-H "Authorization: Bearer $TOOLUSE_API_KEY"
Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.
HTTP call
curl 'https://api.tooluse.net/v1/tool-calls' \
-H "Authorization: Bearer $TOOLUSE_API_KEY" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: replace-with-a-new-call-id' \
--data '{
"type": "tool_use",
"id": "toolu_example",
"name": "svc_FROM_YOUR_TOOL_LIST",
"input": {}
}'
Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.
Commands
Send an email — resend.emails.send
Send an email
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Idempotency-Key |
string | Optional | A unique identifier for the request to ensure emails are only sent once. Learn more | maxLength: 256 |
body |
— | Optional | $ref: "#/definitions/SendEmailRequest" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of emails — resend.emails.list
Retrieve a list of emails
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single email — resend.emails.get
Retrieve a single email
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.email_id |
string | Required | The ID of the email. |
Full JSON Schema
Example input
{
"path": {
"email_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a single email — resend.emails.update
Update a single email
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.email_id |
string | Required | The ID of the email. |
Full JSON Schema
Example input
{
"path": {
"email_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Cancel the schedule of the e-mail. — resend.emails.cancel
Cancel the schedule of the e-mail.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.email_id |
string | Required | The ID of the email. |
Full JSON Schema
Example input
{
"path": {
"email_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Trigger up to 100 batch emails at once. — resend.emails.send-batch
Trigger up to 100 batch emails at once.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Idempotency-Key |
string | Optional | A unique identifier for the request to ensure emails are only sent once. Learn more | maxLength: 256 |
body |
array | Optional | ||
body[] |
— | Optional | $ref: "#/definitions/SendEmailRequest" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of attachments for a sent email — resend.emails.list-attachments
Retrieve a list of attachments for a sent email
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.email_id |
string | Required | The ID of the email. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Maximum number of attachments to return. | |
query.after |
string | Optional | Pagination cursor to fetch results after this attachment ID. Cannot be used with 'before'. | format: "uuid" |
query.before |
string | Optional | Pagination cursor to fetch results before this attachment ID. Cannot be used with 'after'. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"email_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single attachment for a sent email — resend.emails.get-attachment
Retrieve a single attachment for a sent email
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.email_id |
string | Required | The ID of the email. | format: "uuid" |
path.attachment_id |
string | Required | The ID of the attachment. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"email_id": "00000000-0000-4000-8000-000000000000",
"attachment_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of received emails — resend.emails.list-receiving
Retrieve a list of received emails
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Maximum number of received emails to return. | |
query.after |
string | Optional | Pagination cursor to fetch results after this email ID. Cannot be used with 'before'. | format: "uuid" |
query.before |
string | Optional | Pagination cursor to fetch results before this email ID. Cannot be used with 'after'. | format: "uuid" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single received email — resend.emails.get-receiving
Retrieve a single received email
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.email_id |
string | Required | The ID of the received email. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"email_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of attachments for a received email — resend.emails.list-receiving-attachments
Retrieve a list of attachments for a received email
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.email_id |
string | Required | The ID of the received email. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Maximum number of attachments to return. | |
query.after |
string | Optional | Pagination cursor to fetch results after this attachment ID. Cannot be used with 'before'. | format: "uuid" |
query.before |
string | Optional | Pagination cursor to fetch results before this attachment ID. Cannot be used with 'after'. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"email_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single attachment for a received email — resend.emails.get-receiving-attachment
Retrieve a single attachment for a received email
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.email_id |
string | Required | The ID of the received email. | format: "uuid" |
path.attachment_id |
string | Required | The ID of the attachment. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"email_id": "00000000-0000-4000-8000-000000000000",
"attachment_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve account-level email metrics — resend.emails.metrics
Retrieve account-level email metrics
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.start_date |
string | Optional | The start of the date range, as an ISO 8601 date or datetime. Must be on or before end_date. Defaults to 6 days before end_date. |
|
query.end_date |
string | Optional | The end of the date range, as an ISO 8601 date or datetime. Values in the future are clamped to the current time. Defaults to now. | |
query.timezone |
string | Optional | The IANA timezone (e.g. America/New_York) used to bucket periods when period is in dimensions. |
default: "UTC" |
query.granularity |
string | Optional | The bucket size used when period is in dimensions. The date range can't produce more than 10,000 periods at the chosen granularity. |
enum: ["hourly","daily","weekly","monthly"]; default: "daily" |
query.metrics |
array | Optional | List of metrics to include in the response. Defaults to all metrics. Accepts a comma-separated value, the parameter repeated, or a mix of both. | |
query.metrics[] |
string | Optional | enum: ["received","delivered","complained","suppressed","bounced","bounced_transient","bounced_permanent","bounced_undetermined","opened","clicked","unsubscribed","delivery_delayed","failed","sent","unique_opened","unique_clicked","delivery_rate","open_rate","click_rate","bounce_rate","complaint_rate","unsubscribe_rate"] |
|
query.dimensions |
array | Optional | List of dimensions to break the response down by. email cannot be combined with broadcast. Defaults to [], returning a single totals row for the whole range, with no data. Accepts a comma-separated value, the parameter repeated, or a mix of both. |
|
query.dimensions[] |
string | Optional | enum: ["period","domain","email","broadcast"] |
|
query.domain_id |
array | Optional | List of sending domain IDs to restrict the response to, up to 100. Accepts a comma-separated value, the parameter repeated, or a mix of both. | |
query.domain_id[] |
string | Optional | format: "uuid" |
|
query.email_id |
array | Optional | List of email IDs to restrict the response to, up to 100. Cannot be combined with the broadcast dimension or broadcast_id. Accepts a comma-separated value, the parameter repeated, or a mix of both. |
|
query.email_id[] |
string | Optional | format: "uuid" |
|
query.broadcast_id |
array | Optional | List of broadcast IDs to restrict the response to, up to 100. Cannot be combined with the email dimension or email_id. Accepts a comma-separated value, the parameter repeated, or a mix of both. |
|
query.broadcast_id[] |
string | Optional | format: "uuid" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a new domain — resend.domains.create
Create a new domain
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/CreateDomainRequest" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of domains — resend.domains.list
Retrieve a list of domains
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single domain — resend.domains.get
Retrieve a single domain
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.domain_id |
string | Required | The ID of the domain. |
Full JSON Schema
Example input
{
"path": {
"domain_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an existing domain — resend.domains.update
Update an existing domain
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.domain_id |
string | Required | The ID of the domain. | |
body |
— | Optional | $ref: "#/definitions/UpdateDomainOptions" |
Full JSON Schema
Example input
{
"path": {
"domain_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove an existing domain — resend.domains.remove
Remove an existing domain
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.domain_id |
string | Required | The ID of the domain. |
Full JSON Schema
Example input
{
"path": {
"domain_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Verify an existing domain — resend.domains.verify
Triggers verification of the domain's DNS records including DKIM, SPF, and the tracking CNAME (if a tracking subdomain is configured).
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.domain_id |
string | Required | The ID of the domain. |
Full JSON Schema
Example input
{
"path": {
"domain_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Claim a domain — resend.domains.create-claim
Start a claim for a domain that another Resend account has already verified. The domain is recreated under your account with fresh DKIM keys, so the previous account's DNS records cannot be reused. Returns a TXT record to add to your DNS to prove ownership. Uses the same request body as creating a domain.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/CreateDomainClaimRequest" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a domain claim — resend.domains.get-claim
Retrieve the latest claim for the placeholder domain created by the claim.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.domain_id |
string | Required | The ID of the placeholder domain created by the claim. |
Full JSON Schema
Example input
{
"path": {
"domain_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Verify a domain claim — resend.domains.verify-claim
Trigger asynchronous DNS verification and ownership transfer for a domain claim. The claim stays pending while verification runs; poll the retrieve endpoint for status. Once completed, the transferred domain has new DKIM records that must be added to DNS and verified via the standard domain verify endpoint.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.domain_id |
string | Required | The ID of the placeholder domain created by the claim. |
Full JSON Schema
Example input
{
"path": {
"domain_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a new API key — resend.api-keys.create
Create a new API key
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/CreateApiKeyRequest" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of API keys — resend.api-keys.list
Retrieve a list of API keys
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an existing API key — resend.api-keys.update
Update an existing API key
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.api_key_id |
string | Required | The API key ID. | |
body |
— | Optional | $ref: "#/definitions/UpdateApiKeyRequest" |
Full JSON Schema
Example input
{
"path": {
"api_key_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove an existing API key — resend.api-keys.remove
Remove an existing API key
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.api_key_id |
string | Required | The API key ID. |
Full JSON Schema
Example input
{
"path": {
"api_key_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of OAuth grants — resend.oauth.list-grants
Retrieve a list of OAuth grants
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Revoke an OAuth grant — resend.oauth.revoke-grant
Revoke an OAuth grant
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.oauth_grant_id |
string | Required | The OAuth grant ID. |
Full JSON Schema
Example input
{
"path": {
"oauth_grant_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a template — resend.templates.create
Create a template
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/CreateTemplateRequest" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of templates — resend.templates.list
Retrieve a list of templates
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single template — resend.templates.get
Retrieve a single template
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Template ID or alias. |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an existing template — resend.templates.update
Update an existing template
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Template ID or alias. | |
body |
— | Optional | $ref: "#/definitions/UpdateTemplateOptions" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove an existing template — resend.templates.remove
Remove an existing template
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Template ID or alias. |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Publish a template — resend.templates.publish
Publish a template
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Template ID or alias. |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Duplicate a template — resend.templates.duplicate
Duplicate a template
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Template ID or alias. |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a new contact — resend.contacts.create
Create a new contact
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/CreateContactOptions" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of contacts — resend.contacts.list
Retrieve a list of contacts
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of contact imports — resend.contacts.list-imports
Retrieve a list of contact imports
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.status |
string | Optional | Filter contact imports by status. | enum: ["queued","in_progress","completed","failed"] |
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single contact import — resend.contacts.get-import
Retrieve a single contact import
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Contact Import ID. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single contact by ID or email — resend.contacts.get
Retrieve a single contact by ID or email
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Contact ID or email address. |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a single contact by ID or email — resend.contacts.update
Update a single contact by ID or email
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Contact ID or email address. | |
body |
— | Optional | $ref: "#/definitions/UpdateContactOptions" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove an existing contact by ID or email — resend.contacts.remove
Remove an existing contact by ID or email
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Contact ID or email address. |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a broadcast — resend.broadcasts.create
Create a broadcast
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/CreateBroadcastOptions" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of broadcasts — resend.broadcasts.list
Retrieve a list of broadcasts
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove an existing broadcast that is in the draft status — resend.broadcasts.remove
Remove an existing broadcast that is in the draft status
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Broadcast ID. |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single broadcast — resend.broadcasts.get
Retrieve a single broadcast
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Broadcast ID. |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an existing broadcast — resend.broadcasts.update
Update an existing broadcast
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Broadcast ID. | |
body |
— | Optional | $ref: "#/definitions/UpdateBroadcastOptions" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Send or schedule a broadcast — resend.broadcasts.send
Send or schedule a broadcast
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Broadcast ID. | |
body |
— | Optional | $ref: "#/definitions/SendBroadcastOptions" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Cancel a broadcast — resend.broadcasts.cancel
Cancels a broadcast that is queued or scheduled. Canceling a queued broadcast stops it mid-send; emails already sent are not affected, but no further emails will go out.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Broadcast ID. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Duplicate a broadcast — resend.broadcasts.duplicate
Creates a new draft broadcast with the same segment, topic, sender, subject, reply-to, preview text, and content as the source. The copy is named after the source with " (copy)" appended, truncated to 70 characters.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Broadcast ID. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve broadcast recipients — resend.broadcasts.recipients
Retrieve the recipients of a broadcast for a given event type, such as who opened, clicked, or bounced.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Broadcast ID. | format: "uuid" |
query |
object | Required | additionalProperties: false |
|
query.type |
string | Required | The recipient event type to filter by. | enum: ["sent","delivered","opened","clicked","bounced","complained","unsubscribed","suppressed"] |
query.email |
string | Optional | Filter recipients whose email address contains this value. | |
query.bounce_type |
string | Optional | Filter bounced recipients by bounce type. Only valid when type is bounced. |
enum: ["permanent","transient","undetermined"] |
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{
"path": {
"id": "00000000-0000-4000-8000-000000000000"
},
"query": {
"type": "sent"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a broadcast's clicked links — resend.broadcasts.list-clicked-links
Retrieve a broadcast's clicked links
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Broadcast ID. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{
"path": {
"id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a new webhook — resend.webhooks.create
Create a new webhook
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/CreateWebhookRequest" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of webhooks — resend.webhooks.list
Retrieve a list of webhooks
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Maximum number of webhooks to return. | |
query.after |
string | Optional | Pagination cursor to fetch results after this webhook ID. Cannot be used with 'before'. | format: "uuid" |
query.before |
string | Optional | Pagination cursor to fetch results before this webhook ID. Cannot be used with 'after'. | format: "uuid" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single webhook — resend.webhooks.get
Retrieve a single webhook
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.webhook_id |
string | Required | The Webhook ID. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"webhook_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an existing webhook — resend.webhooks.update
Update an existing webhook
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.webhook_id |
string | Required | The Webhook ID. | format: "uuid" |
body |
— | Optional | $ref: "#/definitions/UpdateWebhookRequest" |
Full JSON Schema
Example input
{
"path": {
"webhook_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove an existing webhook — resend.webhooks.remove
Remove an existing webhook
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.webhook_id |
string | Required | The Webhook ID. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"webhook_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Rotate a webhook signing secret — resend.webhooks.rotate-signing-secret
Generates a new signing secret for the webhook and returns it. Payloads delivered after the rotation are signed with the new secret. The previous secret keeps verifying payloads for 24 hours, so both secrets are accepted during that window. A webhook that does not exist or was removed returns a 404 not_found.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.webhook_id |
string | Required | The Webhook ID. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"webhook_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of webhook events — resend.webhooks.list-events
Retrieve a list of webhook events
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.webhook_id |
string | Required | The Webhook ID. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. |
Full JSON Schema
Example input
{
"path": {
"webhook_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single webhook event — resend.webhooks.get-event
Retrieve a single webhook event
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.webhook_id |
string | Required | The Webhook ID. | format: "uuid" |
path.event_id |
string | Required | The Webhook Event ID. |
Full JSON Schema
Example input
{
"path": {
"webhook_id": "00000000-0000-4000-8000-000000000000",
"event_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Replay a webhook event — resend.webhooks.replay-event
Queues one more delivery of the event to the webhook. The event must be retrievable through the get event endpoint and the webhook must be enabled; a disabled webhook returns a 422 validation_error. A manual replay does not schedule automatic retries.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.webhook_id |
string | Required | The Webhook ID. | format: "uuid" |
path.event_id |
string | Required | The Webhook Event ID. |
Full JSON Schema
Example input
{
"path": {
"webhook_id": "00000000-0000-4000-8000-000000000000",
"event_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of webhook event attempts — resend.webhooks.list-event-attempts
Retrieve a list of webhook event attempts
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.webhook_id |
string | Required | The Webhook ID. | format: "uuid" |
path.event_id |
string | Required | The Webhook Event ID. | |
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. |
Full JSON Schema
Example input
{
"path": {
"webhook_id": "00000000-0000-4000-8000-000000000000",
"event_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a new segment — resend.segments.create
Create a new segment
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/CreateSegmentOptions" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of segments — resend.segments.list
Retrieve a list of segments
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single segment — resend.segments.get
Retrieve a single segment
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Segment ID. |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an existing segment — resend.segments.update
Update an existing segment
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Segment ID. | |
body |
— | Optional | $ref: "#/definitions/UpdateSegmentOptions" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove an existing segment — resend.segments.remove
Remove an existing segment
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Segment ID. |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of contacts in a segment — resend.segments.list-contacts
Retrieve a list of contacts in a segment
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Segment ID. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{
"path": {
"id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a new topic — resend.topics.create
Create a new topic
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/CreateTopicOptions" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of topics — resend.topics.list
Retrieve a list of topics
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single topic — resend.topics.get
Retrieve a single topic
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Topic ID. |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an existing topic — resend.topics.update
Update an existing topic
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Topic ID. | |
body |
— | Optional | $ref: "#/definitions/UpdateTopicOptions" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove an existing topic — resend.topics.remove
Remove an existing topic
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Topic ID. |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a new contact property — resend.contact-properties.create
Create a new contact property
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/CreateContactPropertyOptions" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of contact properties — resend.contact-properties.list
Retrieve a list of contact properties
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single contact property — resend.contact-properties.get
Retrieve a single contact property
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Contact Property ID. |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an existing contact property — resend.contact-properties.update
Update an existing contact property
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Contact Property ID. | |
body |
— | Optional | $ref: "#/definitions/UpdateContactPropertyOptions" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove an existing contact property — resend.contact-properties.remove
Remove an existing contact property
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Contact Property ID. |
Full JSON Schema
Example input
{
"path": {
"id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of segments for a contact — resend.contacts.list-segments
Retrieve a list of segments for a contact
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | The Contact ID or email address. | |
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{
"path": {
"contact_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a contact to a segment — resend.contacts.add-segment
Add a contact to a segment
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | The Contact ID or email address. | |
path.segment_id |
string | Required | The Segment ID. |
Full JSON Schema
Example input
{
"path": {
"contact_id": "example",
"segment_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a contact from a segment — resend.contacts.remove-segment
Remove a contact from a segment
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | The Contact ID or email address. | |
path.segment_id |
string | Required | The Segment ID. |
Full JSON Schema
Example input
{
"path": {
"contact_id": "example",
"segment_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve topics for a contact — resend.contacts.list-topics
Retrieve topics for a contact
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | The Contact ID or email address. | |
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{
"path": {
"contact_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update topics for a contact — resend.contacts.update-topics
Update topics for a contact
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.contact_id |
string | Required | The Contact ID or email address. | |
body |
— | Optional | $ref: "#/definitions/UpdateContactTopicsOptions" |
Full JSON Schema
Example input
{
"path": {
"contact_id": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of logs — resend.logs.list
Retrieve a list of logs
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single log — resend.logs.get
Retrieve a single log
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.log_id |
string | Required | The ID of the log. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"log_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an automation — resend.automations.create
Create an automation
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/CreateAutomationRequest" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of automations — resend.automations.list
Retrieve a list of automations
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.status |
string | Optional | Filter automations by status. | enum: ["enabled","disabled"] |
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single automation — resend.automations.get
Retrieve a single automation
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.automation_id |
string | Required | The ID of the automation. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"automation_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an automation — resend.automations.update
Update an automation
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.automation_id |
string | Required | The ID of the automation. | format: "uuid" |
body |
— | Optional | $ref: "#/definitions/PatchAutomationRequest" |
Full JSON Schema
Example input
{
"path": {
"automation_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an automation — resend.automations.remove
Delete an automation
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.automation_id |
string | Required | The ID of the automation. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"automation_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Duplicate an automation — resend.automations.duplicate
Duplicate an automation
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.automation_id |
string | Required | The ID of the automation. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"automation_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Stop an automation — resend.automations.stop
Stop an automation
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.automation_id |
string | Required | The ID of the automation. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"automation_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of automation runs — resend.automations.list-runs
Retrieve a list of automation runs
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.automation_id |
string | Required | The ID of the automation. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.status |
string | Optional | Filter runs by status. Comma-separated list of: running, completed, failed, cancelled. | |
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{
"path": {
"automation_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single automation run — resend.automations.get-run
Retrieve a single automation run
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.automation_id |
string | Required | The ID of the automation. | format: "uuid" |
path.run_id |
string | Required | The ID of the automation run. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"automation_id": "00000000-0000-4000-8000-000000000000",
"run_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an event — resend.events.create
Create an event
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/CreateEventRequest" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of events — resend.events.list
Retrieve a list of events
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Send an event — resend.events.send
Send an event
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/SendEventRequest" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single event — resend.events.get
Retrieve a single event
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.identifier |
string | Required | The event ID (UUID) or event name. |
Full JSON Schema
Example input
{
"path": {
"identifier": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an event — resend.events.update
Update an event
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.identifier |
string | Required | The event ID (UUID) or event name. | |
body |
— | Optional | $ref: "#/definitions/UpdateEventRequest" |
Full JSON Schema
Example input
{
"path": {
"identifier": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an event — resend.events.remove
Delete an event
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.identifier |
string | Required | The event ID (UUID) or event name. |
Full JSON Schema
Example input
{
"path": {
"identifier": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a suppression — resend.suppressions.add
Create a suppression
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/CreateSuppressionOptions" |
Full JSON Schema
Example input
{
"body": {
"email": "[email protected]"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of suppressions — resend.suppressions.list
Retrieve a list of suppressions
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.origin |
string | Optional | Filter suppressions by origin. | enum: ["bounce","complaint","manual"] |
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add up to 100 suppressions at once — resend.suppressions.batch-add
Add up to 100 suppressions at once
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/BatchAddSuppressionsOptions" |
Full JSON Schema
Example input
{
"body": {
"emails": [
"[email protected]"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove up to 100 suppressions at once — resend.suppressions.batch-remove
Remove up to 100 suppressions at once
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/BatchRemoveSuppressionsOptions" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single suppression by ID or email — resend.suppressions.get
Retrieve a single suppression by ID or email
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.suppression |
string | Required | The Suppression ID or email address. |
Full JSON Schema
Example input
{
"path": {
"suppression": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a single suppression by ID or email — resend.suppressions.remove
Remove a single suppression by ID or email
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.suppression |
string | Required | The Suppression ID or email address. |
Full JSON Schema
Example input
{
"path": {
"suppression": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve account usage — resend.usage.get
Retrieve your account's current usage and plan limits.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an inbox — resend.inboxes.create
Creates an inbox that sends and receives email at an address on one of your domains. The domain must belong to the team. Without forwarding, the domain must have receiving enabled, with DKIM and SPF verified and the inbound MX record verified or pending. With forwarding set to true, the domain only needs DKIM and SPF verified for sending, and Resend generates a receiving_address on the team inbound domain, and a team without an inbound domain gets a 422. A domain that does not meet these rules returns a 422 validation_error. An address or receiving address that is already in use returns a 409. A team that has reached the inbox limit of its plan returns a 403 validation_error. A blocked account returns a 451.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/CreateInboxOptions" |
Full JSON Schema
Example input
{
"body": {
"email_address": "[email protected]"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of inboxes — resend.inboxes.list
Returns the inboxes of the team, newest first. The list items carry fewer fields than a single inbox. Retrieve an inbox to get all its fields. The after and before cursors take an inbox ID, and only one of them can be passed, or the request returns a 422. A value that is not a UUID returns a 422, and an unknown ID returns a 404.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single inbox by ID or email address — resend.inboxes.get
Retrieve a single inbox by ID or email address
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an existing inbox by ID or email address — resend.inboxes.update
Updates the internal name of the inbox or the name recipients see when mail is sent from it. At least one of name or from_name is required.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
body |
— | Required | $ref: "#/definitions/UpdateInboxOptions" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1"
},
"body": {
"name": "Customer Support"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove an existing inbox by ID or email address — resend.inboxes.remove
Removes the inbox. An inbox that does not exist or was already removed returns a 404 not_found.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve the agent settings for an inbox — resend.inboxes.get-agent
Returns the agent settings of the inbox. An inbox without a configured agent returns empty settings: instructions and tone are null and actions is an empty array.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update the agent settings for an inbox — resend.inboxes.update-agent
Updates the agent settings of the inbox. The agent is created when the inbox has none. Omitted fields keep their current value.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
body |
— | Required | $ref: "#/definitions/UpdateInboxAgentOptions" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1"
},
"body": {
"instructions": "Answer refund questions yourself. Escalate legal threats."
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of inbox labels — resend.inboxes.list-labels
Returns every label on the inbox, oldest first. The list is not paginated.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a label on an inbox — resend.inboxes.create-label
A label is a named, colored tag that belongs to one inbox. An inbox can have at most 100 labels. Label names are unique per inbox, compared without case. A duplicate name or a full inbox returns a 422 validation_error.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
body |
— | Required | $ref: "#/definitions/CreateInboxLabelOptions" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1"
},
"body": {
"name": "Urgent"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an existing inbox label — resend.inboxes.update-label
Renames or recolors a label. Omitted fields keep their current value. A new name must not match another label on the inbox, compared without case, or the request returns a 422 validation_error.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
path.label_id |
string | Required | The Label ID. | format: "uuid" |
body |
— | Optional | $ref: "#/definitions/UpdateInboxLabelOptions" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
"label_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove an existing inbox label — resend.inboxes.remove-label
Deletes the label and removes it from every thread that carries it.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
path.label_id |
string | Required | The Label ID. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
"label_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of inbox threads — resend.inboxes.list-threads
Returns the threads in an inbox, most recently active first. A thread is a conversation made up of one or more emails. The after and before cursors take a thread ID, and only one of them can be passed. A cursor that is not a UUID, such as a date, returns a 422 validation_error. A cursor thread that is not in the selected folders returns a 404. To find threads by text, sender, recipient, attachment, or date, use the search threads endpoint.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
query |
object | Optional | additionalProperties: false |
|
query.folders |
array | Optional | Comma-separated folders to list, for example inbox,sent. Repeating the parameter returns a 422 validation_error. A thread is returned when any of its emails is in one of the folders, so a thread in inbox with an email you sent matches both inbox and sent. Defaults to inbox, or to inbox,archive,sent when labels is set. spam and trash are only included when you name them. |
|
query.folders[] |
string | Optional | enum: ["inbox","archive","spam","sent","trash"] |
|
query.labels |
array | Optional | Comma-separated label IDs. Returns threads with any of these labels. Up to 50 IDs. An ID that does not exist in the inbox returns a 404. Repeating the parameter returns a 422 validation_error. | maxItems: 50 |
query.labels[] |
string | Optional | format: "uuid" |
|
query.read |
boolean | Optional | true returns threads where every email is read. false returns threads with at least one unread email. Only the literal values true and false are accepted. |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Search the threads of an inbox — resend.inboxes.search-threads
Finds threads by the text of their emails, who sent or received them, whether they have attachments, and their dates. Results are ordered by latest activity, newest first, and paginate like the list threads endpoint, so a cursor that is not a thread ID returns a 422. Search can be up to about a minute behind new emails. Different parameters combine, so a thread must match all of them. folders, labels, and read apply to the thread. query, from, to, cc, bcc, has_attachment, start_date, and end_date must all match the same email in the thread. When any of these email filters is set, the matching email must itself be in one of folders. For sent, that means an email the inbox sent. When more than 10,000 threads match, search covers the 10,000 with the newest matching email.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
query |
object | Optional | additionalProperties: false |
|
query.query |
string | Optional | Free text to search for in the subject, body, sender, recipients, and attachment names. Every word must match. Wrap words in double quotes to match an exact phrase. Start a word or quoted phrase with - to exclude it. Max 256 characters and 32 words. |
maxLength: 256 |
query.from |
array | Optional | Comma-separated senders. Each value matches part of the sender's address or name, without case. Returns threads that match any of them. Up to 20 values. Repeating the parameter returns a 422 validation_error. | maxItems: 20 |
query.from[] |
string | Optional | ||
query.to |
array | Optional | Comma-separated recipients, matched the same way as from. Up to 20 values. Repeating the parameter returns a 422 validation_error. |
maxItems: 20 |
query.to[] |
string | Optional | ||
query.cc |
array | Optional | Comma-separated CC recipients, matched the same way as from. Up to 20 values. Repeating the parameter returns a 422 validation_error. |
maxItems: 20 |
query.cc[] |
string | Optional | ||
query.bcc |
array | Optional | Comma-separated BCC recipients, matched the same way as from. Up to 20 values. Repeating the parameter returns a 422 validation_error. |
maxItems: 20 |
query.bcc[] |
string | Optional | ||
query.has_attachment |
boolean | Optional | true matches emails with an attachment. false matches emails without one. Only the literal values true and false are accepted. |
|
query.start_date |
string | Optional | Matches emails sent on or after this date. Accepts a date like 2026-09-01 or an ISO 8601 timestamp, in UTC unless the timestamp has an offset. An empty value returns a 422. |
|
query.end_date |
string | Optional | Matches emails sent on or before this date. Same formats as start_date. A date covers that whole day, so start_date=2026-09-01&end_date=2026-09-30 covers all of September. A timestamp is used as given. An end_date before start_date returns a 422 validation_error. An empty value returns a 422. |
|
query.folders |
array | Optional | Comma-separated folders to search, for example inbox,sent. Repeating the parameter returns a 422 validation_error. A thread is returned when any of its emails is in one of the folders. Defaults to inbox, or to inbox,archive,sent when labels is set. spam and trash are only included when you name them. |
|
query.folders[] |
string | Optional | enum: ["inbox","archive","spam","sent","trash"] |
|
query.labels |
array | Optional | Comma-separated label IDs. Returns threads with any of these labels. Up to 50 IDs. An ID that does not exist in the inbox returns a 404. Repeating the parameter returns a 422 validation_error. | maxItems: 50 |
query.labels[] |
string | Optional | format: "uuid" |
|
query.read |
boolean | Optional | true returns threads where every email is read. false returns threads with at least one unread email. Only the literal values true and false are accepted. |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single inbox thread — resend.inboxes.get-thread
Returns the thread summary. The emails in the thread are listed with the list thread emails endpoint.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
path.thread_id |
string | Required | The Thread ID. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
"thread_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an existing inbox thread — resend.inboxes.update-thread
Marks a thread read or unread, or moves it to a folder. At least one of read or folder is required. To change the labels of a thread, use the add, set, and remove thread labels endpoints. This endpoint ignores the removed add_label_ids and remove_label_ids fields, so a body with only those fields returns a 422 validation_error. Moving a thread out of trash restores it and clears its deletion deadline. The changes apply in this order: read, then folder. They are not atomic.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
path.thread_id |
string | Required | The Thread ID. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/UpdateInboxThreadOptions" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
"thread_id": "00000000-0000-4000-8000-000000000000"
},
"body": {
"read": true
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove an existing inbox thread — resend.inboxes.remove-thread
Moves the thread to trash and schedules it for deletion in 30 days. This is reversible. To restore the thread, update its folder to inbox, archive, or spam, which also clears the deletion deadline.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
path.thread_id |
string | Required | The Thread ID. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
"thread_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add labels to an inbox thread — resend.inboxes.add-thread-labels
Applies one or more labels to the thread. Labels already on the thread stay on it. The response lists every label on the thread after the change. A label ID that is not a label of the inbox returns a 404 Label not found., and nothing changes. A thread that does not exist in the inbox returns a 404 Thread not found.. To replace the labels of the thread, use the set thread labels endpoint.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
path.thread_id |
string | Required | The Thread ID. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/AddInboxThreadLabelsOptions" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
"thread_id": "00000000-0000-4000-8000-000000000000"
},
"body": {
"labels": [
"7f9c1d2e-4a6b-4c3d-8e15-9b0a7c6d5e34"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Set the labels of an inbox thread — resend.inboxes.set-thread-labels
Replaces every label on the thread with the given labels, in one atomic change. Labels on the thread that are not in the list are taken off it. The labels themselves are kept. An empty array takes every label off the thread. The response lists every label on the thread after the change. A label ID that is not a label of the inbox returns a 404 Label not found., and nothing changes. A thread that does not exist in the inbox returns a 404 Thread not found..
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
path.thread_id |
string | Required | The Thread ID. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/SetInboxThreadLabelsOptions" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
"thread_id": "00000000-0000-4000-8000-000000000000"
},
"body": {
"labels": [
"7f9c1d2e-4a6b-4c3d-8e15-9b0a7c6d5e34"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a label from an inbox thread — resend.inboxes.remove-thread-label
Takes one label off the thread. The label itself is kept, and stays on every other thread that carries it. To delete the label, use the remove inbox label endpoint. The response lists every label on the thread after the change. A label that is not on the thread returns a 200 with the current labels. A label ID that is not a label of the inbox returns a 404 Label not found.. A thread that does not exist in the inbox returns a 404 Thread not found..
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
path.thread_id |
string | Required | The Thread ID. | format: "uuid" |
path.label_id |
string | Required | The Label ID. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
"thread_id": "00000000-0000-4000-8000-000000000000",
"label_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of thread emails — resend.inboxes.list-thread-emails
Returns the messages of a thread, oldest first. Pass the id of the last message as after to get the next, newer page. Pass the id of the first message as before to get the previous, older page. Passing both after and before, or a cursor that is not a UUID, returns a 422. A cursor that is not a message of the thread returns a 404.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
path.thread_id |
string | Required | The Thread ID. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
"thread_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single thread email — resend.inboxes.get-thread-email
Retrieve a single thread email
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
path.thread_id |
string | Required | The Thread ID. | format: "uuid" |
path.email_id |
string | Required | The Email ID, as returned in data[].id by the list thread emails endpoint. |
format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
"thread_id": "00000000-0000-4000-8000-000000000000",
"email_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Reply to a thread email — resend.inboxes.reply-thread-email
Sends a reply from the inbox address right away, with no stored draft. The to recipients come from the message you reply to. For a message the inbox received, the reply goes to its Reply-To addresses, or to its sender when it has no Reply-To. For a message the inbox sent, the reply goes to that message's to recipients. Set reply_all to also copy the other recipients of the message. The reply threads under the message through the In-Reply-To and References headers. When no recipient can be found for the reply, the request returns a 422. The whole email, encoded, can be at most 40 MB, or the request returns a 422.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Idempotency-Key |
string | Optional | A unique key for the request, so the reply is sent only once. A retry with the same key within 24 hours returns the first successful (2xx) response, with the idempotent-replayed: true header. A failed request is not stored, so it can be retried with the same key. Reusing the key with a different body, or while the first request is still running, returns a 409. An empty key, or one longer than 256 characters, returns a 400 invalid_idempotency_key. Learn more |
minLength: 1; maxLength: 256 |
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
path.thread_id |
string | Required | The Thread ID. | format: "uuid" |
path.email_id |
string | Required | The Email ID of the message to reply to, as returned in data[].id by the list thread emails endpoint. |
format: "uuid" |
body |
— | Required | $ref: "#/definitions/ReplyInboxThreadEmailOptions" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
"thread_id": "00000000-0000-4000-8000-000000000000",
"email_id": "00000000-0000-4000-8000-000000000000"
},
"body": {
"html": "<p>Refund issued for order 1041.</p>"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Forward a thread email — resend.inboxes.forward-thread-email
Forwards a message from the inbox address right away, with no stored draft. The original message is quoted under a forwarded-message banner, below the optional html or text note. The attachments of the original message are sent with the forward, together with any attachments you add. The request returns a 422 when they exceed 25 MB of content in total. An original attachment that was sent from a URL (path) cannot be forwarded, and the request returns a 422. The whole email, encoded, can be at most 40 MB, or the request returns a 422.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Idempotency-Key |
string | Optional | A unique key for the request, so the forward is sent only once. A retry with the same key within 24 hours returns the first successful (2xx) response, with the idempotent-replayed: true header. A failed request is not stored, so it can be retried with the same key. Reusing the key with a different body, or while the first request is still running, returns a 409. An empty key, or one longer than 256 characters, returns a 400 invalid_idempotency_key. Learn more |
minLength: 1; maxLength: 256 |
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
path.thread_id |
string | Required | The Thread ID. | format: "uuid" |
path.email_id |
string | Required | The Email ID of the message to forward, as returned in data[].id by the list thread emails endpoint. |
format: "uuid" |
body |
— | Required | $ref: "#/definitions/ForwardInboxThreadEmailOptions" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
"thread_id": "00000000-0000-4000-8000-000000000000",
"email_id": "00000000-0000-4000-8000-000000000000"
},
"body": {
"to": [
"[email protected]"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a list of drafts — resend.inboxes.list-drafts
Returns the unsent drafts on the inbox, most recently updated first. The after and before cursors take a Draft ID from the current page, and only one of them can be passed. A cursor that is not a UUID, or both cursors together, return a 422. A cursor that is not an unsent draft on this inbox returns a 404.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Number of items to return. | minimum: 1; maximum: 100 |
query.after |
string | Optional | Return items after this cursor. | |
query.before |
string | Optional | Return items before this cursor. |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a draft — resend.inboxes.create-draft
Creates an unsent draft on the inbox. Omit thread_id and reply_to_email_id for a draft that starts a new thread. Pass both together for a reply draft in an existing thread. A reply draft without to is addressed to the sender of the email it replies to, or to its Reply-To when set. For an email the inbox sent, it defaults to that email's to recipients. Send to: [] to leave it empty. At least one of to, cc, bcc, subject, text, html or attachments must be non-empty. The combined recipients of to, cc and bcc cannot exceed 50. Attachments are stored on the draft, so a path file is downloaded when the request is made. Returns 201 for a new draft. Only one unsent reply draft can target an email, so a reply draft request for an email that already has one returns 200 with the ID of the existing draft. An unknown thread_id, or a reply_to_email_id that is not in that thread, returns a 404. That request ignores every other field, except attachments, which replaces the attachments of the existing draft when sent. A reply draft created without subject stores an empty subject. When it is sent, it takes the thread subject, prefixed with Re: when it does not already start with it.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Idempotency-Key |
string | Optional | A unique key for the request, so the draft is created only once. A retry with the same key within 24 hours returns the first successful (2xx) response, with the idempotent-replayed: true header. A failed request is not stored, so it can be retried with the same key. Reusing the key with a different body, or while the first request is still running, returns a 409. An empty key, or one longer than 256 characters, returns a 400 invalid_idempotency_key. Learn more |
minLength: 1; maxLength: 256 |
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
body |
— | Required | $ref: "#/definitions/CreateInboxDraftOptions" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a single draft — resend.inboxes.get-draft
Retrieve a single draft
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
path.draft_id |
string | Required | The Draft ID. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
"draft_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an existing draft — resend.inboxes.update-draft
Updates the content of an unsent draft. Omitted fields are left unchanged. Send at least one of to, cc, bcc, subject, text, html or attachments. Sending attachments replaces every attachment on the draft. A request that sets text or html replaces the whole body. The body part you omit from that request becomes null. The merged draft must still contain at least one non-empty field, and its combined recipients cannot exceed 50. A draft that was already sent, or that changed during the request, returns a 409. The response holds only the Draft ID. Retrieve the draft to read its content.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
path.draft_id |
string | Required | The Draft ID. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/UpdateInboxDraftOptions" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
"draft_id": "00000000-0000-4000-8000-000000000000"
},
"body": {
"to": [
"[email protected]"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove an existing draft — resend.inboxes.remove-draft
Discards an unsent draft. A draft that was already sent, or that changed during the request, returns a 409.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
path.draft_id |
string | Required | The Draft ID. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
"draft_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Send a draft — resend.inboxes.send-draft
Sends the draft from the inbox address. A reply draft is sent in its thread. A draft without a thread starts a new thread. The draft must have at least one to recipient and html or text, or the request returns a 422. A standalone draft also needs a non-empty subject. A reply draft with an empty subject is sent with the thread subject, prefixed with Re: when it does not already start with it. A draft that was already sent returns a 409. The request body is optional and takes only headers. The whole email, encoded, can be at most 40 MB, or the request returns a 422.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.Idempotency-Key |
string | Optional | A unique key for the request, so the draft is sent only once. A retry with the same key within 24 hours returns the first successful (2xx) response, with the idempotent-replayed: true header. A failed request is not stored, so it can be retried with the same key. Reusing the key with a different body, or while the first request is still running, returns a 409. An empty key, or one longer than 256 characters, returns a 400 invalid_idempotency_key. Learn more |
minLength: 1; maxLength: 256 |
path |
object | Required | additionalProperties: false |
|
path.inbox_id |
string | Required | The Inbox ID or the inbox email address, such as [email protected]. A value that contains @ must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox name. An address that matches no inbox returns a 404. |
|
path.draft_id |
string | Required | The Draft ID. | format: "uuid" |
body |
— | Optional | $ref: "#/definitions/SendInboxDraftOptions" |
Full JSON Schema
Example input
{
"path": {
"inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
"draft_id": "00000000-0000-4000-8000-000000000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Errors
Check the key's expiry, revocation, workspace and allowed operations.
Reuse the same idempotency key only for the same request.
The connection or provider limit has been reached. Check the receipt before retrying.
Test the connection
Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.