Benchmark Email

benchmark_email

Benchmark Email is a comprehensive email marketing platform offering tools for creating, sending, and analyzing email campaigns.

Email Newsletters Marketing Automation 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 (36)

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.

Delete Contact From ListBENCHMARK_EMAIL_DELETE_CONTACT_FROM_LISTAcción

Tool to delete a contact from a specific list by contactid. use when you have list and contact ids. example: "delete contact 2040826674 from list 15257899"

Parámetros de entrada

filterstring
Optional filter value
searchstring
Optional search filter (e.g., email address)
list_idstringObligatorio
List ID
contact_idstringObligatorio
Contact ID to remove

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

Delete Contact ListBENCHMARK_EMAIL_DELETE_CONTACT_LISTAcción

Tool to delete a contact list. use after confirming that the list is no longer in use.

Parámetros de entrada

list_idstringObligatorio
ID of the contact list to delete

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

Delete Email CampaignBENCHMARK_EMAIL_DELETE_EMAILAcción

Tool to delete an email campaign. use when removing a campaign by its id. use after confirming the campaign id is correct.

Parámetros de entrada

idstringObligatorio
The unique identifier of the email campaign to delete

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

Delete Linked Agency AccountBENCHMARK_EMAIL_DELETE_LINK_ACCOUNTAcción

Tool to delete a linked agency account. use when revoking a linked agency account by its id. use after confirming the account id is correct.

Parámetros de entrada

IDintegerObligatorio
ID of the linked agency account to delete

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

Delete WebhookBENCHMARK_EMAIL_DELETE_WEBHOOKAcción

Tool to delete a webhook from a contact list by its id. use when removing obsolete or invalid webhooks after confirming list and webhook details.

Parámetros de entrada

IDintegerObligatorio
Unique identifier of the webhook to delete
ListIDintegerObligatorio
ID of the contact list containing the webhook

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 All Confirmed EmailsBENCHMARK_EMAIL_GET_ALL_CONFIRMED_EMAILSAcción

Tool to retrieve all confirmed email addresses for the client account. use after user completes email confirmation flows to fetch final list.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
Array of confirmation records
countintegerObligatorio
Total confirmed emails count
errorstring
Error if any occurred during the execution of the action
statusstringObligatorioenum
API status code: '1'=success, '-1'=error
1-1
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Client Account SettingsBENCHMARK_EMAIL_GET_CLIENT_ACCOUNT_SETTINGSAcción

Tool to get client account settings such as company, language, timezone, and sender info. use when you need to fetch account configuration before sending campaigns.

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 client detailsBENCHMARK_EMAIL_GET_CLIENT_DETAILSAcción

Tool to get client details including profile data, contact count, and plan information. use when verifying account profile and limits.

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 Client Plan InformationBENCHMARK_EMAIL_GET_CLIENT_PLAN_INFORMATIONAcción

Tool to get client's plan information including addons, email plan, and total contacts. use when you need the current plan details before managing upgrades or billing.

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 client profile detailsBENCHMARK_EMAIL_GET_CLIENT_PROFILE_DETAILSAcción

Tool to get client's profile details like business city, country, phone, and company. use after confirming authentication to fetch client profile info.

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 Contact List DetailsBENCHMARK_EMAIL_GET_CONTACT_LIST_DETAILSAcción

Tool to fetch detailed information for a contact list. use after confirming the list id to retrieve all metadata.

Parámetros de entrada

list_idstringObligatorio
Unique identifier of the contact list

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 Contact ListsBENCHMARK_EMAIL_GET_CONTACT_LISTSAcción

Tool to retrieve all contact lists. use when you need to list or select a contact list.

Parámetros de entrada

filterstring
Filter text to match list names or attributes
statusstring
Status value to filter lists (e.g., '1' for active)
order_bystringenum
Sort field: 'email', 'date', 'count', or 'schedule'
emaildatecountschedule
page_sizeinteger
Number of lists to return per page
sort_orderstringenum
Sort direction: 'asc' or 'desc'
ascdesc
filter_typestring
Type of filter to apply, if supported
page_numberinteger
Page number to retrieve (1-based index)
exclude_email_idstring
Exclude lists that contain this email ID

Parámetros de salida

dataobject[]Obligatorio
Array of contact list details
countintegerObligatorio
Total number of contact lists available
errorstring
Error if any occurred during the execution of the action
statusstringObligatorioenum
API status code: '1'=success, '-1'=error
1-1
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Filtered Contacts in ListBENCHMARK_EMAIL_GET_CONTACTS_IN_LISTAcción

Tool to fetch filtered and paginated contacts from a list by listid. use when narrowing a list via search, filters, and paging.

Parámetros de entrada

Filterstringenum
Subset filter: 2=unsubscribe, 5=hard bounce, 100=others.
25100
ListIDstringObligatorio
ID of the contact list to query.
OrderBystringenum
Field to sort by.
emailfirstnamelastnamedate
PageSizeinteger
Number of contacts per page.
SortOrderstringenum
Sort direction.
ascdesc
PageNumberinteger
Pagination page number (starting at 1).
SearchTypestringenum
Match type: 1=starts, 2=exact, 3=contains, 4=ends.
1234
SearchFieldstring
Field to apply search (e.g., email, firstname).
SearchFilterstring
Text filter to search within contacts.

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 Email Report ForwardsBENCHMARK_EMAIL_GET_EMAIL_REPORT_FORWARDSAcción

Tool to get forwards report for an email campaign. use after campaign send to export its forwards.

Parámetros de entrada

email_idstringObligatorio
ID of the email campaign to retrieve the forwards report for

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 Unopens ReportBENCHMARK_EMAIL_GET_EMAIL_REPORT_UNOPENSAcción

Tool to get unopens report for an email campaign by id. use when you need to export or review recipients who did not open a specific email campaign.

Parámetros de entrada

email_idstringObligatorio
Unique identifier of the email campaign

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 Linked Agency Account DetailsBENCHMARK_EMAIL_GET_LINK_ACCOUNT_DETAILSAcción

Tool to get details of a linked agency account. use when retrieving info for a specific linked account by id after confirming the account exists.

Parámetros de entrada

IDintegerObligatorio
ID of the linked agency account to retrieve details for

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 Linked Agency AccountsBENCHMARK_EMAIL_GET_LIST_LINK_ACCOUNTSAcción

Tool to get list of linked agency accounts. use after linking agency accounts to retrieve all associated accounts.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
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 sub-account detailsBENCHMARK_EMAIL_GET_SUB_ACCOUNT_DETAILSAcción

Tool to get details for a specific sub-account by id. use when needing profile and plan info of a child account.

Parámetros de entrada

idstringObligatorio
Unique identifier (ID) of the sub-account to retrieve

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 Sub-Account HistoryBENCHMARK_EMAIL_GET_SUB_ACCOUNT_HISTORYAcción

Tool to get sub-account history. use after listing sub-accounts to retrieve each account's billing history.

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 Sub-AccountsBENCHMARK_EMAIL_GET_SUB_ACCOUNTSAcción

Tool to retrieve all sub-accounts for the client. use when you need to view or manage sub-accounts.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

Dataobject[]Obligatorio
List of sub-account detail objects
CountintegerObligatorio
Number of sub-accounts returned
errorstring
Error if any occurred during the execution of the action
StatusstringObligatorioenum
API status: '1'=success, '-1'=error
1-1
HasDatesstringObligatorioenum
'1'=dates included in response
10
HasInboxstringObligatorioenum
'1'=inbox info included in response
10
successfulbooleanObligatorio
Whether or not the action execution was successful or not
UniqueCountintegerObligatorio
Total unique contacts across sub-accounts
HasClientAccountsstringObligatorioenum
'1'=has linked client accounts
10

Get Sub-Accounts Plan ListBENCHMARK_EMAIL_GET_SUB_ACCOUNTS_PLAN_LISTAcción

Tool to retrieve available plans for a sub-account. use when you need to determine list and email limits for a specific sub-account client id.

Parámetros de entrada

IDstringObligatorio
Sub-account holder client ID

Parámetros de salida

Dataobject[]Obligatorio
Array of available plan items
errorstring
Error if any occurred during the execution of the action
StatusstringObligatorio
API status: '1' indicates success, '-1' error
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Change PasswordBENCHMARK_EMAIL_PATCH_CHANGE_PASSWORDAcción

Tool to change the password for the client account. use when updating account credentials after validating new and confirm passwords match.

Parámetros de entrada

NewPasswordstringObligatorio
New password for the client account
ConfirmPasswordstringObligatorio
Confirmation of the new password; must match NewPassword

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

Save Security PINBENCHMARK_EMAIL_PATCH_SAVE_SECURITY_PINAcción

Tool to save a new security pin for the client account. use when you need to update the account pin after confirming both entries match.

Parámetros de entrada

NewPINstringObligatorio
New 4-digit security PIN to set for the client account
ConfirmNewPINstringObligatorio
Confirmation of the new PIN; must match NewPIN

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

Send Reset EmailBENCHMARK_EMAIL_PATCH_SEND_RESET_EMAILAcción

Tool to send a reset email link to change the primary email address. use when initiating an email-based reset of the account’s primary email after user request.

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

Patch Update Client SettingsBENCHMARK_EMAIL_PATCH_UPDATE_CLIENT_SETTINGSAcción

Tool to update client account settings. use after fetching current settings. updates company info, timezone, language, sender defaults, and signature details.

Parámetros de entrada

DetailobjectObligatorio
Detail object containing all settings to update

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

Update Contact ListBENCHMARK_EMAIL_PATCH_UPDATE_CONTACT_LISTAcción

Tool to update an existing contact list. use after confirming list id and desired modifications to name, description, labels, or custom fields.

Parámetros de entrada

DataobjectObligatorio
Payload containing the fields to update
ListIDstringObligatorio
Identifier of the contact list to update

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

Update/Edit ProfileBENCHMARK_EMAIL_PATCH_UPDATE_EDIT_PROFILEAcción

Tool to update or edit profile information such as first name, last name, and phone number. use after retrieving profile details to apply changes.

Parámetros de entrada

PhoneNostringObligatorio
Client's phone number
LastNamestringObligatorio
Client's last name
FirstNamestringObligatorio
Client's first name

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

Update WebhookBENCHMARK_EMAIL_PATCH_UPDATE_WEBHOOKAcción

Tool to update a webhook for a contact list by webhook id. use after retrieving or creating a webhook to modify its event settings such as cleaned-address, email-change, profile-update, subscribe, and unsubscribe callbacks.

Parámetros de entrada

IDintegerObligatorio
Unique identifier of the webhook to update
DataobjectObligatorio
Settings payload for the webhook
ListIDintegerObligatorio
ID of the contact list containing the webhook

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

Add Contact to ListBENCHMARK_EMAIL_POST_ADD_CONTACT_TO_LISTAcción

Tool to add a new contact to a specific list. use after verifying the list id exists.

Parámetros de entrada

EmailstringObligatorio
Contact's email address
ListIDstringObligatorio
ID of the contact list to add the new contact to
LastNamestring
Contact's last name (optional)
EmailPermstringenum
Email permission flag: '1'=grant, '0'=decline (optional)
10
FirstNamestring
Contact's first name (optional)

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

Change Security PINBENCHMARK_EMAIL_POST_CHANGE_SECURITY_PINAcción

Tool to change security pin for the client account. use after confirming your current pin to rotate your pin.

Parámetros de entrada

ResetPINstringObligatorio
New 4-digit security PIN to set for the client account
ResetOldPINstringObligatorio
Current 4-digit security PIN
ResetConfirmPINstringObligatorio
Confirmation of the new PIN; must match ResetPIN

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

Create Contact ListBENCHMARK_EMAIL_POST_CREATE_CONTACT_LISTAcción

Tool to create a new contact list. use after planning list name and optional description.

Parámetros de entrada

NamestringObligatorio
Name of the new contact list
Descriptionstring
Optional description for the contact list

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

Create WebhookBENCHMARK_EMAIL_POST_CREATE_WEBHOOKAcción

Tool to create a new webhook for a contact list. use when you need to get callbacks for list events after list creation.

Parámetros de entrada

ListIDstringObligatorio
ID of the contact list to associate the new webhook with
ClientUrlstringObligatorio
The HTTP endpoint URL to receive webhook callbacks
SubscribesstringObligatorioenum
Flag for subscribe event callback: '1' to enable, '0' to disable
01
EmailChangedstringObligatorioenum
Flag for email-changed event callback: '1' to enable, '0' to disable
01
UnsubscribesstringObligatorioenum
Flag for unsubscribe event callback: '1' to enable, '0' to disable
01
CleanedAddressstringObligatorioenum
Flag for cleaned-address event callback: '1' to enable, '0' to disable
01
ProfileUpdatesstringObligatorioenum
Flag for profile-updates event callback: '1' to enable, '0' to disable
01
ContactMasterIDstringObligatorio
Same as ListID, the contact list identifier

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

Disable Security PINBENCHMARK_EMAIL_POST_DISABLE_SECURITY_PINAcción

Tool to disable security pin for the client account. use when revoking the current pin to remove pin protection.

Parámetros de entrada

DisableOldPINstringObligatorio
Current 4-digit security PIN to disable

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

Save Website DomainBENCHMARK_EMAIL_POST_SAVE_WEBSITE_DOMAINAcción

Tool to save a website domain for your benchmark email account. use after account setup to register your domain for link tracking.

Parámetros de entrada

CompanyWebsitestringObligatorio
Domain name to link with your Benchmark Email account (e.g., 'example.com').

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

Send Confirm Email VerificationBENCHMARK_EMAIL_POST_SEND_CONFIRM_EMAIL_VERIFICATIONAcción

Tool to send confirm email verification. use when unverified addresses must receive verification emails after signup.

Parámetros de entrada

EmailIDsstringObligatorio
Comma-separated list of email addresses to send verification emails to

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

Send PIN via EmailBENCHMARK_EMAIL_POST_SEND_PIN_EMAILAcción

Tool to send pin via email. use when you forgot your security pin and need it emailed to you.

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