Module sendgrid_api::types
source · Expand description
The data types sent to and returned from the API client.
Structs
- Additional checks on the email address.
- The individual events and their stats.
- All of the following types are flattened into one object:
- The individual events and their stats.
- All of the following types are flattened into one object:
- The individual events and their stats.
- All of the following types are flattened into one object:
- An object allowing you to specify how to handle unsubscribes.
- The DNS records used to authenticate the sending domain.
billable_breakdownwill only appear to the parent user in an account with subusers.- Allows you to bypass the bounce list to ensure that the email is delivered to recipients. Spam report and unsubscribe lists will still be checked; addresses on these other lists will not receive the message. This filter cannot be combined with the
bypass_list_managementfilter. See our documentation for more about bypass filters. - Allows you to bypass all unsubscribe groups and suppressions to ensure that the email is delivered to every single recipient. This should only be used in emergencies when it is absolutely necessary that every recipient receives your email. This filter cannot be combined with any other bypass filters. See our documentation for more about bypass filters.
- Allows you to bypass the spam report list to ensure that the email is delivered to recipients. Bounce and unsubscribe lists will still be checked; addresses on these other lists will not receive the message. This filter cannot be combined with the
bypass_list_managementfilter. See our documentation for more about bypass filters. - Allows you to bypass the global unsubscribe list to ensure that the email is delivered to recipients. Bounce and spam report lists will still be checked; addresses on these other lists will not receive the message. This filter applies only to global unsubscribes and will not bypass group unsubscribes. This filter cannot be combined with the
bypass_list_managementfilter. See our documentation for more about bypass filters. - All of the following types are flattened into one object:
- Granular checks for email address validity.
- The user may choose to create up to 120 custom fields or none at all. This is not a reserved field.
- All of the following types are flattened into one object:
- All of the following types are flattened into one object:
- All of the following types are flattened into one object:
- The delete has been accepted and is processing.
- The deletion job has been accepted and is being processed.
- The removal is accepted and processing.
- All of the following types are flattened into one object:
- All of the following types are flattened into one object:
- All of the following types are flattened into one object:
- All of the following types are flattened into one object:
- The DKIM record for messages sent using this authenticated domain.
- A DNS record for this authenticated domain.
- The DNS records generated for this link branding.
- Checks on the domain portion of the email address.
- All of the following types are flattened into one object:
- The DNS records for this authenticated domain.
- The DNS record generated to point to your link branding subdomain.
- If the request is incorrect, an array of errors will be returned.
- If the request is incorrect, an array of errors will be returned.
- All of the following types are flattened into one object:
- The default footer that you would like included on every email.
- All of the following types are flattened into one object:
- Allows you to enable tracking provided by Google Analytics.
- All of the following types are flattened into one object:
- All of the following types are flattened into one object:
- helper text or docs for troubleshooting
- Checks on the local part of the email address.
- The CNAME record for the authenticated domain.
- A collection of different mail settings that you can use to specify how you would like this email to be handled.
- Allows you to track if the email was opened by including a single pixel image in the body of the content. When the pixel is loaded, Twilio SendGrid can log that the email was opened.
- The DNS record generated to verify who created the link branding.
- Allows you to track if a recipient clicked a link in your email.
- Array of IDs
- All of the following types are flattened into one object:
- All of the following types are flattened into one object:
- All of the following types are flattened into one object:
- The individual DNS records that are checked when validating, including the reason for any invalid DNS records.
- The specific results of the validation.
- The DNS record generated for the sending domain used for this branded link.
- resources in which segment is being used
- Result map of the import job.
- Sandbox Mode allows you to send a test email to ensure that your request body is valid and formatted correctly.
- Segment status indicates whether the segment’s contacts will be updated periodically
- All of the following types are flattened into one object:
- All of the following types are flattened into one object:
- The SPF record for the authenticated domain.
- All of the following types are flattened into one object:
- All of the following types are flattened into one object:
- All of the following types are flattened into one object:
- All of the following types are flattened into one object:
- All of the following types are flattened into one object:
- Allows you to insert a subscription management link at the bottom of the text and HTML bodies of your email. If you would like to specify the location of the link within your email, you may use the
substitution_tag. - All of the following types are flattened into one object:
- Settings to determine how you would like to track the metrics of how your recipients interact with your email.
- All of the following types are flattened into one object:
- All of the following types are flattened into one object:
- The status of the scheduled send.
- All of the following types are flattened into one object:
- The individual validation results for each of the DNS records associated with this branded link.
- All of the following types are flattened into one object:
- Only verified sender identities can be used to send email.
Enums
- This is the A/B phase of the Single Send stat returned. If the
group_byparameter doesn’t includeab_phasein the request, then the value is “all”. - What differs between the A/B tests
- Dictates how the stats are time-sliced. Currently,
"total"and"day"are supported. - Use to distinguish between types of bounces
- Specifies the type of client to retrieve stats for. Must be either “phone”, “tablet”, “webmail”, or “desktop”.
- The export job’s status. Allowed values:
pending,ready, orfailure. - The country you would like to see statistics for. Currently only supported for US and CA.
- The attachment’s content-disposition, specifying how you would like the attachment to be displayed. For example,
“inline”results in the attached file are displayed automatically within the message while“attachment”results in the attached file require some action to be taken before it is displayed, such as opening or downloading the file. - The editor used in the UI.
- The message’s status.
- Name of event
- File type for export file. Choose from
jsonorcsv. - Defines the generation of the template.
- Comma-delimited list specifying which generations of templates to return. Options are
legacy,dynamicorlegacy,dynamic. - The type of alert.
- The type of alert.
- The type of account for this user.
- The type of DNS record that was generated.
- Whether or not the outbound IP is dedicated vs shared
- Upload file type.
- The status of your campaign.
- This is the ISO 8601 time at which to send the Single Send; must be in future, or the string “now”
- The direction you want to sort.
- The metric that you want to sort by. Metrics that you can sort by are:
blocks,bounces,clicks,delivered,opens,requests,unique_clicks,unique_opens, andunsubscribes.’ - The status of the scheduled send.
- How to group the statistics. Must be either “day”, “week”, or “month”.
- The type of the field.
- A Teammate can be an “admin,” “owner,” or “teammate.” Each role is associated with the scope of the Teammate’s permissions.
- A generic classification of whether or not the email address is valid.
- How the winner will be decided