SendGrid

Node catalog Actions

On this page

SendGrid API v3: mail send, contacts, templates, suppressions, webhooks

Usage and specifics

Select an operation, fill path and query parameters, then guided body fields. Advanced mode exposes the full catalog and custom_request enables a custom request. Permissions, sending domains and webhook signatures remain provider-specific.

Technical type : sendgrid. Runtime : nodulz.

Credentials and prerequisites

Create and configure the credential : sendgrid

Create credentials in your nodulz instance’s Credentials area, then select them on the node. Availability depends on ownership and sharing. See the credentials guide for access and rotation.

Parameters

Names below are technical keys. Defaults are not a ready-to-run configuration: complete fields required by your operation. Paths containing [] describe list items; some fields depend on the selected mode.

Parameter	Type	Default	Values / limits
`credentialId`	`string`	`""`	-
`operation`	`string`	`"sendmail"`	-
`pathParams`	`string`	`"{}"`	-
`queryParams`	`string`	`"{}"`	-
`body`	`string`	`""`	-
`bodyFieldValues`	`string`	`"{}"`	-
`customMethod`	`enum`	`"post"`	`get`, `post`, `put`, `patch`, `delete`
`customPath`	`string`	`"/v3/mail/send"`	-
`requestMode`	`enum`	`"curated"`	`curated`, `advanced`

Available operations

ID	HTTP	Path / parameters
`activatetemplateversion`	`post`	`/v3/templates/{template_id}/versions/{version_id}/activate` - pathParams: `template_id`, `version_id` - body required
`addaccountips`	`post`	`/v3/partners/accounts/{accountID}/ips` - pathParams: `accountID` - `count` * (number), `region` * (string) - body required
`addintegration`	`post`	`/v3/marketing/integrations` - body required
`addip`	`post`	`/v3/send_ips/ips` - `is_auto_warmup` * (boolean), `is_parent_assigned` * (boolean), `include_region` (boolean), `region` (string), `subusers` (json) - body required
`addip_80`	`post`	`/v3/ips` - `count` * (number), `subusers` (json), `warmup` (boolean) - body required
`addipstoippool`	`post`	`/v3/send_ips/pools/{poolid}/ips:batchAdd` - pathParams: `poolid` - `ips` * (json) - body required
`addiptoallowlist`	`post`	`/v3/access_settings/whitelist` - `ips` * (json) - body required
`addiptoauthenticateddomain`	`post`	`/v3/whitelabel/domains/{id}/ips` - pathParams: `id` - `ip` * (string) - body required
`addiptoippool`	`post`	`/v3/ips/pools/{pool_name}/ips` - pathParams: `pool_name` - `ip` (string) - body required
`addrecipient`	`post`	`/v3/contactdb/recipients` - body required
`addrecipientstocontactdblist`	`post`	`/v3/contactdb/lists/{list_id}/recipients` - pathParams: `list_id` - body required
`addrecipienttocontactdblist`	`post`	`/v3/contactdb/lists/{list_id}/recipients/{recipient_id}` - pathParams: `list_id`, `recipient_id` - body required
`addsubuserstoip`	`post`	`/v3/send_ips/ips/{ip}/subusers:batchAdd` - pathParams: `ip` - `subusers` * (json) - body required
`addsuppressiontoasmgroup`	`post`	`/v3/asm/groups/{group_id}/suppressions` - pathParams: `group_id` - body required
`associatebrandedlinkwithsubuser`	`post`	`/v3/whitelabel/links/{link_id}/subuser` - pathParams: `link_id` - `username` (string) - body required
`associatesubuserwithdomain`	`post`	`/v3/whitelabel/domains/{domain_id}/subuser` - pathParams: `domain_id` - `username` * (string) - body required
`associatesubuserwithdomainmultiple`	`post`	`/v3/whitelabel/domains/{domain_id}/subuser:add` - pathParams: `domain_id` - `username` * (string) - body required
`authenticateaccount`	`post`	`/v3/partners/accounts/{accountID}/sso` - pathParams: `accountID` - body required
`authenticatedomain`	`post`	`/v3/whitelabel/domains` - `domain` * (string), `automatic_security` (boolean), `custom_dkim_selector` (string), `custom_spf` (boolean), `default` (boolean), `ips` (json), `region` (string), `subdomain` (string), `username` (string) - body required
`creatasmgroup`	`post`	`/v3/asm/groups` - body required
`createaccount`	`post`	`/v3/partners/accounts` - `offerings` * (json), `profile` (string) - body required
`createalert`	`post`	`/v3/alerts` - `email_to` * (string), `type` * (string), `frequency` (string), `percentage` (number) - body required
`createapikey`	`post`	`/v3/api_keys` - `name` * (string), `scopes` (json) - body required
`createbrandedlink`	`post`	`/v3/whitelabel/links` - `domain` * (string), `default` (string), `region` (string), `subdomain` (string) - body required
`createcampaign`	`post`	`/v3/campaigns` - body required
`createcontactdblist`	`post`	`/v3/contactdb/lists` - `name` * (string) - body required
`createcustomfield`	`post`	`/v3/contactdb/custom_fields` - `name` (string), `type` (string) - body required
`createdesign`	`post`	`/v3/designs` - body required
`createeventwebhook`	`post`	`/v3/user/webhooks/event/settings` - body required
`createfielddefinition`	`post`	`/v3/marketing/field_definitions` - `field_type` * (string), `name` * (string) - body required
`createglobalsuppression`	`post`	`/v3/asm/suppressions/global` - body required
`createippool`	`post`	`/v3/send_ips/pools` - `name` * (string), `ips` (json) - body required
`createippool_84`	`post`	`/v3/ips/pools` - `name` * (string) - body required
`createmailbatch`	`post`	`/v3/mail/batch` - body required
`createmarketinglist`	`post`	`/v3/marketing/lists` - `name` * (string) - body required
`createparsesetting`	`post`	`/v3/user/webhooks/parse/settings` - body required
`createscheduledsend`	`post`	`/v3/user/scheduled_sends` - `batch_id` * (string), `status` * (string) - body required
`createsecuritypolicy`	`post`	`/v3/user/webhooks/security/policies` - `name` (string), `oauth` (json), `signature` (json) - body required
`createsegment`	`post`	`/v3/contactdb/segments` - body required
`createsegment_208`	`post`	`/v3/marketing/segments/2.0` - body required
`createsender`	`post`	`/v3/senders` - `address` * (string), `city` * (string), `country` * (string), `nickname` * (string), `address_2` (string), `from` (json), `reply_to` (json), `state` (string), `zip` (string) - body required
`createsender_217`	`post`	`/v3/marketing/senders` - `address` * (string), `city` * (string), `country` * (string), `from` * (json), `nickname` * (string), `reply_to` * (json), `address_2` (string), `state` (string), `zip` (string) - body required
`createsinglesend`	`post`	`/v3/marketing/singlesends` - body required
`createssocertificate`	`post`	`/v3/sso/certificates` - `integration_id` * (string), `public_certificate` * (string), `enabled` (boolean) - body required
`createssointegration`	`post`	`/v3/sso/integrations` - body required
`createssoteammate`	`post`	`/v3/sso/teammates` - body required
`createsubuser`	`post`	`/v3/subusers` - `email` * (string), `ips` * (json), `password` * (string), `username` * (string), `include_region` (boolean), `region` (string) - body required
`createtemplate`	`post`	`/v3/templates` - `name` * (string), `generation` (string) - body required
`createtemplateversion`	`post`	`/v3/templates/{template_id}/versions` - pathParams: `template_id` - body required
`createverifiedsender`	`post`	`/v3/verified_senders` - body required
`deleteaccount`	`delete`	`/v3/partners/accounts/{accountID}` - pathParams: `accountID`
`deletealert`	`delete`	`/v3/alerts/{alert_id}` - pathParams: `alert_id`
`deleteallowedip`	`delete`	`/v3/access_settings/whitelist/{rule_id}` - pathParams: `rule_id`
`deleteallowedips`	`delete`	`/v3/access_settings/whitelist`
`deleteapikey`	`delete`	`/v3/api_keys/{api_key_id}` - pathParams: `api_key_id`
`deleteasmgroup`	`delete`	`/v3/asm/groups/{group_id}` - pathParams: `group_id`
`deleteauthenticateddomain`	`delete`	`/v3/whitelabel/domains/{domain_id}` - pathParams: `domain_id`
`deletebrandedlink`	`delete`	`/v3/whitelabel/links/{id}` - pathParams: `id`
`deletecampaign`	`delete`	`/v3/campaigns/{campaign_id}` - pathParams: `campaign_id`
`deletecontact`	`delete`	`/v3/marketing/contacts`
`deletecontact_205`	`delete`	`/v3/marketing/lists/{id}/contacts` - pathParams: `id`
`deletecontactdblist`	`delete`	`/v3/contactdb/lists/{list_id}` - pathParams: `list_id`
`deletecontactdblists`	`delete`	`/v3/contactdb/lists`
`deletecontactidentifier`	`delete`	`/v3/marketing/contacts/{contact_id}/identifiers` - pathParams: `contact_id`
`deletecustomfield`	`delete`	`/v3/contactdb/custom_fields/{custom_field_id}` - pathParams: `custom_field_id`
`deletedesign`	`delete`	`/v3/designs/{id}` - pathParams: `id`
`deleteeventwebhook`	`delete`	`/v3/user/webhooks/event/settings/{id}` - pathParams: `id`
`deletefielddefinition`	`delete`	`/v3/marketing/field_definitions/{custom_field_id}` - pathParams: `custom_field_id`
`deleteglobalsuppression`	`delete`	`/v3/asm/suppressions/global/{email}` - pathParams: `email`
`deleteintegration`	`delete`	`/v3/marketing/integrations`
`deleteinvalidemail`	`delete`	`/v3/suppression/invalid_emails/{email}` - pathParams: `email`
`deleteinvalidemails`	`delete`	`/v3/suppression/invalid_emails`
`deleteipfromauthenticateddomain`	`delete`	`/v3/whitelabel/domains/{id}/ips/{ip}` - pathParams: `id`, `ip`
`deleteipfromippool`	`delete`	`/v3/ips/pools/{pool_name}/ips/{ip}` - pathParams: `pool_name`, `ip`
`deleteippool`	`delete`	`/v3/send_ips/pools/{poolid}` - pathParams: `poolid`
`deleteippool_87`	`delete`	`/v3/ips/pools/{pool_name}` - pathParams: `pool_name`
`deleteipsfromippool`	`post`	`/v3/send_ips/pools/{poolid}/ips:batchDelete` - pathParams: `poolid` - `ips` * (json) - body required
`deletemarketinglist`	`delete`	`/v3/marketing/lists/{id}` - pathParams: `id`
`deleteparsesetting`	`delete`	`/v3/user/webhooks/parse/settings/{hostname}` - pathParams: `hostname`
`deletependingteammate`	`delete`	`/v3/teammates/pending/{token}` - pathParams: `token`
`deleterecipient`	`delete`	`/v3/contactdb/recipients/{recipient_id}` - pathParams: `recipient_id`
`deleterecipientfromcontactdblist`	`delete`	`/v3/contactdb/lists/{list_id}/recipients/{recipient_id}` - pathParams: `list_id`, `recipient_id`
`deleterecipients`	`delete`	`/v3/contactdb/recipients`
`deletereversedns`	`delete`	`/v3/whitelabel/ips/{id}` - pathParams: `id`
`deletescheduledsend`	`delete`	`/v3/user/scheduled_sends/{batch_id}` - pathParams: `batch_id`
`deletescheduledsinglesend`	`delete`	`/v3/marketing/singlesends/{id}/schedule` - pathParams: `id`
`deletesecuritypolicy`	`delete`	`/v3/user/webhooks/security/policies/{id}` - pathParams: `id`
`deletesegment`	`delete`	`/v3/contactdb/segments/{segment_id}` - pathParams: `segment_id`
`deletesegment_211`	`delete`	`/v3/marketing/segments/2.0/{segment_id}` - pathParams: `segment_id`
`deletesegment_215`	`delete`	`/v3/marketing/segments/{segment_id}` - pathParams: `segment_id`
`deletesender`	`delete`	`/v3/senders/{sender_id}` - pathParams: `sender_id`
`deletesender_220`	`delete`	`/v3/marketing/senders/{id}` - pathParams: `id`
`deletesinglesend`	`delete`	`/v3/marketing/singlesends/{id}` - pathParams: `id`
`deletesinglesends`	`delete`	`/v3/marketing/singlesends`
`deletespamreport`	`delete`	`/v3/suppression/spam_reports/{email}` - pathParams: `email`
`deletespamreports`	`delete`	`/v3/suppression/spam_reports`
`deletessocertificate`	`delete`	`/v3/sso/certificates/{cert_id}` - pathParams: `cert_id`
`deletessointegration`	`delete`	`/v3/sso/integrations/{id}` - pathParams: `id`
`deletesubuser`	`delete`	`/v3/subusers/{subuser_name}` - pathParams: `subuser_name`
`deletesubusersfromip`	`post`	`/v3/send_ips/ips/{ip}/subusers:batchDelete` - pathParams: `ip` - `subusers` * (json) - body required
`deletesuppressionblock`	`delete`	`/v3/suppression/blocks/{email}` - pathParams: `email`
`deletesuppressionblocks`	`delete`	`/v3/suppression/blocks`
`deletesuppressionbounce`	`delete`	`/v3/suppression/bounces/{email}` - pathParams: `email`
`deletesuppressionbounces`	`delete`	`/v3/suppression/bounces`
`deletesuppressionfromasmgroup`	`delete`	`/v3/asm/groups/{group_id}/suppressions/{email}` - pathParams: `group_id`, `email`
`deleteteammate`	`delete`	`/v3/teammates/{username}` - pathParams: `username`
`deletetemplate`	`delete`	`/v3/templates/{template_id}` - pathParams: `template_id`
`deletetemplateversion`	`delete`	`/v3/templates/{template_id}/versions/{version_id}` - pathParams: `template_id`, `version_id`
`deleteverifiedsender`	`delete`	`/v3/verified_senders/{id}` - pathParams: `id`
`disassociateauthenticateddomainfromuser`	`delete`	`/v3/whitelabel/domains/subuser`
`disassociatebrandedlinkfromsubuser`	`delete`	`/v3/whitelabel/links/subuser`
`disassociatesubuserfromdomain`	`delete`	`/v3/whitelabel/domains/{domain_id}/subuser` - pathParams: `domain_id`
`downloadcsv`	`get`	`/v3/messages/download/{download_uuid}` - pathParams: `download_uuid`
`duplicatedesign`	`post`	`/v3/designs/{id}` - pathParams: `id` - body required
`duplicateprebuiltdesign`	`post`	`/v3/designs/pre-builts/{id}` - pathParams: `id` - body required
`duplicatesinglesend`	`post`	`/v3/marketing/singlesends/{id}` - pathParams: `id` - `name` (string) - body required
`duplicatetemplate`	`post`	`/v3/templates/{template_id}` - pathParams: `template_id` - `name` (string) - body required
`emaildnsrecord`	`post`	`/v3/whitelabel/dns/email` - `domain_id` * (number), `email` * (string), `link_id` * (number), `message` (string) - body required
`eraserecipientemaildata`	`post`	`/v3/recipients/erasejob` - body required
`exportautomationstat`	`get`	`/v3/marketing/stats/automations/export`
`exportcontact`	`post`	`/v3/marketing/contacts/exports` - `file_type` (string), `list_ids` (json), `max_file_size` (number), `notifications` (json), `segment_ids` (json) - body required
`exportrecipient`	`post`	`/v3/contactdb/exports` - `file_type` (string), `list_ids` (json), `max_file_size` (number), `notifications` (json), `segment_ids` (json) - body required
`exportsinglesendstat`	`get`	`/v3/marketing/stats/singlesends/export`
`findintegrationbyid`	`get`	`/v3/marketing/integrations/{id}` - pathParams: `id`
`getaccountstate`	`get`	`/v3/partners/accounts/{accountID}/state` - pathParams: `accountID`
`getalert`	`get`	`/v3/alerts/{alert_id}` - pathParams: `alert_id`
`getallowedip`	`get`	`/v3/access_settings/whitelist/{rule_id}` - pathParams: `rule_id`
`getapikey`	`get`	`/v3/api_keys/{api_key_id}` - pathParams: `api_key_id`
`getasmgroup`	`get`	`/v3/asm/groups/{group_id}` - pathParams: `group_id`
`getasmsuppression`	`get`	`/v3/asm/suppressions/{email}` - pathParams: `email`
`getauthenticateddomain`	`get`	`/v3/whitelabel/domains/{domain_id}` - pathParams: `domain_id`
`getautomationstat`	`get`	`/v3/marketing/stats/automations/{id}` - pathParams: `id`
`getbillable`	`get`	`/v3/contactdb/recipients/billable_count`
`getbrandedlink`	`get`	`/v3/whitelabel/links/{id}` - pathParams: `id`
`getcampaign`	`get`	`/v3/campaigns/{campaign_id}` - pathParams: `campaign_id`
`getclientstat`	`get`	`/v3/clients/{client_type}/stats` - pathParams: `client_type`
`getcontact`	`get`	`/v3/marketing/contacts/{id}` - pathParams: `id`
`getcontactbyidentifiers`	`post`	`/v3/marketing/contacts/search/identifiers/{identifier_type}` - pathParams: `identifier_type` - `identifiers` * (json) - body required
`getcontactdblist`	`get`	`/v3/contactdb/lists/{list_id}` - pathParams: `list_id`
`getcustomfield`	`get`	`/v3/contactdb/custom_fields/{custom_field_id}` - pathParams: `custom_field_id`
`getdesign`	`get`	`/v3/designs/{id}` - pathParams: `id`
`getemailjobforverification`	`get`	`/v3/validations/email/jobs/{job_id}` - pathParams: `job_id`
`geteventwebhook`	`get`	`/v3/user/webhooks/event/settings/{id}` - pathParams: `id`
`getexportcontact`	`get`	`/v3/marketing/contacts/exports/{id}` - pathParams: `id`
`getexportrecipient`	`get`	`/v3/contactdb/exports/{id}` - pathParams: `id`
`getglobalsuppression`	`get`	`/v3/asm/suppressions/global/{email}` - pathParams: `email`
`getimportcontact`	`get`	`/v3/marketing/contacts/imports/{id}` - pathParams: `id`
`getintegrationsbyuser`	`get`	`/v3/marketing/integrations`
`getinvalidemail`	`get`	`/v3/suppression/invalid_emails/{email}` - pathParams: `email`
`getip`	`get`	`/v3/send_ips/ips/{ip}` - pathParams: `ip`
`getip_81`	`get`	`/v3/ips/{ip_address}` - pathParams: `ip_address`
`getippool`	`get`	`/v3/send_ips/pools/{poolid}` - pathParams: `poolid`
`getippool_85`	`get`	`/v3/ips/pools/{pool_name}` - pathParams: `pool_name`
`getmailbatch`	`get`	`/v3/mail/batch/{batch_id}` - pathParams: `batch_id`
`getmarketinglist`	`get`	`/v3/marketing/lists/{id}` - pathParams: `id`
`getmessage`	`get`	`/v3/messages/{msg_id}` - pathParams: `msg_id`
`getmessagebyid`	`get`	`/v3/logs/{sg_message_id}` - pathParams: `sg_message_id`
`getparsesetting`	`get`	`/v3/user/webhooks/parse/settings/{hostname}` - pathParams: `hostname`
`getprebuiltdesign`	`get`	`/v3/designs/pre-builts/{id}` - pathParams: `id`
`getrecipient`	`get`	`/v3/contactdb/recipients/{recipient_id}` - pathParams: `recipient_id`
`getrecipientlist`	`get`	`/v3/contactdb/recipients/{recipient_id}/lists` - pathParams: `recipient_id`
`getreversedns`	`get`	`/v3/whitelabel/ips/{id}` - pathParams: `id`
`getscheduledcampaign`	`get`	`/v3/campaigns/{campaign_id}/schedules` - pathParams: `campaign_id`
`getscheduledsend`	`get`	`/v3/user/scheduled_sends/{batch_id}` - pathParams: `batch_id`
`getsecuritypolicy`	`get`	`/v3/user/webhooks/security/policies/{id}` - pathParams: `id`
`getsegment`	`get`	`/v3/contactdb/segments/{segment_id}` - pathParams: `segment_id`
`getsegment_209`	`get`	`/v3/marketing/segments/2.0/{segment_id}` - pathParams: `segment_id`
`getsegment_214`	`get`	`/v3/marketing/segments/{segment_id}` - pathParams: `segment_id`
`getsender`	`get`	`/v3/senders/{sender_id}` - pathParams: `sender_id`
`getsender_218`	`get`	`/v3/marketing/senders/{id}` - pathParams: `id`
`getsignedeventwebhook`	`get`	`/v3/user/webhooks/event/settings/signed/{id}` - pathParams: `id`
`getsinglesend`	`get`	`/v3/marketing/singlesends/{id}` - pathParams: `id`
`getsinglesendstat`	`get`	`/v3/marketing/stats/singlesends/{id}` - pathParams: `id`
`getspamreport`	`get`	`/v3/suppression/spam_reports/{email}` - pathParams: `email`
`getssocertificate`	`get`	`/v3/sso/certificates/{cert_id}` - pathParams: `cert_id`
`getssointegration`	`get`	`/v3/sso/integrations/{id}` - pathParams: `id`
`getsubusercredit`	`get`	`/v3/subusers/{subuser_name}/credits` - pathParams: `subuser_name`
`getsuppressionblock`	`get`	`/v3/suppression/blocks/{email}` - pathParams: `email`
`getsuppressionbounces`	`get`	`/v3/suppression/bounces/{email}` - pathParams: `email`
`getsuppressionbouncesclassifications`	`get`	`/v3/suppression/bounces/classifications/{classification}` - pathParams: `classification`
`getteammate`	`get`	`/v3/teammates/{username}` - pathParams: `username`
`gettemplate`	`get`	`/v3/templates/{template_id}` - pathParams: `template_id`
`gettemplateversion`	`get`	`/v3/templates/{template_id}/versions/{version_id}` - pathParams: `template_id`, `version_id`
`getvalidationsemailjobs`	`get`	`/v3/validations/email/jobs`
`getwarmupip`	`get`	`/v3/ips/warmup/{ip_address}` - pathParams: `ip_address`
`importcontact`	`put`	`/v3/marketing/contacts/imports` - `field_mappings` * (json), `file_type` * (string), `list_ids` (json) - body required
`inviteteammate`	`post`	`/v3/teammates` - `email` * (string), `is_admin` * (boolean), `scopes` * (json) - body required
`listaccessactivity`	`get`	`/v3/access_settings/activity`
`listaccount`	`get`	`/v3/partners/accounts`
`listaccount_355`	`get`	`/v3/user/account`
`listaccountips`	`get`	`/v3/partners/accounts/{accountID}/ips` - pathParams: `accountID`
`listaccountoffering`	`get`	`/v3/partners/accounts/{accountID}/offerings` - pathParams: `accountID`
`listaddresswhitelist`	`get`	`/v3/mail_settings/address_whitelist`
`listalert`	`get`	`/v3/alerts`
`listallauthenticateddomainwithuser`	`get`	`/v3/whitelabel/domains/subuser/all`
`listallowedip`	`get`	`/v3/access_settings/whitelist`
`listallsecuritypolicies`	`get`	`/v3/user/webhooks/security/policies`
`listapikey`	`get`	`/v3/api_keys`
`listasmgroup`	`get`	`/v3/asm/groups`
`listasmsuppression`	`get`	`/v3/asm/suppressions`
`listassignedip`	`get`	`/v3/ips/assigned`
`listauthenticateddomain`	`get`	`/v3/whitelabel/domains`
`listauthenticateddomainwithuser`	`get`	`/v3/whitelabel/domains/subuser`
`listautomationstat`	`get`	`/v3/marketing/stats/automations`
`listbatchedcontact`	`post`	`/v3/marketing/contacts/batch` - `ids` * (json) - body required
`listbouncepurge`	`get`	`/v3/mail_settings/bounce_purge`
`listbrandedlink`	`get`	`/v3/whitelabel/links`
`listbrowserstat`	`get`	`/v3/browsers/stats`
`listcampaign`	`get`	`/v3/campaigns`
`listcategory`	`get`	`/v3/marketing/singlesends/categories`
`listcategory_270`	`get`	`/v3/categories`
`listcategorystat`	`get`	`/v3/categories/stats`
`listcategorystatsum`	`get`	`/v3/categories/stats/sums`
`listclicktrackingsetting`	`get`	`/v3/tracking_settings/click`
`listclicktrackingstat`	`get`	`/v3/marketing/stats/automations/{id}/links` - pathParams: `id`
`listclientstat`	`get`	`/v3/clients/stats`
`listcontact`	`get`	`/v3/marketing/contacts`
`listcontactbyemail`	`post`	`/v3/marketing/contacts/search/emails` - `emails` * (json), `anonymous_id` (string), `external_id` (string), `phone_number_id` (string) - body required
`listcontactcount`	`get`	`/v3/marketing/contacts/count`
`listcontactcount_206`	`get`	`/v3/marketing/lists/{id}/contacts/count` - pathParams: `id`
`listcontactdblist`	`get`	`/v3/contactdb/lists`
`listcredit`	`get`	`/v3/user/credits`
`listcustomfield`	`get`	`/v3/contactdb/custom_fields`
`listdefaultauthenticateddomain`	`get`	`/v3/whitelabel/domains/default`
`listdefaultbrandedlink`	`get`	`/v3/whitelabel/links/default`
`listdesign`	`get`	`/v3/designs`
`listdevicestat`	`get`	`/v3/devices/stats`
`listemail`	`get`	`/v3/user/email`
`listemailjobforverification`	`put`	`/v3/validations/email/jobs` - `file_type` * (string) - body required
`listenforcedtlssetting`	`get`	`/v3/user/settings/enforced_tls`
`listengagementqualityscore`	`get`	`/v3/engagementquality/scores`
`listeventwebhook`	`get`	`/v3/user/webhooks/event/settings/all`
`listexportcontact`	`get`	`/v3/marketing/contacts/exports`
`listexportrecipient`	`get`	`/v3/contactdb/exports`
`listfielddefinition`	`get`	`/v3/marketing/field_definitions`
`listfooter`	`get`	`/v3/mail_settings/footer`
`listforwardbounce`	`get`	`/v3/mail_settings/forward_bounce`
`listforwardspam`	`get`	`/v3/mail_settings/forward_spam`
`listgeostat`	`get`	`/v3/geo/stats`
`listglobalsuppression`	`get`	`/v3/suppression/unsubscribes`
`listgoogleanalyticstrackingsetting`	`get`	`/v3/tracking_settings/google_analytics`
`listinvalidemail`	`get`	`/v3/suppression/invalid_emails`
`listip`	`get`	`/v3/send_ips/ips`
`listip_79`	`get`	`/v3/ips`
`listipassignedtoippool`	`get`	`/v3/send_ips/pools/{poolid}/ips` - pathParams: `poolid`
`listippool`	`get`	`/v3/send_ips/pools`
`listippool_83`	`get`	`/v3/ips/pools`
`listmailboxproviderstat`	`get`	`/v3/mailbox_providers/stats`
`listmailsetting`	`get`	`/v3/mail_settings`
`listmarketinglist`	`get`	`/v3/marketing/lists`
`listmessage`	`get`	`/v3/messages`
`listmessagesbyfilter`	`post`	`/v3/logs` - body required
`listmonthlystat`	`get`	`/v3/subusers/stats/monthly`
`listoffering`	`get`	`/v3/partners/offerings`
`listopentrackingsetting`	`get`	`/v3/tracking_settings/open`
`listparsesetting`	`get`	`/v3/user/webhooks/parse/settings`
`listparsestatic`	`get`	`/v3/user/webhooks/parse/stats`
`listpartnersetting`	`get`	`/v3/partner_settings`
`listpendingteammate`	`get`	`/v3/teammates/pending`
`listprebuiltdesign`	`get`	`/v3/designs/pre-builts`
`listprofile`	`get`	`/v3/user/profile`
`listrecipient`	`get`	`/v3/contactdb/recipients`
`listrecipientcount`	`get`	`/v3/contactdb/recipients/count`
`listrecipientforsegment`	`get`	`/v3/contactdb/segments/{segment_id}/recipients` - pathParams: `segment_id`
`listrecipientsfromcontactdblist`	`get`	`/v3/contactdb/lists/{list_id}/recipients` - pathParams: `list_id`
`listremainingipcount`	`get`	`/v3/ips/remaining`
`listreputation`	`get`	`/v3/subusers/reputations`
`listreservedfield`	`get`	`/v3/contactdb/reserved_fields`
`listreversedns`	`get`	`/v3/whitelabel/ips`
`listscheduledsend`	`get`	`/v3/user/scheduled_sends`
`listscope`	`get`	`/v3/scopes`
`listsearchrecipient`	`get`	`/v3/contactdb/recipients/search`
`listsegment`	`get`	`/v3/contactdb/segments`
`listsegment_207`	`get`	`/v3/marketing/segments/2.0`
`listsegment_213`	`get`	`/v3/marketing/segments`
`listsender`	`get`	`/v3/senders`
`listsender_216`	`get`	`/v3/marketing/senders`
`listsinglesend`	`get`	`/v3/marketing/singlesends`
`listsinglesendstat`	`get`	`/v3/marketing/stats/singlesends`
`listsinglesendtrackingstat`	`get`	`/v3/marketing/stats/singlesends/{id}/links` - pathParams: `id`
`listspamreport`	`get`	`/v3/suppression/spam_reports`
`listssointegration`	`get`	`/v3/sso/integrations`
`listssointegrationcertificate`	`get`	`/v3/sso/integrations/{integration_id}/certificates` - pathParams: `integration_id`
`liststat`	`get`	`/v3/stats`
`liststat_290`	`get`	`/v3/subusers/stats`
`liststatsum`	`get`	`/v3/subusers/stats/sums`
`liststatus`	`get`	`/v3/contactdb/status`
`listsubscriptiontrackingsetting`	`get`	`/v3/tracking_settings/subscription`
`listsubuser`	`get`	`/v3/subusers`
`listsubuserassignedtoip`	`get`	`/v3/send_ips/ips/{ip}/subusers` - pathParams: `ip`
`listsubuserbrandedlink`	`get`	`/v3/whitelabel/links/subuser`
`listsubuserbytemplate`	`get`	`/v3/teammates/{teammate_name}/subuser_access` - pathParams: `teammate_name`
`listsubuserengagementqualityscore`	`get`	`/v3/engagementquality/subusers/scores`
`listsubusermonthlystat`	`get`	`/v3/subusers/{subuser_name}/stats/monthly` - pathParams: `subuser_name`
`listsuppressionblock`	`get`	`/v3/suppression/blocks`
`listsuppressionbounces`	`get`	`/v3/suppression/bounces`
`listsuppressionbouncesclassifications`	`get`	`/v3/suppression/bounces/classifications`
`listsuppressionfromasmgroup`	`get`	`/v3/asm/groups/{group_id}/suppressions` - pathParams: `group_id`
`listteammate`	`get`	`/v3/teammates`
`listtemplate`	`get`	`/v3/mail_settings/template`
`listtemplate_335`	`get`	`/v3/templates`
`listtrackingsetting`	`get`	`/v3/tracking_settings`
`listusername`	`get`	`/v3/user/username`
`listverifiedsender`	`get`	`/v3/verified_senders`
`listverifiedsenderdomain`	`get`	`/v3/verified_senders/domains`
`listverifiedsenderstepscompleted`	`get`	`/v3/verified_senders/steps_completed`
`listwarmupip`	`get`	`/v3/ips/warmup`
`refreshsegment`	`post`	`/v3/marketing/segments/2.0/refresh/{segment_id}` - pathParams: `segment_id` - body required
`removeaccountips`	`delete`	`/v3/partners/accounts/{accountID}/ips` - pathParams: `accountID`
`requestcsv`	`post`	`/v3/messages/download` - body required
`resendteammateinvite`	`post`	`/v3/teammates/pending/{token}/resend` - pathParams: `token` - body required
`resendverifiedsender`	`post`	`/v3/verified_senders/resend/{id}` - pathParams: `id` - body required
`resetsenderverification`	`post`	`/v3/senders/{sender_id}/resend_verification` - pathParams: `sender_id` - body required
`resetsenderverification_221`	`post`	`/v3/marketing/senders/{id}/resend_verification` - pathParams: `id` - body required
`schedulecampaign`	`post`	`/v3/campaigns/{campaign_id}/schedules` - pathParams: `campaign_id` - `send_at` * (number) - body required
`schedulesinglesend`	`put`	`/v3/marketing/singlesends/{id}/schedule` - pathParams: `id` - `send_at` * (string) - body required
`searchcontact`	`post`	`/v3/marketing/contacts/search` - `query` * (string) - body required
`searchrecipient`	`post`	`/v3/contactdb/recipients/search` - `conditions` * (json), `list_id` * (number) - body required
`searchsinglesend`	`post`	`/v3/marketing/singlesends/search` - body required
`searchsuppressionfromasmgroup`	`post`	`/v3/asm/groups/{group_id}/suppressions/search` - pathParams: `group_id` - body required
`sendcampaign`	`post`	`/v3/campaigns/{campaign_id}/schedules/now` - pathParams: `campaign_id` - body required
`sendmail`	`post`	`/v3/mail/send` - body required
`sendtestcampaign`	`post`	`/v3/campaigns/{campaign_id}/schedules/test` - pathParams: `campaign_id` - `to` * (string) - body required
`sendtestmarketingemail`	`post`	`/v3/marketing/test/send_email` - `emails` * (json), `template_id` * (string), `custom_unsubscribe_url` (string), `from_address` (string), `sender_id` (number), `suppression_group_id` (number), `version_id_override` (string) - body required
`setupreversedns`	`post`	`/v3/whitelabel/ips` - `domain` * (string), `ip` * (string), `subdomain` (string) - body required
`stopipwarmup`	`delete`	`/v3/ips/warmup/{ip_address}` - pathParams: `ip_address`
`testeventwebhook`	`post`	`/v3/user/webhooks/event/test` - body required
`unschedulecampaign`	`delete`	`/v3/campaigns/{campaign_id}/schedules` - pathParams: `campaign_id`
`updateaccountoffering`	`put`	`/v3/partners/accounts/{accountID}/offerings` - pathParams: `accountID` - `offerings` * (json) - body required
`updateaccountstate`	`put`	`/v3/partners/accounts/{accountID}/state` - pathParams: `accountID` - body required
`updateaddresswhitelist`	`patch`	`/v3/mail_settings/address_whitelist` - `enabled` (boolean), `list` (json) - body required
`updatealert`	`patch`	`/v3/alerts/{alert_id}` - pathParams: `alert_id` - `email_to` (string), `frequency` (string), `percentage` (number) - body required
`updateapikey`	`put`	`/v3/api_keys/{api_key_id}` - pathParams: `api_key_id` - `name` * (string), `scopes` (json) - body required
`updateapikeyname`	`patch`	`/v3/api_keys/{api_key_id}` - pathParams: `api_key_id` - `name` * (string) - body required
`updateasmgroup`	`patch`	`/v3/asm/groups/{group_id}` - pathParams: `group_id` - `description` (string), `is_default` (boolean), `name` (string) - body required
`updateauthenticateddomain`	`patch`	`/v3/whitelabel/domains/{domain_id}` - pathParams: `domain_id` - `custom_spf` (boolean), `default` (boolean) - body required
`updatebouncepurge`	`patch`	`/v3/mail_settings/bounce_purge` - body required
`updatebrandedlink`	`patch`	`/v3/whitelabel/links/{id}` - pathParams: `id` - `default` (string) - body required
`updatecampaign`	`patch`	`/v3/campaigns/{campaign_id}` - pathParams: `campaign_id` - `categories` * (json), `html_content` * (string), `plain_content` * (string), `subject` * (string), `title` * (string) - body required
`updateclicktrackingsetting`	`patch`	`/v3/tracking_settings/click` - `enabled` (boolean) - body required
`updatecontact`	`put`	`/v3/marketing/contacts` - `contacts` * (json), `list_ids` (json) - body required
`updatecontactdblist`	`patch`	`/v3/contactdb/lists/{list_id}` - pathParams: `list_id` - `name` * (string) - body required
`updatedesign`	`patch`	`/v3/designs/{id}` - pathParams: `id` - `categories` (json), `generate_plain_content` (boolean), `html_content` (string), `name` (string), `plain_content` (string), `subject` (string) - body required
`updateemail`	`put`	`/v3/user/email` - `email` (string) - body required
`updateenforcedtlssetting`	`patch`	`/v3/user/settings/enforced_tls` - body required
`updateeventwebhook`	`patch`	`/v3/user/webhooks/event/settings/{id}` - pathParams: `id` - body required
`updatefielddefinition`	`patch`	`/v3/marketing/field_definitions/{custom_field_id}` - pathParams: `custom_field_id` - `name` * (string) - body required
`updatefooter`	`patch`	`/v3/mail_settings/footer` - body required
`updateforwardbounce`	`patch`	`/v3/mail_settings/forward_bounce` - body required
`updateforwardspam`	`patch`	`/v3/mail_settings/forward_spam` - body required
`updategoogleanalyticstrackingsetting`	`patch`	`/v3/tracking_settings/google_analytics` - body required
`updateintegration`	`patch`	`/v3/marketing/integrations/{id}` - pathParams: `id` - body required
`updateip`	`patch`	`/v3/send_ips/ips/{ip}` - pathParams: `ip` - `is_auto_warmup` (boolean), `is_enabled` (boolean), `is_parent_assigned` (boolean) - body required
`updateippool`	`put`	`/v3/send_ips/pools/{poolid}` - pathParams: `poolid` - `name` * (string) - body required
`updateippool_86`	`put`	`/v3/ips/pools/{pool_name}` - pathParams: `pool_name` - `name` (string) - body required
`updatemarketinglist`	`patch`	`/v3/marketing/lists/{id}` - pathParams: `id` - `name` (string) - body required
`updateopentrackingsetting`	`patch`	`/v3/tracking_settings/open` - `enabled` (boolean) - body required
`updateparsesetting`	`patch`	`/v3/user/webhooks/parse/settings/{hostname}` - pathParams: `hostname` - body required
`updatepassword`	`put`	`/v3/user/password` - `new_password` * (string), `old_password` * (string) - body required
`updateprofile`	`patch`	`/v3/user/profile` - body required
`updaterecipient`	`patch`	`/v3/contactdb/recipients` - body required
`updatescheduledcampaign`	`patch`	`/v3/campaigns/{campaign_id}/schedules` - pathParams: `campaign_id` - `send_at` * (number) - body required
`updatescheduledsend`	`patch`	`/v3/user/scheduled_sends/{batch_id}` - pathParams: `batch_id` - `status` * (string) - body required
`updatesecuritypolicy`	`patch`	`/v3/user/webhooks/security/policies/{id}` - pathParams: `id` - `name` (string), `oauth` (json), `signature` (json) - body required
`updatesegment`	`patch`	`/v3/contactdb/segments/{segment_id}` - pathParams: `segment_id` - `name` * (string), `conditions` (json), `list_id` (number) - body required
`updatesegment_210`	`patch`	`/v3/marketing/segments/2.0/{segment_id}` - pathParams: `segment_id` - body required
`updatesender`	`patch`	`/v3/senders/{sender_id}` - pathParams: `sender_id` - body required
`updatesender_219`	`patch`	`/v3/marketing/senders/{id}` - pathParams: `id` - body required
`updatesignedeventwebhook`	`patch`	`/v3/user/webhooks/event/settings/signed/{id}` - pathParams: `id` - `enabled` * (boolean) - body required
`updatesinglesend`	`patch`	`/v3/marketing/singlesends/{id}` - pathParams: `id` - body required
`updatessocertificate`	`patch`	`/v3/sso/certificates/{cert_id}` - pathParams: `cert_id` - `enabled` (boolean), `integration_id` (string), `public_certificate` (string) - body required
`updatessointegration`	`patch`	`/v3/sso/integrations/{id}` - pathParams: `id` - body required
`updatessoteammate`	`patch`	`/v3/sso/teammates/{username}` - pathParams: `username` - body required
`updatesubscriptiontrackingsetting`	`patch`	`/v3/tracking_settings/subscription` - body required
`updatesubuser`	`patch`	`/v3/subusers/{subuser_name}` - pathParams: `subuser_name` - `disabled` (boolean) - body required
`updatesubusercredit`	`put`	`/v3/subusers/{subuser_name}/credits` - pathParams: `subuser_name` - body required
`updatesubuserip`	`put`	`/v3/subusers/{subuser_name}/ips` - pathParams: `subuser_name` - body required
`updatesubuserremainingcredit`	`patch`	`/v3/subusers/{subuser_name}/credits/remaining` - pathParams: `subuser_name` - `allocation_update` * (number) - body required
`updatesubuserwebsiteaccess`	`patch`	`/v3/subusers/{subuser_name}/website_access` - pathParams: `subuser_name` - `disabled` (boolean) - body required
`updateteammate`	`patch`	`/v3/teammates/{username}` - pathParams: `username` - `is_admin` * (boolean), `scopes` * (json) - body required
`updatetemplate`	`patch`	`/v3/mail_settings/template` - `enabled` (boolean), `html_content` (string) - body required
`updatetemplate_339`	`patch`	`/v3/templates/{template_id}` - pathParams: `template_id` - `name` (string) - body required
`updatetemplateversion`	`patch`	`/v3/templates/{template_id}/versions/{version_id}` - pathParams: `template_id`, `version_id` - body required
`updateusername`	`put`	`/v3/user/username` - `username` (string) - body required
`updateverifiedsender`	`patch`	`/v3/verified_senders/{id}` - pathParams: `id` - body required
`validateauthenticateddomain`	`post`	`/v3/whitelabel/domains/{id}/validate` - pathParams: `id` - body required
`validatebrandedlink`	`post`	`/v3/whitelabel/links/{id}/validate` - pathParams: `id` - body required
`validateemail`	`post`	`/v3/validations/email` - `email` * (string), `source` (string) - body required
`validatereversedns`	`post`	`/v3/whitelabel/ips/{id}/validate` - pathParams: `id` - body required
`verifysendertoken`	`get`	`/v3/verified_senders/verify/{token}` - pathParams: `token`
`warmupip`	`post`	`/v3/ips/warmup` - `ip` (string) - body required
`custom_request`	`post`	`{customPath}` - pathParams: `customPath`

An asterisk marks an operation-required parameter. Body fields and permissions depend on the selected operation; use its guided form and the provider’s official reference.

Initial configuration

Initial catalog configuration example, to adapt before running. Keep secrets in credentials.

json

{
  "credentialId": "",
  "operation": "sendmail",
  "pathParams": "{}",
  "queryParams": "{}",
  "body": "",
  "bodyFieldValues": "{}",
  "customMethod": "post",
  "customPath": "/v3/mail/send",
  "requestMode": "curated"
}

Verification

Test with representative data. Check node output in the inspector and logs, then use editor mapping for downstream fields. A trigger test with a simulated payload does not validate external service delivery.