MailerSend

mailersend

MailerSend is a transactional email service designed for developers to integrate email sending capabilities into their applications.

Transactional Email Email Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (23)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create Sending DomainMAILERSEND_CREATE_DOMAINAcción

Tool to add a new sending domain to mailersend. use when you need to register and configure a domain before sending emails.

Parámetros de entrada

namestringObligatorio
Fully qualified domain name to add for sending emails.
domain_typestring
Type of the domain (e.g., "custom").
add_dns_recordsboolean
If true, automatically add recommended DNS records when supported.
skip_verificationboolean
If true, skip verification steps during domain creation.
return_path_domain_idstring
Existing domain ID to use as the return-path for this domain.

Parámetros de salida

dataobjectObligatorio
Details of the created domain.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create SMTP UserMAILERSEND_CREATE_SMTP_USERAcción

Tool to create a new smtp user. use after domain setup to obtain smtp credentials.

Parámetros de entrada

namestringObligatorio
Display name for the SMTP user.
passwordstring
Optional password for the SMTP user. If omitted, MailerSend will generate one.
domain_idstringObligatorio
ID of the domain to associate with this SMTP user.

Parámetros de salida

dataobjectObligatorio
Details of the created SMTP user.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create API TokenMAILERSEND_CREATE_TOKENAcción

Tool to create a new api token. use when you need to generate a token with specific permissions in mailersend.

Parámetros de entrada

namestringObligatorio
A descriptive name for the new API token.
scopesstring[]Obligatorio
List of permission scopes to grant this token, e.g., ['email.send', 'email.read'].

Parámetros de salida

dataobjectObligatorio
Details of the newly created API token.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create WebhookMAILERSEND_CREATE_WEBHOOKAcción

Tool to create a new webhook for a mailersend domain. use after you have a domain id and need to receive event notifications like sent, delivered, opened, etc.

Parámetros de entrada

urlstringObligatorio
The callback URL where MailerSend will send POST requests.
namestringObligatorio
The name of the webhook.
eventsstring[]Obligatorio
List of events the webhook listens for (e.g., 'message.sent', 'message.delivered').
enabledboolean
Whether the webhook is enabled immediately after creation.
domain_idstringObligatorio
The ID of the domain to attach the webhook to.

Parámetros de salida

dataobjectObligatorio
Details of the created webhook.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete WebhookMAILERSEND_DELETE_WEBHOOKAcción

Tool to delete an existing webhook. use when the webhook is no longer needed. returns empty response on successful deletion (http 204).

Parámetros de entrada

webhook_idstringObligatorio
The unique identifier of the webhook to be deleted.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get API QuotaMAILERSEND_GET_API_QUOTAAcción

Tool to retrieve current api usage quota. use when monitoring api rate limits to avoid exceeding allowed calls.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get DomainMAILERSEND_GET_DOMAINAcción

Tool to fetch information for a specific sending domain. use when you need to verify domain status and dns configuration after setup or changes.

Parámetros de entrada

domain_idstringObligatorio
Unique identifier for the sending domain

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Domain RecipientsMAILERSEND_GET_DOMAIN_RECIPIENTSAcción

Tool to list recipients for a domain. use after obtaining the domain id to view recipients with optional pagination.

Parámetros de entrada

pageinteger
Page number for pagination, must be >= 1
limitinteger
Number of recipients per page, must be >= 1
domain_idstringObligatorio
The ID of the domain to fetch recipients for

Parámetros de salida

dataobject[]Obligatorio
List of recipients for the domain
metaobjectObligatorio
Pagination metadata
errorstring
Error if any occurred during the execution of the action
linksobjectObligatorio
Pagination links
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get sending domainsMAILERSEND_GET_DOMAINSAcción

Tool to retrieve a list of sending domains. use after configuring the mailersend api key.

Parámetros de entrada

pageinteger
Page number to retrieve, starting from 1
limitinteger
Number of results per page (default 25, maximum 100)

Parámetros de salida

dataobject[]Obligatorio
List of sending domain objects
metaobjectObligatorio
Pagination metadata
errorstring
Error if any occurred during the execution of the action
linksobjectObligatorio
Pagination links
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get general API resourcesMAILERSEND_GET_GENERAL_RESOURCESAcción

Tool to retrieve general api resources and information. use when you need an overview of all mailersend endpoints before constructing specific calls.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
List of resource categories and their endpoints.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Sender IdentitiesMAILERSEND_GET_IDENTITIESAcción

Tool to list sender identities. use when you need to retrieve all configured email or domain sender identities after authenticating with your mailersend api token.

Parámetros de entrada

pageinteger
Page number for pagination, must be >= 1
limitinteger
Number of results per page, must be >= 1

Parámetros de salida

dataobject[]Obligatorio
Array of sender identity objects
metaobjectObligatorio
Pagination details
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get sent messagesMAILERSEND_GET_MESSAGESAcción

Tool to retrieve a paginated list of sent messages. use after sending emails to view message logs.

Parámetros de entrada

pageinteger
Page number for pagination (starts at 1)
limitinteger
Number of messages per page (max 100)
date_tostringdate-time
Filter messages sent on or before this datetime (ISO 8601)
date_fromstringdate-time
Filter messages sent on or after this datetime (ISO 8601)

Parámetros de salida

dataobject[]Obligatorio
Array of sent message objects
metaobjectObligatorio
Pagination metadata info
errorstring
Error if any occurred during the execution of the action
linksobjectObligatorio
Pagination navigation links
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get email recipientsMAILERSEND_GET_RECIPIENTSAcción

Tool to retrieve a list of email recipients. use when you need to list and filter recipients by list id or search term.

Parámetros de entrada

pageinteger
Page number for pagination, starting from 1
limitinteger
Number of results per page (default 25, maximum 100)
searchstring
Term to search in recipient email address or name
list_idstring
Filter recipients by this mailing list ID

Parámetros de salida

dataobject[]Obligatorio
List of recipient objects
metaobjectObligatorio
Pagination metadata
errorstring
Error if any occurred during the execution of the action
linksobjectObligatorio
Pagination links
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get SMS ActivityMAILERSEND_GET_SMS_ACTIVITYAcción

Tool to retrieve sms activity logs. use when you need to fetch delivery status and logs of sent sms messages.

Parámetros de entrada

pageinteger
Page number for pagination, starting from 1
limitinteger
Number of results per page (default: 25, max: 100)
date_tostring
Filter activities created before this ISO 8601 date
date_fromstring
Filter activities created after this ISO 8601 date (e.g., 2022-01-01T00:00:00+0000)
message_idstring
Filter SMS activities by specific message ID
sms_number_idstring
Filter by SMS number ID

Parámetros de salida

dataobject[]Obligatorio
List of SMS activity objects
metaobjectObligatorio
Pagination metadata
errorstring
Error if any occurred during the execution of the action
linksobjectObligatorio
Pagination links
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get SMS InboundsMAILERSEND_GET_SMS_INBOUNDSAcción

Tool to retrieve inbound sms messages. use when you need to fetch sms messages received on your mailersend numbers.

Parámetros de entrada

pageinteger
Page number for pagination, starting from 1
limitinteger
Number of results per page (default: 25, max: 100)

Parámetros de salida

dataobject[]Obligatorio
List of inbound SMS message objects
metaobjectObligatorio
Pagination metadata
errorstring
Error if any occurred during the execution of the action
linksobjectObligatorio
Pagination links
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List SMS MessagesMAILERSEND_GET_SMS_MESSAGESAcción

Tool to list sent sms messages with optional filters. use after sending sms to review message logs.

Parámetros de entrada

pageinteger
Page number for pagination (must be >= 1)
limitinteger
Number of results per page (min 10, max 100)
statusstringenum
Filter by message status
queuedsentdeliveredundeliveredfailed
date_tostring
End date filter in YYYY-MM-DD format
date_fromstring
Start date filter in YYYY-MM-DD format
recipientstring
Filter by recipient phone number

Parámetros de salida

dataobject[]Obligatorio
List of SMS messages
metaobjectObligatorio
Pagination metadata
errorstring
Error if any occurred during the execution of the action
linksobjectObligatorio
Pagination navigation links
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get SMS NumbersMAILERSEND_GET_SMS_NUMBERSAcción

Tool to retrieve a paginated list of sms phone numbers. use after purchasing numbers to fetch available sms numbers.

Parámetros de entrada

pageinteger
Page number for pagination, starting from 1
limitinteger
Number of SMS numbers per page

Parámetros de salida

dataobject[]Obligatorio
List of SMS number objects
metaobjectObligatorio
Pagination metadata
errorstring
Error if any occurred during the execution of the action
linksobjectObligatorio
Pagination links
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get SMS recipientsMAILERSEND_GET_SMS_RECIPIENTSAcción

Tool to retrieve a list of sms recipients. use when you need to list and paginate sms recipients, optionally filtering by sms number id.

Parámetros de entrada

pageinteger
Page number to retrieve, starting from 1
limitinteger
Number of recipients per page (default 25, maximum 100)
sms_number_idstring
Filter recipients by SMS number ID.

Parámetros de salida

dataobject[]Obligatorio
List of SMS recipient objects
metaobjectObligatorio
Pagination metadata
errorstring
Error if any occurred during the execution of the action
linksobjectObligatorio
Pagination links
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get SMTP usersMAILERSEND_GET_SMTP_USERSAcción

Tool to retrieve a list of smtp users. use when you need to list and paginate smtp users.

Parámetros de entrada

pageinteger
Page number to retrieve, starting from 1
limitinteger
Number of records per page (default 25, maximum 100)
domain_idstring
Identifier of the domain for scoping SMTP users listing

Parámetros de salida

dataobject[]Obligatorio
List of SMTP user objects
metaobjectObligatorio
Pagination metadata
errorstring
Error if any occurred during the execution of the action
linksobjectObligatorio
Pagination links
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get email templatesMAILERSEND_GET_TEMPLATESAcción

Tool to retrieve a list of email templates. use when you need to list and paginate email templates.

Parámetros de entrada

pageinteger
Page number for pagination, starting from 1
limitinteger
Number of templates per page (default 25, maximum 100)

Parámetros de salida

dataobject[]Obligatorio
List of email templates
metaobjectObligatorio
Pagination metadata
errorstring
Error if any occurred during the execution of the action
linksobjectObligatorio
Pagination links
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get API TokensMAILERSEND_GET_TOKENSAcción

Tool to retrieve a list of api tokens. use when you need to list and paginate api tokens after authentication.

Parámetros de entrada

pageinteger
Page number for pagination, starting from 1
limitinteger
Number of items per page (min=10, max=100)

Parámetros de salida

dataobject[]Obligatorio
Array of token objects
metaobjectObligatorio
Pagination metadata
errorstring
Error if any occurred during the execution of the action
linksobjectObligatorio
Pagination links
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get usersMAILERSEND_GET_USERSAcción

Tool to retrieve a list of users associated with your account. use after authenticating with a valid api token.

Parámetros de entrada

pageinteger
Page number for pagination, must be >= 1
limitinteger
Number of users per page (default 25, maximum 100)

Parámetros de salida

dataobject[]Obligatorio
List of user objects
metaobjectObligatorio
Pagination metadata
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List webhooksMAILERSEND_GET_WEBHOOKSAcción

Tool to retrieve a list of webhooks. use when you need to list and paginate all configured webhooks, optionally filtering by domain.

Parámetros de entrada

pageinteger
Page number to retrieve, starting from 1
limitinteger
Number of webhooks per page (default 25)
domain_idstring
Filter webhooks belonging to this domain

Parámetros de salida

dataobject[]Obligatorio
List of webhook objects
metaobjectObligatorio
Pagination metadata
errorstring
Error if any occurred during the execution of the action
linksobjectObligatorio
Pagination links
successfulbooleanObligatorio
Whether or not the action execution was successful or not