Expand description
The data types sent to and returned from the API client.
Structs§
- AbTest
Summary - Additional
- Additional checks on the email address.
- Advanced
Stats Clicks - The individual events and their stats.
- Advanced
Stats Clicks Opens AllOf - All of the following types are flattened into one object:
- Advanced
Stats Mailbox Provider - The individual events and their stats.
- Advanced
Stats Mailbox Provider AllOf - All of the following types are flattened into one object:
- Advanced
Stats Opens - The individual events and their stats.
- AllSegments
Response - ApiError
- ApiErrors
- ApiKey
Name Id - ApiKey
Name Scopes - ApiKey
Name Scopes AllOf - All of the following types are flattened into one object:
- Asm
- An object allowing you to specify how to handle unsubscribes.
- Attachments
- Authentication
Domain - Authentication
Domain Dns - The DNS records used to authenticate the sending domain.
- Automations
Link Stats Response - Automations
Link Stats Response Results - Automations
Response - Automations
Response Results - Billable
Breakdown billable_breakdownwill only appear to the parent user in an account with subusers.- Blocks
Response - Bounce
Response - Bypass
Bounce Management - 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. - Bypass
List Management - 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.
- Bypass
Spam Management - 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. - Bypass
Unsubscribe Management - 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. - Campaign
Response - Campaign
Response AllOf - All of the following types are flattened into one object:
- Campaigns
Request - Cancel
PauseA Scheduled Send Request - Category
Stats - CcBcc
Email Object - Checks
- Granular checks for email address validity.
- Click
Tracking - Contact
- Contact
DbRecipient Response - Contact
Details - Contact
Details2 - Contact
Details3 - Contact
Export - Contact
Import - Contact
Request - Contact
Response - Contact
Response Custom Fields - The user may choose to create up to 120 custom fields or none at all. This is not a reserved field.
- Contact
Summary - Contactdb
Custom Field - Contactdb
Custom Field With AllOf - All of the following types are flattened into one object:
- Contactdb
Custom Field With Id - Contactdb
Custom Field With Value - Contactdb
Custom Field With Value AllOf - All of the following types are flattened into one object:
- Contactdb
List - Contactdb
Recipient - Contactdb
Recipient Count - Contactdb
Segments - Contactdb
Segments Conditions - Contactdb
Segments With AllOf - All of the following types are flattened into one object:
- Contactdb
Segments With Id - Contacts
- Content
- Create
ApiKeys Request - Create
ApiKeys Response - Create
Integration Request - Credentials
- Credit
Allocation - Custom
Field Definitions Response - Custom
Fields - Delete
Access Settings Whitelist Request - Delete
IpsPools Pool Name Response - Delete
Lists Response - The delete has been accepted and is processing.
- Delete
McContacts Response - The deletion job has been accepted and is being processed.
- Delete
McContacts Response Data - Delete
McLists Contacts Response - The removal is accepted and processing.
- Delete
Suppression Blocks Request - Delete
Suppression Bounces Request - Delete
Verified Senders Response - Design
Common Fields - Design
Common Fields AllOf - All of the following types are flattened into one object:
- Design
Duplicate Input - Design
Input - Design
Input AllOf - All of the following types are flattened into one object:
- Design
Output AllOf - All of the following types are flattened into one object:
- Design
Output Summary - Design
Output Summary AllOf - All of the following types are flattened into one object:
- Dkim
- The DKIM record for messages sent using this authenticated domain.
- Dkim1
- A DNS record for this authenticated domain.
- Dns
- The DNS records generated for this link branding.
- Domain
- Checks on the domain portion of the email address.
- Domain
Authentication - Domain
Authentication200 Response - Domain
Authentication200 Response AllOf - All of the following types are flattened into one object:
- Domain
Authentication Dns - The DNS records for this authenticated domain.
- Domain
Cname - The DNS record generated to point to your link branding subdomain.
- Email
Activity Response Common Fields - Email
Config - Enforced
TlsRequest Response - Error
- Errors
- Errors
Data - Errors
Data Type - If the request is incorrect, an array of errors will be returned.
- Errors
Seg - Errors
SegData - If the request is incorrect, an array of errors will be returned.
- Event
- Field
Mappings AnyOf - All of the following types are flattened into one object:
- Footer
- The default footer that you would like included on every email.
- From
- From
Email Object - Full
Segment - Full
Segment AllOf - All of the following types are flattened into one object:
- Ganalytics
- Allows you to enable tracking provided by Google Analytics.
- GetAccess
Settings Activity Response - GetAccess
Settings Activity Response Result - GetAlerts
Alert Response - GetAlerts
Response - GetApi
Keys KeyResponse - GetApi
Keys Response - GetAsm
Groups Group Response - GetAsm
Groups Group Response AllOf - All of the following types are flattened into one object:
- GetAsm
Suppressions Email Response - GetAsm
Suppressions Response - GetBrowsers
Stats Response - GetBrowsers
Stats Response Data - GetCampaigns
Campaign Response - GetCampaigns
Response - GetCategories
Response - GetCategories
Response Data - GetClients
Stats Response - GetContactdb
Recipients Recipient Lists Response - GetContactdb
Recipients Search Response - GetContactdb
Reserved Fields Response - GetContactdb
Status Response - GetContactdb
Status Response Data - GetDevices
Stats Response - GetGeo
Stats Response - GetGeo
Stats Response Data - GetIps
Assigned Response - GetIps
IpAddress Response - GetIps
Pools Pool Name Response - GetIps
Remaining Response - GetIps
Remaining Response Results - GetIps
Response - GetMail
Settings Response - GetMail
Settings Response Result - GetMailbox
Providers Stats Response - GetMailbox
Providers Stats Response Data - GetMarketing
Contacts Exports Response - GetMarketing
Contacts Exports Response Data - GetMarketing
Contacts Exports Response Errors - GetMarketing
Contacts Exports Response Result - GetMarketing
Contacts Exports Response Result Metadata - GetMarketing
Contacts Imports Response - GetMarketing
Segments Response - GetMarketing
Singlesends Categories Response - GetMarketing
Singlesends Response - GetMc
Contacts Count Response - GetMc
Contats Response - GetMc
Field Definitions Response - GetMc
Lists Contacts Count Response - GetMc
Lists Response - GetMc
Lists Response AllOf - All of the following types are flattened into one object:
- GetMc
Lists Response Data - GetMessages
Download Response - GetMessages
MsgResponse - GetMessages
Response - GetPartner
Settings Response - GetScopes
Requests Response - GetScopes
Response - GetScopes
Response Data - GetScopes
Response Errors - GetSenders
Response - GetStats
Response - GetStats
Response Data - GetSubusers
Reputations Response - GetSuppression
Unsubscribes Response - GetTeammates
Pending Response - GetTeammates
Pending Response Result - GetTeammates
Response - GetTeammates
Response Result - GetTeammates
Username Response - GetTemplates
Response - GetTemplates
Response Data - GetTemplates
Response Errors - GetTracking
Settings Open Response - GetTracking
Settings Response - GetTracking
Settings Response Result - GetUser
Account Response - GetUser
Credits Response - GetUser
Email Response - GetUser
Profile Response - GetUser
Webhooks Event Settings Signed Response - GetUser
Webhooks Parse Settings Response - GetUser
Webhooks Parse Stats Response - GetUser
Webhooks Parse Stats Response Data - GetUser
Webhooks Parse Stats Response Metrics - GetVerified
Senders Domains Response - GetVerified
Senders Domains Response Results - GetVerified
Senders Response - GetVerified
Senders Steps Completed Response - GetVerified
Senders Steps Completed Response Results - GetVerified
Senders Verify Token Response Errors - Global
Error Response Schema - Global
Error Response Schema Errors - Google
Analytics Settings - Help
- helper text or docs for troubleshooting
- Invalid
Email - IpAccess
Response - IpPool
- IpPools
Pool Resp - IpWarmup
Response - Ips
- L
- Link
- Link
Branding200 Response - Link
Tracking Metadata - List
- List
AllCustom Fields Response - List
AllLists Response - List
AllSegments Response - List
Designs Response - List
Recipients OnASegment Response - List
Recipients Response - Lists
- Local
Part - Checks on the local part of the email address.
- Mail
Batch Id - Mail
Cname - The CNAME record for the authenticated domain.
- Mail
Settings - A collection of different mail settings that you can use to specify how you would like this email to be handled.
- Mail
Settings Address Whitelabel - Mail
Settings Bounce Purge - Mail
Settings Footer - Mail
Settings Forward Bounce - Mail
Settings Forward Spam - Mail
Settings Patch - Mail
Settings Template - Message
- Messages
- Metadata
- Metadata
Type - Metrics
- Metrics
Data - Monitor
- Notifications
- Open
Tracking - 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.
- Owner
Cname - The DNS record generated to verify who created the link branding.
- Parse
Setting - Partner
Settings NewRelic - Patch
Alerts Alert Request - Patch
Contactdb Lists List Response - Patch
Contactdb Recipients Request - Patch
Contactdb Segments Segment Request - Patch
Mail Settings Address Whitelist Request - Patch
Mail Settings Template Request - Patch
Mail Settings Template Response - Patch
McLists Request - Patch
Partner Settings NewRelic Request - Patch
Scopes Requests Approve Response - Patch
SsoCertificates Cert Request - Patch
SsoTeammates Username Request - Patch
Subusers Subuser Name Request - Patch
Teammates Username Request - Patch
Templates Template Request - Patch
Tracking Settings Open Request - Patch
User Webhooks Event Settings Signed Response - Patch
User Webhooks Event Settings Signed Response Errors - Patch
Verified Senders Response - Patch
Whitelabel Domains Domain Request - Patch
Whitelabel Links Request - Permissions
- Personalizations
- Post
Access Settings Whitelist Request - Post
Alerts Request - Post
Alerts Response - Post
AsmGroups Group Suppressions Response - Post
AsmGroups Response - Post
Contactdb Custom Fields Request - Post
Contactdb Recipients Request - Post
Contactdb Recipients Search Request - Post
Contactdb Recipients Search Response - Post
Contactdb Recipients Search Response Custom Fields - Post
Contactdb Recipients Search Response Data - Post
IpsRequest - Post
IpsResponse - Post
IpsResponse Data - Post
IpsWarmup Request - Post
IpsWarmup Response - Post
IpsWarmup Response Errors - Post
Mail Send Request - Post
Mail Send Request Tracking Settings Click - Allows you to track if a recipient clicked a link in your email.
- Post
Marketing Contacts Batch Request - Array of IDs
- Post
Marketing Contacts Batch Response - Post
Marketing Contacts Search Emails Request - Post
Marketing Contacts Search Emails Response - Post
Marketing Segments Delete Request - Post
Marketing Segments Delete Response - Post
Marketing Segments Delete Response Errors - Post
Marketing Segments Request - Post
Marketing Segments Request AllOf - All of the following types are flattened into one object:
- Post
Marketing Segments Response - Post
Marketing Senders Request - Post
Marketing Singlesends Request - Post
Marketing Singlesends Response - Post
Marketing Test Send Email Request - Post
McContacts Exports Request - Post
McContacts Exports Response - Post
McContacts Search Request - Post
McContacts Search Response - Post
McField Definitions Request - Post
McField Definitions Response - Post
McField Definitions Response AllOf - All of the following types are flattened into one object:
- Post
McLists Response - Post
Messages Download Response - Post
Senders Request - Post
Senders Request AllOf - All of the following types are flattened into one object:
- Post
Senders Response - Post
SsoCertificates Request - Post
Subusers Request - Post
Teammates Request - Post
Teammates Response - Post
Teammates Response Errors - Post
Templates Request - Post
Templates Template Request - Post
User Webhooks Event Test Request - Post
Validations Email Request - Post
Validations Email Response - Post
Validations Email Response Result - Post
Verified Senders Response - Post
Verified Senders Response Errors - Post
Whitelabel DnsEmail Request - Post
Whitelabel DnsEmail Response - Post
Whitelabel DnsEmail Response Errors - Post
Whitelabel Domains Request - Post
Whitelabel Domains Validate Response - Post
Whitelabel Domains Validate Response Data - Post
Whitelabel Domains Validate Response Validation Results - The individual DNS records that are checked when validating, including the reason for any invalid DNS records.
- Post
Whitelabel IpsRequest - Post
Whitelabel IpsValidate Response - Post
Whitelabel IpsValidate Response Validation Results - The specific results of the validation.
- Post
Whitelabel Links Link Subuser Request - Post
Whitelabel Links Request - Post
Whitelabel Links Validate Response - Post
Whitelabel Links Validate Response Errors - Post
Whitelabel Links Validate Response Validation Results Domain Cname - The DNS record generated for the sending domain used for this branded link.
- PutApi
Keys KeyRequest - PutDesign
Request - PutIps
Pools Pool Name Request - PutMarketing
Singlesends Schedule Request - PutMarketing
Singlesends Schedule Response - PutMc
Contacts Imports Request - PutMc
Contacts Imports Response - PutMc
Contacts Imports Response Data - PutMc
Contacts Request - PutMc
Contacts Response - PutSubusers
Subuser Name IpsResponse - PutUser
Email Request - PutUser
Password Request - PutUser
Username Request - PutUser
Username Response - R
- Recipients
- Reply
Email Object - ReplyTo
- Reserved
Field Definitions Response - Reserved
Fields - Resources
- resources in which segment is being used
- Result
- Results
- Result map of the import job.
- RetrieveA
Global Suppression Response - Reverse
Dns - Sandbox
Mode - Sandbox Mode allows you to send a test email to ensure that your request body is valid and formatted correctly.
- ScheduleA
Campaign Request - ScheduleA
Campaign Response - Segment
Query Json - Segment
Query Json Contacts - Segment
Query Json ContactsL - Segment
Query Json ContactsL Data - Segment
Query Json ContactsLR - Segment
Query Json ContactsR - Segment
Query Json ContactsR Data - Segment
Response - Segment
Status Response - Segment status indicates whether the segment’s contacts will be updated periodically
- Segment
Summary - Segment
Summary V2 - Segment
Update - Segment
Write - Segment
Write V2 - Self
Metadata - SendA
Campaign Response - SendA
Test Campaign Request - SendTo
- Sender
AllOf - All of the following types are flattened into one object:
- Sender
Id - Sender
Request - Sender
Request From - Senders
Request Body - Single
Contact Request - Singlesend
Request - Singlesend
Response - Singlesend
Response AllOf - All of the following types are flattened into one object:
- Singlesend
Response Short - Singlesend
Schedule - Singlesend
Search - Singlesend
Warning - Singlesends
Link Stats Response - Singlesends
Link Stats Response Results - Singlesends
Response - Singlesends
Response Results - Spam
Reports Response - Spf
- The SPF record for the authenticated domain.
- SsoCertificate
Body - SsoError
Response - SsoIntegration
- SsoIntegration
AllOf - All of the following types are flattened into one object:
- SsoTeammate
Common Fields - SsoTeammate
Request AllOf - All of the following types are flattened into one object:
- SsoTeammate
Response - SsoTeammate
Response AllOf - All of the following types are flattened into one object:
- SsoTeammates
Patch Response - SsoTeammates
Patch Response AllOf - All of the following types are flattened into one object:
- Stats
- Stats
Advanced Base Schema - Stats
Advanced Base Schema Data - Stats
Advanced Global - Stats
Advanced Global AllOf - All of the following types are flattened into one object:
- Subscription
Tracking - 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. - Subscription
Tracking Settings - Subuser
- Subuser
Post - Subuser
Stats - Subuser
Stats Data - Subuser
Stats Metrics - Subusers
- Suppression
Group - Suppression
Group Request Base - Suppressions
- Suppressions
Request Body - TneSender
AllOf - All of the following types are flattened into one object:
- TneSender
Data - TneSender
Id - Tracking
Settings - Settings to determine how you would like to track the metrics of how your recipients interact with your email.
- Trait
Cancel Scheduled Sends Errors400 Response - Trait
Cancel Scheduled Sends Errors400 Response Data - Trait
Global Errors500 Response - Trait
Mako Error Response400 - Trait
Mako Error Response400 Errors - Trait
Pagination200 Response - Transactional
Template - Transactional
Template AllOf - All of the following types are flattened into one object:
- Transactional
Template Version Create - Transactional
Template Version Output - Transactional
Template Version Output AllOf - All of the following types are flattened into one object:
- Transactional
Templates Template Lean - Transactional
Templates Version Output Lean - UpdateA
Campaign Request - UpdateA
Scheduled Campaign Response - Upload
Headers - User
Profile - User
Scheduled Send Status - The status of the scheduled send.
- User
Scheduled Send Status AllOf - All of the following types are flattened into one object:
- Users
- Validation
Results - The individual validation results for each of the DNS records associated with this branded link.
- Value
AnyOf - All of the following types are flattened into one object:
- Verified
- Only verified sender identities can be used to send email.
- Verified
Sender Request Schema - Verified
Sender Response Schema - Warning
- Warnings
- Webhook
- Webhooks
Event Webhook Request - Webhooks
Event Webhook Response - Webhooks
Event Webhook Update WithO Auth Request
Enums§
- AbPhase
- 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”. - AbPhase
Id - AbTest
Summary Type - What differs between the A/B tests
- Abbv
Message Status - Aggregated
By - Dictates how the stats are time-sliced. Currently,
"total"and"day"are supported. - AndOr
- Bounce
Type - Use to distinguish between types of bounces
- Client
Type - Specifies the type of client to retrieve stats for. Must be either “phone”, “tablet”, “webmail”, or “desktop”.
- Contact
Export Status - The export job’s status. Allowed values:
pending,ready, orfailure. - Country
- The country you would like to see statistics for. Currently only supported for US and CA.
- Disposition
- 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. - Editor
- The editor used in the UI.
- Email
Activity Response Common Fields Status - The message’s status.
- Event
Name - Name of event
- Field
Type - File
Type - File type for export file. Choose from
jsonorcsv. - Generation
- Defines the generation of the template.
- Generations
- Comma-delimited list specifying which generations of templates to return. Options are
legacy,dynamicorlegacy,dynamic. - GetAlerts
Alert Response Type - The type of alert.
- GetAlerts
Response Type - The type of alert.
- GetUser
Account Response Type - The type of account for this user.
- GroupBy
- Link
Branding200 Response DnsDomain Cname Type - The type of DNS record that was generated.
- Operator
- Outbound
IpType - Whether or not the outbound IP is dedicated vs shared
- Post
Messages Download Response Status - PutMarketing
Singlesends Schedule Response Status - PutMc
Contacts Imports Request File Type - Upload file type.
- ScheduleA
Campaign Response Status - The status of your campaign.
- SendAt
- This is the ISO 8601 time at which to send the Single Send; must be in future, or the string “now”
- Singlesend
Search Status - Sort
ByDirection - The direction you want to sort.
- Sort
ByMetric - 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.’ - Status
- The status of the scheduled send.
- Trait
Automation Query Params Group By - Trait
Stats Advanced Base Query Strings Aggregated By - How to group the statistics. Must be either “day”, “week”, or “month”.
- Type
- The type of the field.
- User
Type - A Teammate can be an “admin,” “owner,” or “teammate.” Each role is associated with the scope of the Teammate’s permissions.
- Verdict
- A generic classification of whether or not the email address is valid.
- Winner
Criteria - How the winner will be decided