View SendGrid Docs for Sending Mail
Sends email, using SendGrid's REST API. The parameter mail must be an instance of the helpers.mail component. The README provides examples of how to build and send an email.
View SendGrid Docs for API Keys
Retrieve all API Keys belonging to the authenticated user. The parameter limit limits the number of rows returned. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Retrieve an existing API Key. The parameter api_key_id is the ID of the API Key for which you are requesting information. The SendGrid docs for this endpoint explain where to find this. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Creates an API key. The parameter name should be the name of your new key. The parameter scopes refers to the individual permissions that you are giving to this API Key ( options listed here ). The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Delete an API key. The parameter api_key_id is the ID of the API Key for which you are requesting information. The SendGrid docs for this endpoint explain where to find this. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Updates the name of an existing API Key. The parameter api_key_id is the ID of the API Key for which you are requesting information. The SendGrid docs for this endpoint explain where to find this. The parameter name is the new name for the API Key that you are updating. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
updateAPIKey( required string api_key_id, required string name, array scopes=['mail.send'], string on_behalf_of="" )
Updates the name and scopes of a given API key. The parameter api_key_id is the ID of the API Key for which you are requesting information. The SendGrid docs for this endpoint explain where to find this. The parameter name is the updated name for the API Key that you are updating. It is required. The parameter scopes is optional and defaults to mail.send. It refers to the individual permissions that you are giving to this API Key ( options listed here ). The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
View SendGrid Docs for Subusers
Retrieve a list of all of your subusers. The parameter username is the username of the subuser to return. (Optional). The parameter limit limits the number of results you would like to get in each request. (Optional). The parameter offset is the number of subusers to skip (Optional). Endpoint docs
Retrieves monitor settings for a subuser. The parameter subuser_name is the name of the subuser to return. Endpoint docs
Retrieves subuser reputations. The parameter usernames is the name of the subuser that you are obtaining the reputation score for. Endpoint docs
getSubuserMonthlyStats( required string subuser_name, required string date="", string sort_by_metric="", string sort_by_direction="", numeric limit=0, numeric offset=0 )
Retrieve the monthly email statistics for a single subuser. The parameter subuser_name is the name of the subuser to return. The parameter date is the date the statistics were gathered in the format: YYYY-MM-DD. Endpoint docs
getSubuserMonthlyStatsAllSubusers( required string date="", string subuser="", string sort_by_metric="", string sort_by_direction="", numeric limit=0, numeric offset=0 )
Retrieve monthly stats for all subusers. The parameter date is the date the statistics were gathered in the format: YYYY-MM-DD. The parameter subuser is a substring search of your subusers. Endpoint docs
getAllSubuserTotals( required string start_date, string end_date="", string sort_by_metric="", string sort_by_direction="", string aggregated_by="", numeric limit=0, numeric offset=0 )
Retrieve the totals for each email statistic metric for all subusers. The parameter start_date is the starting date of the statistics to retrieve in the format YYYY-MM-DD. The parameter end_date is the end date of the statistics to retrieve in the format YYYY-MM-DD. It defaults to today. Endpoint docs
getSubuserStats( required string subusers, required string start_date, string end_date="", string sort_by_metric="", string sort_by_direction="", string aggregated_by="", numeric limit=0, numeric offset=0 )
Allows you to retrieve the email statistics for the given subusers. The parameter subusers is the subusers you want to retrieve statistics for. You may include this parameter up to 10 times to retrieve statistics for multiple subusers. The parameter start_date is the starting date of the statistics to retrieve in the format YYYY-MM-DD. The parameter end_date is the end date of the statistics to retrieve in the format YYYY-MM-DD. It defaults to today. Endpoint docs
createSubuser( required string username, required string email, required string password, required array ips=[] )
Creates a Subuser. The parameter username is the username for this subuser. The parameter email is the email address of the subuser. The parameter password is the password this subuser will use when logging into SendGrid. The parameter ips are the IP addresses that should be assigned to this subuser. Endpoint docs
Delete a subuser. The parameter subuser_name is the name of the subuser to delete. Endpoint docs
Update IPs assigned to a subuser. The parameter subuser_name is the name of the subuser to update. The parameter ips are the IP addresses that are assigned to the subuser. Endpoint docs
View SendGrid Docs for Link Branding
Retrieve all branded links. The parameter limit limits the number of rows returned. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Retrieve a branded link. The parameter id is the id of the branded link you want to retrieve. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Retrieve the default branded link. The default branded link is the actual URL to be used when sending messages. The parameter domain is the domain to match against when finding a corresponding branded link. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Retrieve a subuser's branded link. The parameter username specifies the username of the subuser to retrieve associated branded links for. Endpoint docs
createLinkBranding( required string domain, string subdomain="", boolean default, string on_behalf_of="" )
Create a branded link. The parameter domain is the root domain for your subdomain that you are creating the link branding for. This should match your FROM email address. The parameter subdomain is the subdomain to create the link branding for. Must be different from the subdomain you used for authenticating your domain. The parameter default indicates if you want to use this link branding as the fallback, or as the default. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Delete a branded link. The parameter id is the id of the branded link you want to delete. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Validate a branded link. The parameter id is the id of the branded link you want to delete. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Associate a branded link with a subuser. The parameter link_id is the id of the branded link you want to associate. The parameter username is the username of the subuser account that you want to associate the branded link with. Endpoint docs
Disassociate link branding from a subuser. The parameter username is the username of the subuser account that you want to disassociate link branding from. Endpoint docs
View SendGrid Docs for Domains
listAllDomains( numeric limit=0, numeric offset=0, boolean exclude_subusers=false, string username="", string domain="", string on_behalf_of="" )
List all authenticated domains. The parameter exclude_subusers excludes subuser domains from the result. The parameter username is the username associated with an authenticated domain. The parameter domain searches for authenticated domains. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Retrieve an authenticated domain. The parameter domain_id is the id of the authenticated domain you want to retrieve. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Authenticate a domain. The parameter domain should be an instance of the helpers.domain component. However, if you want to create and pass in the struct or json yourself, you can. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
updateAuthenticatedDomain( required numeric domain_id, boolean custom_spf, boolean default, string on_behalf_of="" )
Update an authenticated domain. The parameter domain_id is the domain ID to be updated. The parameter custom_spf specifies whether to use a custom SPF or allow SendGrid to manage your SPF. This option is only available to authenticated domains set up for manual security. The parameter default indicates whether to use this authenticated domain as the fallback if no authenticated domains match the sender's domain. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Delete an authenticated domain. The parameter domain_id is the id of the domain you want to delete. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Get the default authenticated domain. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Add an IP to an authenticated domain. The parameter domain_id is the ID of the domain to be updated. The parameter ip is the IP to associate with the domain. Used for manually specifying IPs for custom SPF. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
deleteIPForAuthenticatedDomain( required numeric domain_id, required string ip, string on_behalf_of="" )
Remove an IP from an authenticated domain. The parameter domain_id is the ID of the domain to delete the IP from. The parameter ip is the IP to remove from the domain. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Validate a domain authentication. The parameter domain_id is the ID of the domain to validate. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
List the authenticated domain associated with the given user. The parameter username is the username for the subuser to find associated authenticated domain. Endpoint docs
Disassociate a authenticated domain from a given user. The parameter username is the username for the subuser to disassociate from an authenticated domain. Endpoint docs
Associate a authenticated domain with a given user. The parameter domain_id is the ID of the authenticated domain to associate with the subuser. The parameter username is the username to associate with the authenticated domain. Endpoint docs
View SendGrid Docs for IP Addresses
Add IPs to your account. The parameter count is the number of IPs to add to the account. The parameter subusers can be an array of usernames to be assigned a send IP. The parameter warmpup indicates whether or not to warmup the IPs being added. Endpoint docs
Gets amount of IP Addresses that can still be created during a given period and the price of those IPs. Endpoint docs
listAllIPs( string ip="", string subuser="", boolean exclude_whitelabels=false, string sort_by_direction="", numeric limit=0, numeric offset=0 )
Retrieve all IP addresses. The parameter ip is an IP address to get (Optional). The parameter subuser is a subuser you are requesting for (Optional). The parameter exclude_whitelabels provides the ability to exclude reverse DNS records (whitelabels). The parameter sort_by_direction is the direction to sort the results (desc, asc). Endpoint docs
Retrieve all assigned IPs (Throws internal error even on sendgrids sample). Endpoint docs
Retrieve all IP pools an IP address belongs to. Endpoint docs
Create an IP pool. Note that before you can create an IP Pool, you need to activate the IP in your SendGrid account. Endpoint docs
Retrieve all IP pools. Endpoint docs
Retrieve all IPs in a specified pool. The parameter ippool is the name of the IP pool you are retrieving IPs for. Endpoint docs
Update an IP pool’s name. The parameter name is the name of the IP pool that you want to rename. The parameter new_pool_name is the new name for your IP pool. Endpoint docs
Delete an IP pool. The parameter name is the name of the IP pool that you want to delete. Endpoint docs
Add an IP address to a pool. The parameter name is the name of the IP pool that you want to add the IP to. The parameter ip is the IP address that you want to add to an IP pool. Endpoint docs
Remove an IP address from a pool. The parameter name is the name of the IP pool that you want to delete an IP from. The parameter ip is the IP address that you are removing. Endpoint docs
View SendGrid Docs for Users
Get a user's profile. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Update a user's profile. The parameter firstName is the first name of the user. The parameter lastName is the last name of the user. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Get a user's account information. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Retrieve your account email address. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Update your account email address. The parameter email is the new email address that you would like to use for your account. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Retrieve your username. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Update your username. The parameter username is the new username you would like to use for your account. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
updateUserPassword( required string oldpassword, required string newpassword, string on_behalf_of="" )
Update your password. The parameter oldpassword is the old password for your account. The parameter newpassword is the new password you would like to use for your account. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Retrieve your credit balance. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
View SendGrid Docs for Webhooks
Retrieve Event Webhook settings. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Update a webhook's event notification settings. The parameter webhook should be an instance of the helpers.webhook component. However, if you want to create and pass in the struct or json yourself, you can. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Test your event webhook by sending a fake event notification post to the provided URL. The parameter webhook should be an instance of the helpers.webhook component. However, if you want to create and pass in the struct or json yourself, you can. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Retrieve your signed webhook's public key. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Enable or disable signing of the Event Webhook. The parameter enabled is boolean value that either enables or disables signing of the Event Webhook using this endpoint. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
Retrieve your current inbound parse webhook settings. The parameter on_behalf_of generates the API call as if the subuser account was making the request. Endpoint docs
getEventWebhookParseStats( required string start_date, string end_date="", string aggregated_by="", numeric limit=0, numeric offset=0 )
Retrieve the statistics for your Parse Webhook usage. The parameter start_date is the starting date of the statistics to retrieve. Must follow format YYYY-MM-DD. The parameter end_date is the end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD. The parameter aggregated_by indicates how you would like the statistics to by grouped. Allowed Values: day, week, month (Optional). Endpoint docs
View SendGrid Docs for Blocks
Retrieve a list of all email addresses that are currently on your blocks list. The parameter start_time is the start of the time range when the blocked email was created. If numeric, it's assumed to be a unix timestamp. Otherwise, it's presumed to be a valid date that will be converted to a unix timestamp automatically. The parameter end_time is the end of the time range when the blocked email was created. If numeric, it's assumed to be a unix timestamp. Otherwise, it's presumed to be a valid date that will be converted to a unix timestamp automatically. Endpoint docs
Retrieve a specific email address from your blocks list. Endpoint docs
Remove a specific email address from your blocks list. Endpoint docs
View SendGrid Docs for Bounces
Retrieve a list of bounces that are currently on your bounces list. The parameter start_time is the start of the time range when the bounce was created. If numeric, it's assumed to be a unix timestamp. Otherwise, it's presumed to be a valid date that will be converted to a unix timestamp automatically. The parameter end_time is the end of the time range when the bounce was created. If numeric, it's assumed to be a unix timestamp. Otherwise, it's presumed to be a valid date that will be converted to a unix timestamp automatically. Endpoint docs
Retrieve bounce information for a given email address. Endpoint docs
Remove an email address from your block list. Endpoint docs
View SendGrid Docs for Campaigns
Create a marketing campaign. The parameter campaign should be an instance of the helpers.campaign component. However, if you want to create and pass in the struct or json yourself, you can.
Retrieve a list of all of your campaigns. Endpoint docs
Retrieve a single campaign by ID. Endpoint docs
Delete a single campaign by ID. Endpoint docs
Update a campaign by ID. The parameter campaign this should be an instance of the helpers.campaign component. However, if you want to create and pass in the struct or json yourself, you can. Endpoint docs
View scheduled time of a Campaign. Endpoint docs
View SendGrid Docs for Contacts API - Recipients
Add Marketing Campaigns recipients. Note that it also appears to update existing records, so it basically functions like a PATCH. The parameter recipients is an array of objects, with at minimum an email key/value. Endpoint docs
addRecipient( required any recipient, string first_name="", string last_name="", struct customFields={} )
Convenience method for adding a single recipient at a time. The parameter recipient Facilitates two means of adding a recipient. You can pass in a struct with key/value pairs providing all relevant recipient information. Alternatively, you can use this to simply pass in the recipient's email address, which is all that is required. The parameter customFields is a struct with keys corresponding to the custom field names, along with their assigned values.
Update one or more Marketing Campaign recipients. Note that it will also add non-existing records. The parameter recipients an array of objects, with at minimum, an email key/value. Endpoint docs
updateRecipient( required any recipient, string first_name="", string last_name="", struct customFields={} )
Convenience method for updating a single recipient at a time. The parameter recipient Facilitates two means of updating a recipient. You can pass in a struct with key/value pairs providing all relevant recipient information. Alternatively, you can use this to simply pass in the recipient's email address, which is all that is required. The parameter customFields is a struct with keys corresponding to the custom field names, along with their assigned values.
Check the upload status of a Marketing Campaigns recipient. Endpoint docs
Delete a single recipient with the given ID from your contact database. The parameter id is the recipient ID or email address (which will be automatically converted to the recipient ID). Endpoint docs
Deletes one or more recipients. This is an incomplete implementation of the SendGrid API. Technically, this should send a DELETE request to /contactdb/recipients, with an array of IDs as the body. But ColdFusion doesn't currently include the request body in DELETE calls. So we loop the recipients through the individual delete method. The parameter recipients is an array of the recipient IDs you want to delete. You can also provide their email addresses, and they will be converted to recipient IDs. Endpoint docs
Retrieve all of your Marketing Campaign recipients. The parameter page is the page index of first recipients to return (must be a positive integer). The parameter pageSize is the number of recipients to return at a time (must be a positive integer between 1 and 1000). Endpoint docs
Retrieve a single recipient by ID from your contact database. The parameter id is the recipient ID or email address (which will be automatically converted to the recipient ID). Endpoint docs
Retrieve the lists that a given recipient belongs to. The parameter id is the recipient ID or email address (which will be automatically converted to the recipient ID). Endpoint docs
Retrieve the number of Marketing Campaigns recipients that you will be billed for. Endpoint docs
Retrieve the total number of Marketing Campaigns recipients. Endpoint docs
Perform a search on all of your Marketing Campaigns recipients. The parameter fieldName is the name of a custom field or reserved field. The parameter search is the value to search for within the specified field. Date fields must be unix timestamps. Currently, searches that are formatted as a U.S. date in the format mm/dd/yyyy (1-2 digit days and months, 1-4 digit years) are converted automatically. Endpoint docs
View SendGrid Docs for Contacts API - Custom Fields
Create a custom field. The parameter type accepts the values 'text', 'date', and 'number'.
Retrieve all custom fields.
Retrieve a custom field by ID.
Delete a custom field by ID.
List all fields that are reserved and can't be used for custom field names.
View SendGrid Docs for Contacts API - Lists
Create a list for your recipients. Endpoint docs
Retrieve all of your recipient lists. If you don't have any lists, an empty array will be returned. Endpoint docs
Delete multiple recipient lists. This is an incomplete implementation of the SendGrid API. Technically, this should send a DELETE request to /contactdb/lists, with an array of IDs as the body. But ColdFusion doesn't currently include the request body in DELETE calls. So we loop the lists through the individual delete method. Endpoint docs
Delete a single list with the given ID from your contact database. Endpoint docs
Retrieve a single recipient list by ID. Endpoint docs
Update the name of one of your recipient lists.
Retrieve all recipients on the list with the given ID. The parameter page is the page index of first recipient to return (must be a positive integer). The parameter pageSize is the number of recipients to return at a time (must be a positive integer between 1 and 1000). Endpoint docs
Add a single recipient to a list. The parameter recipientId is the recipient ID or email address (which will be automatically converted to the recipient ID). Endpoint docs
Delete a single recipient from a list. The parameter recipientId is the recipient ID or email address (which will be automatically converted to the recipient ID). Endpoint docs
Add multiple recipients to a list. The parameter recipients is an array of recipient IDs or email addresses. The first element of the array is checked to determine if it is an array of IDs or email addresses. Endpoint docs
View SendGrid Docs for Contacts API - Segments
Create a segment using search conditions. The parameter conditions is an array of structs making up the search conditions that define this segment. Read SendGrid documentation for specifics on how to segment contacts. The parameter listId is the list id from which to make this segment. Not including this ID will mean your segment is created from the main contactdb rather than a list. Endpoint docs
Retrieve all of your segments. Endpoint docs
Retrieve a single segment with the given ID. Endpoint docs
Update a segment. Functions similarly to createSegment(), but you only need to include the parameters you are updating. The parameter listId is the list id from which to make this segment. Note that this can be used to change the list for this segment, but once a list has been set, the segment cannot be returned to the main contactdb.
Delete a segment from your recipients database. Endpoint docs
Retrieve all of the recipients in a segment with the given ID. Endpoint docs
View SendGrid Docs for Invalid Emails
Retrieve a list of invalid emails that are currently on your invalid emails list. The parameter start_time is the start of the time range when the invalid email was created. If numeric, it's assumed to be a unix timestamp. Otherwise, it's presumed to be a valid date that will be converted to a unix timestamp automatically. The parameter end_time is the end of the time range when the invalid email was created. If numeric, it's assumed to be a unix timestamp. Otherwise, it's presumed to be a valid date that will be converted to a unix timestamp automatically. Endpoint docs
Retrieve information about a specific invalid email address. Endpoint docs
View SendGrid Docs for Sender Identities
Create a new sender identity. The parameter sender should be an instance of the helpers.sender component. However, if you want to create and pass in the struct or json yourself, you can. Endpoint docs
Retrieve a list of all sender identities that have been created for your account. Endpoint docs
Update a sender identity by ID. The parameter sender should be an instance of the helpers.sender component. However, if you want to create and pass in the struct or json yourself, you can. Endpoint docs
Delete a single sender identity by ID. Endpoint docs
Resend a sender identity verification email. Endpoint docs
Retrieve a single sender identity by ID. Endpoint docs
View SendGrid Docs for Cancel Scheduled Sends
Generate a new batch ID. This batch ID can be associated with scheduled sends via the mail/send endpoint. Endpoint docs
View SendGrid Docs for Spam Reports
Retrieve a list of spam reports that are currently on your spam reports list. The parameter start_time is the start of the time range when the spam reports was created. If numeric, it's assumed to be a unix timestamp. Otherwise, it's presumed to be a valid date that will be converted to a unix timestamp automatically. The parameter end_time is the end of the time range when the spam reports was created. If numeric, it's assumed to be a unix timestamp. Otherwise, it's presumed to be a valid date that will be converted to a unix timestamp automatically. Endpoint docs
Retrieve a specific spam report by email address. Endpoint docs
View SendGrid Docs for Suppressions - Suppressions
Add email addresses to an unsubscribe group. If you attempt to add suppressions to a group that has been deleted or does not exist, the suppressions will be added to the global suppressions list. The parameter emails is an array of email addresses. Endpoint docs
Convenience method for adding a single email address to an unsubscribe group. Delegates to addEmailsToUnsubscribeGroup().
Retrieve all suppressed email addresses belonging to the given group. Endpoint docs
Remove a suppressed email address from the given suppression group. Endpoint docs
Retrieve a list of all suppressions. Endpoint docs
Appears to slightly differ from the documentation. Returns all supressions groups, with an indication if the email address is supressed or not. Endpoint docs
Search a suppression group for multiple suppressions. The parameter emails is an array of email address that you want to search the suppression group for. Endpoint docs
Convenience method for searching for a single email within an unsubscribe group. Delegates to searchUnsubscribeGroupForEmails().
View SendGrid Docs for Suppressions - Unsubscribe Groups
Create a new unsubscribe suppression group. The parameter name is the name of the group and can be seen by recipients on the unsubscribe landing page. SendGrid enforces the max length (30) by silently trimming excess characters. The parameter description is a description of the group that can be seen by recipients on the unsubscribe landing page. SendGrid enforces the max length (100) by silently trimming excess characters. Endpoint docs
Retrieve a list of all suppression groups created by this user. Endpoint docs
Retrieve a single suppression group. Endpoint docs
updateUnsubscribeGroup( required numeric id, string name="", string description="", required boolean isDefault )
Update an unsubscribe suppression group. The parameter name is the name of the group and can be seen by recipients on the unsubscribe landing page. SendGrid enforces the max length (30) by silently trimming excess characters. The parameter description is a description of the group that can be seen by recipients on the unsubscribe landing page. SendGrid enforces the max length (100) by silently trimming excess characters. The parameter isDefault is required by this library, because if you don't supply it, SendGrid assumes false, which is confusing. Endpoint docs
Delete a suppression group. Endpoint docs
View SendGrid Docs for Validate Email
Retrive a validation information about an email address. Important: SendGrid's email validation endpoint requires a separate API key from their primary email API. Additionally, this service is only available on their "Pro" tier, or higher. For a bit more information about SendGrid's email validation, you can read their documentation and product page. The parameter email is the address to validate. The parameter source is a one word classifier for the validation. Endpoint docs