SendGrid Connector Objects (Legacy Schema)

This Data Cloud connector is a beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory. Use of this pilot or beta service is at the Customer's sole discretion.

NameDescription
AlertsCreate, update, delete, and query Alerts in SendGrid.
ApiKeysQuery, Create, Update and Delete the available ApiKeys in SendGrid.
BlocksQuery and Delete the available Blocks in SendGrid.
BouncesQuery and Delete the available Bounces in SendGrid.
CancelScheduledSendsUpdate, delete, and query Cancel Scheduled Sends in SendGrid.
CategoriesQuery the available Categories in SendGrid.
CategoryStatsQuery the available Category Stats in SendGrid.
CustomFieldsCreate, delete, and query Custom Fields in SendGrid.
DynamicTemplatesQuery Teammates in SendGrid.
GlobalStatsQuery the available Global Stats in SendGrid.
GlobalUnsubscribesQuery Global Unsubscribes in SendGrid.
GroupSuppressionsQuery group suppressions in SendGrid.
InvalidEmailsQuery and Delete invalid emails in SendGrid.
IPAccessManagementQuery Global Unsubscribes in SendGrid.
ListsCreate, update, delete, and query the available Lists in SendGrid.
MailSettingsQuery all the mail settings in SendGrid.
MarketingCampaignsCreate, update, delete, and query Marketing Campaigns in SendGrid.
MessageEventsList of events related to email message in SendGrid.
MessagesQuery Email Activities in SendGrid.
PartnerSettingsQuery all the partner settings in SendGrid.
RecipientsThe SendGrid table Recipients.
ReservedFieldsQuery the available Reserved Fields in SendGrid.
SchedulesCreate, update, delete, and query Campaign Schedules in SendGrid.
SegmentsCreate, update, delete, and query Segments in SendGrid.
SenderIdentitiesCreate, update, delete, and query Sender Identities in SendGrid.
SpamQuery and delete Spam reports in SendGrid.
StatsByBrowserQuery Browser Statistics in SendGrid.
StatsByClientQuery Client Statistics in SendGrid.
StatsByDeviceQuery Device Statistics in SendGrid.
StatsByLocationQuery Location Statistics in SendGrid.
StatsByMailboxProviderQuery Mailbox Provider Statistics in SendGrid.
SubusersQuery all the subusers in sendgrid.
SubuserStatsQuery Subuser Statistics in SendGrid.
TeammatesQuery Teammates in SendGrid.
UnsubscribeGroupsCreate, update, delete, and query Unsubscribe Groups in SendGrid.
UsersQuery the available Users in SendGrid.
NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerFalseNoThe ID of the alert.
CreatedAtDatetimeTrueNoDate when the alert was created.
UpdatedAtDatetimeTrueNoDate when the alert was updated.
EmailToStringFalseNoThe email address that the alert will be sent to.
PercentageIntegerFalseNoThe email address that the alert will be sent to.
TypeStringFalseNoThe type of alert. Allowed values (usage_limit, stats_notification).
FrequencyStringFalseNoIf the alert is of type stats_notification, this indicates how frequently the stats notifications will be sent.(daily, weekly, monthly).
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ApiKeyId [KEY]StringFalseNoThe ID of your API Key.
NameStringFalseNoThe name of your API Key.
ScopesStringFalseNoThe permissions this API Key has access to. This is populated only when Id is specified.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedAtDatetimeTrueNoThe time the block was created.
ReasonStringFalseNoThe reason for the block.
Email [KEY]StringFalseNoThe email that blocked.
StatusStringFalseNoThe enhanced SMTP block response.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedAtDatetimeTrueNoThe time the bounce was created.
ReasonStringFalseNoThe reason for the bounce.
Email [KEY]StringFalseNoThe email that bounced.
StatusStringFalseNoThe enhanced SMTP bounce response.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
BatchId [KEY]StringFalseNoThe Id of the batch.
StatusStringFalseNoThe status of the scheduled send.Allowed Values: cancel, pause
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
NameStringTrueNoThe name of the categories.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TypeStringFalseNoThe type of the statistic.
NameStringFalseNoThe name of the category.
DateDateTrueNoThe time the global statistic was created.
BlocksIntegerFalseNoThe number of emails that were not allowed to be delivered by ISPs.
DropsIntegerFalseNoThe number of emails automatically dropped by SendGrid because they appear on one of the suppression lists.
BouncesIntegerFalseNoThe number of emails that bounced instead of being delivered.
ClicksIntegerFalseNoThe number of links clicked in your emails.
DeferredIntegerFalseNoThe number of emails temporarily refused by the receiving server.
DeliveredIntegerFalseNoThe number of emails confirmed delivered.
InvalidEmailsIntegerFalseNoThe number of emails with a malformed address or reported as invalid by the receiving server.
OpensIntegerFalseNoThe number of times your emails were opened by recipients.
ProcessedIntegerFalseNoThe number of emails pushed to SendGrid.
RequestsIntegerFalseNoThe number of emails you requested to send via SendGrid.
SpamReportDropsIntegerFalseNoThe number of emails automatically dropped because the emails were marked as spam by the recipients.
SpamReportsIntegerFalseNoThe number of emails marked as spam by recipients.
UniqueClicksIntegerFalseNoThe number of unique recipients who clicked links in your emails.
UniqueOpensIntegerFalseNoThe number of unique recipients who opened your emails.
UnsubscribeDropsIntegerFalseNoThe number of emails in this category dropped by SendGrid because the recipient unsubscribed from your emails.
UnsubscribesIntegerFalseNoThe number of recipients who unsubscribed from your emails.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the custom field.
NameStringFalseNoThe name of the custom field.
TypeStringFalseNoThe type of the custom field. Allowed values are number, text, or date.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe ID of the template.
NameStringFalseNoName of the template.
GenerationStringFalseNoGeneration of the template. (dynamic)
UpdatedAtDatetimeFalseNoThe last time the template was updated.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
DateDateTrueNoThe time the global statistic was created.
BlocksIntegerFalseNoThe number of emails that were not allowed to be delivered by ISPs.
BounceDropsIntegerFalseNoThe number of emails automatically dropped by SendGrid because they appear on one of the suppression lists.
BouncesIntegerFalseNoThe number of emails that bounced instead of being delivered.
ClicksIntegerFalseNoThe number of links clicked in your emails.
DeferredIntegerFalseNoThe number of emails temporarily refused by the receiving server.
DeliveredIntegerFalseNoThe number of emails confirmed delivered.
InvalidEmailsIntegerFalseNoThe number of emails with a malformed address or reported as invalid by the receiving server.
OpensIntegerFalseNoThe number of times your emails were opened by recipients.
ProcessedIntegerFalseNoThe number of emails pushed to SendGrid.
RequestsIntegerFalseNoThe number of emails you requested to send via SendGrid.
SpamReportDropsIntegerFalseNoThe number of emails automatically dropped because the emails were marked as spam by the recipients.
SpamReportsIntegerFalseNoThe number of emails marked as spam by recipients.
UniqueClicksIntegerFalseNoThe number of unique recipients who clicked links in your emails.
UniqueOpensIntegerFalseNoThe number of unique recipients who opened your emails.
UnsubscribeDropsIntegerFalseNoThe number of emails globally dropped by SendGrid because the recipient unsubscribed from your emails.
UnsubscribesIntegerFalseNoThe number of recipients who unsubscribed from your emails.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Email [KEY]StringFalseNoEmail of the unsubscriber.
CreatedAtDatetimeTrueNoThe time the unsubscriber was created.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
GroupId [KEY]IntegerFalseNoEmail of the unsubscriber.
EmailsStringFalseNoThe time the unsubscriber was created.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedDatetimeTrueNoThe time the when the email address was added to the invalid emails list.
ReasonStringFalseNoA reason explaining why the email address was marked as invalid..
Email [KEY]StringFalseNoThe email address that was marked as invalid.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IPStringFalseNoIP Address.
AllowedBooleanFalseNoIndicator if this IP is allowed for access.
AuthMethodStringFalseNoAuthentication method.
FirstAtTimestampFalseNoFirst time when IP has accessed the account.
LastAtTimestampFalseNoLast time when IP has accessed the account.
LocationStringFalseNoLocation of the IP.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoThe Id of the list.
NameStringFalseNoThe name of the list.
RecipientCountIntegerTrueNoThe recipient count of the list.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TitleStringFalseNoThe title of the mail setting.
EnabledStringFalseNoIndicates if this mail setting is currently enabled.
NameStringFalseNoThe name of the mail setting.
DescriptionStringFalseNoA description of the mail setting.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id of the marketing campaign.
TitleStringFalseNoThe title of the marketing campaign.
SubjectStringFalseNoThe subject of the marketing campaign.
SenderIdIntegerFalseNoThe sender Ids of the marketing campaign, separated by a comma.
ListIdsStringFalseNoThe list of list Ids of the marketing campaign, separated by a comma.
SegmentIdsStringFalseNoThe list of segment Ids of the marketing campaign, separated by a comma.
CategoriesStringFalseNoThe categories of the marketing campaign.
SuppressionGroupIdIntegerFalseNoThe suppression group Id of the marketing campaign.
CustomUnsubscribeUrlStringFalseNoThe custom unsubscribe URL of the marketing campaign.
IpPoolStringFalseNoThe IP pool of the marketing campaign.
HtmlContentStringFalseNoThe HTML content of the marketing campaign.
PlainContentStringFalseNoThe content of the marketing campaign.
StatusStringTrueNoThe status of the marketing campaign.
EditorStringFalseNoThe editor used in the UI.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
MessageIdStringTrueNoThe Id of the message.
EventNameStringTrueNoName of event.
ProcessedDatetimeTrueNoThe date when the event was processed.
ReasonStringTrueNoExplanation of what caused the message to be 'bounced', 'deferred', or 'blocked'.
AttemptNumIntegerTrueNoUsed with 'deferred' events to indicate the attempt number out of 10.
UrlStringTrueNoUsed with 'clicked' event to indicate which url the user clicked.
BounceTypeStringTrueNoUse to distinguish between types of bounces.
HttpUserAgentStringTrueNoClient recipient used to click or open message.
MXServerStringTrueNoThe MX server that received the email.
ApiKeyIdStringTrueNoId of the API Key.
AsmGroupIdStringTrueNoASM Group Id.
CategoriesStringTrueNoCategories users associated to the message.
UniqueArgsStringTrueNoJSON hash of key-value pairs associated with the message.
OriginatingIpStringTrueNoThis is the IP address of the person sending the message
OutboundIpStringTrueNoThis is the SendGrid dedicated IP address used to send the email
OutboundIpTypeStringTrueNoThe type of the outbound IP.
TeammateStringTrueNoUsername of the teammate.
TemplateIdStringTrueNoTemplate ID of the email.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id of the message.
StatusStringTrueNoStatus of the email.
SubjectStringTrueNoSubject of the email.
FromEmailStringTrueNoThe email of the sender.
ToEmailStringTrueNoThe email of the receiver.
ClicksCountIntegerTrueNoThe number of clicks.
OpensCountIntegerTrueNoThe number of times that the email was opened.
LastEventTimeDatetimeTrueNoThe datetime of the event.
ApiKeyIdStringTrueNoId of the API Key.
AsmGroupIdStringTrueNoASM Group Id.
MarketingCampaignIdStringTrueNoThe id of the marketing campaign.
MarketingCampaignNameStringTrueNoThe name of the marketing campaign.
MarketingCampaignSplitIdStringTrueNoSplit id of the campaign.
MarketingCampaignVersionStringTrueNoVersion of the campaign.
OriginatingIpStringTrueNoThis is the IP address of the person sending the message
OutboundIpStringTrueNoThis is the SendGrid dedicated IP address used to send the email
OutboundIpTypeStringTrueNoThe type of the outbound IP.
TeammateStringTrueNoUsername of the teammate.
TemplateIdStringTrueNoTemplate ID of the email.
EventsStringTrueNoList of events related to email message in SendGrid.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TitleStringFalseNoThe title of the partner.
EnabledStringFalseNoIndicates if this partner setting has been enabled.
NameStringFalseNoThe name of the partner setting.
DescriptionStringFalseNoA description of this partner setting.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThis column is dynamic and maps to the corresponding field in the API.
SegmentIdInt32FalseNoThis column is dynamic and maps to the corresponding field in the API.
ListIdInt32FalseNoThis column is dynamic and maps to the corresponding field in the API.
EmailStringFalseNoThis column is dynamic and maps to the corresponding field in the API.
FirstNameStringFalseNoThis column is dynamic and maps to the corresponding field in the API.
LastNameStringFalseNoThis column is dynamic and maps to the corresponding field in the API.
CreatedAtDatetimeTrueNoThis column is dynamic and maps to the corresponding field in the API.
LastClickedDatetimeTrueNoThis column is dynamic and maps to the corresponding field in the API.
LastEmailedDatetimeFalseNoThis column is dynamic and maps to the corresponding field in the API.
LastOpenedDatetimeTrueNoThis column is dynamic and maps to the corresponding field in the API.
UpdatedAtDatetimeTrueNoThis column is dynamic and maps to the corresponding field in the API.
AgeStringFalseNoThis column is dynamic and maps to the corresponding field in the API.
DepartmentStringFalseNoThis column is dynamic and maps to the corresponding field in the API.
UniversityStringFalseNoThis column is dynamic and maps to the corresponding field in the API.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
NameStringFalseNoThe name of the reserved field.
TypeStringFalseNoThe type of the reserved field.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
MarketingCampaignId [KEY]IntegerFalseNoId of the campaign.
StatusStringTrueNoStatus of the campaign.
SendAtDatetimeFalseNoDate to start the campaign.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoThe Id of the segment.
NameStringFalseNoThe name of the segment.
ListIdIntegerFalseNoThe Id of the list associated with the segment.
RecipientCountIntegerTrueNoThe recipient count of the segment.
ConditionsField1StringFalseNoField name for the first condition.
ConditionsValue1StringFalseNoField value for the first condition.
ConditionsOperator1StringFalseNoCondition operator for the first condition.
ConditionsAndOr1StringFalseNoHow to connect to the previous condition. Allowed values are AND or OR.
ConditionsField2StringFalseNoField name for the second condition.
ConditionsValue2StringFalseNoField value for the second condition.
ConditionsOperator2StringFalseNoCondition operator for the second condition.
ConditionsAndOr2StringFalseNoHow to connect to the previous condition. Allowed values are AND or OR.
ConditionsField3StringFalseNoField name for the third condition.
ConditionsValue3StringFalseNoField value for the third condition.
ConditionsOperator3StringFalseNoCondition operator for the third condition.
ConditionsAndOr3StringFalseNoHow to connect to the previous condition. Allowed values are AND or OR.
ConditionsField4StringFalseNoField name for the fourth condition.
ConditionsValue4StringFalseNoField value for the fourth condition.
ConditionsOperator4StringFalseNoCondition operator for the fourth condition.
ConditionsAndOr4StringFalseNoHow to connect to the previous condition. Allowed values are AND or OR.
ConditionsField5StringFalseNoField name for the fifth condition.
ConditionsValue5StringFalseNoField value for the fifth condition.
ConditionsOperator5StringFalseNoCondition operator for the fifth condition.
ConditionsAndOr5StringFalseNoHow to connect to the previous condition. Allowed values are AND or OR.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerFalseNoThe unique identifier of the sender identity.
NicknameStringFalseNoA nickname for the sender identity. Not used for sending..
FromEmailStringFalseNoThis is where the email will appear to originate from for your recipient.
FromNameStringFalseNoThis is the name appended to the from email field. IE - Your name or company name.
ReplytoEmailStringFalseNoThis is the email that your recipient will reply to.
ReplytoNameStringFalseNoThis is the name appended to the reply to email field. IE - Your name or company name.
AddressStringFalseNoThe physical address of the sender identity.
Address2StringFalseNoAdditional sender identity address information.
CityStringFalseNoThe city of the sender identity.
StateStringFalseNoThe state of the sender identity.
ZipStringFalseNoThe zipcode of the sender identity.
CountryStringFalseNoThe country of the sender identity.
CreatedAtDatetimeTrueNoThe end of the time range when the bounce was created.
UpdatedAtDatetimeTrueNoThe end of the time range when the bounce was created.
LockedBooleanTrueNoA boolean flag that is true when the Sender is associated with a campaign in Draft, Scheduled, or In Progress status. You cannot update or delete a locked Sender.
VerifiedReasonStringTrueNoThe reason for verifying the sender
VerifiedStatusBooleanTrueNoA boolean flag indicating whether the Sender is verified or not. Only verified Senders can be used to send email.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedAtDatetimeTrueNoThe time when the spam report was made.
Email [KEY]StringFalseNoThe email address of the recipient who marked your message as spam.
IpStringFalseNoThe IP address that the message was sent on.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TypeStringFalseNoThe type of the statistic.
NameStringFalseNoThe name of the statistic.
DateDateTrueNoThe time the global statistic was created.
ClicksIntegerFalseNoThe number of links clicked in your emails.
UniqueClicksIntegerFalseNoThe number of unique recipients who clicked links in your emails.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TypeStringFalseNoThe type of the statistic.
NameStringFalseNoThe name of the statistic.
DateDateTrueNoThe time the global statistic was created.
OpensIntegerFalseNoThe number of times your emails were opened by recipients.
UniqueOpensIntegerFalseNoThe number of unique recipients who opened your emails.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TypeStringFalseNoThe type of the statistic.
NameStringFalseNoThe name of the statistic.
DateDateTrueNoThe time the global statistic was created.
OpensIntegerFalseNoThe number of times your emails were opened by recipients.
UniqueOpensIntegerFalseNoThe number of unique recipients who opened your emails.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TypeStringFalseNoThe type of the statistic.
NameStringFalseNoThe name of the statistic.
DateDateTrueNoThe time the global statistic was created.
ClicksIntegerFalseNoThe number of links clicked in your emails.
OpensIntegerFalseNoThe number of times your emails were opened by recipients.
UniqueClicksIntegerFalseNoThe number of unique recipients who clicked links in your emails.
UniqueOpensIntegerFalseNoThe number of unique recipients who opened your emails.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TypeStringFalseNoThe type of the statistic.
NameStringFalseNoThe name of the statistic.
DateDateTrueNoThe time the global statistic was created.
BlocksIntegerFalseNoThe number of emails that were not allowed to be delivered by ISPs.
DropsIntegerFalseNoThe number of emails automatically dropped by SendGrid because they appear on one of the suppression lists.
BouncesIntegerFalseNoThe number of emails that bounced instead of being delivered.
ClicksIntegerFalseNoThe number of links clicked in your emails.
DeferredIntegerFalseNoThe number of emails temporarily refused by the receiving server.
DeliveredIntegerFalseNoThe number of emails confirmed delivered.
OpensIntegerFalseNoThe number of times your emails were opened by recipients.
ProcessedIntegerFalseNoThe number of emails pushed to SendGrid.
RequestsIntegerFalseNoThe number of emails you requested to send via SendGrid.
SpamReportsIntegerFalseNoThe number of emails marked as spam by recipients.
UniqueClicksIntegerFalseNoThe number of unique recipients who clicked links in your emails.
UniqueOpensIntegerFalseNoThe number of unique recipients who opened your emails.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdIntegerTrueNoThe Id of the subuser.
EmailStringTrueNoThe email of the subuser.
UsernameStringTrueNoThe username of the subuser.
DisabledBooleanTrueNoIndicates whether the subuser is enabled or disabled.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
DateDateTrueNoThe time the subuser statistic was created.
BlocksIntegerFalseNoThe number of emails that were not allowed to be delivered by ISPs.
DropsIntegerFalseNoThe number of emails automatically dropped because they appear on one of the suppression lists.
BouncesIntegerFalseNoThe number of emails that bounced instead of being delivered.
ClicksIntegerFalseNoThe number of links that were clicked in the emails from this subuser.
DeferredIntegerFalseNoThe number of emails temporarily refused by the receiving server.
DeliveredIntegerFalseNoThe number of emails from this subsuer that were confirmed delivered.
InvalidEmailsIntegerFalseNoThe number of emails with a malformed address or reported as invalid by the receiving server.
OpensIntegerFalseNoThe number of times emails from this subuser were opened by recipients.
ProcessedIntegerFalseNoThe number of emails pushed to SendGrid by this subuser.
RequestsIntegerFalseNoThe number of emails that you requested to send via SendGrid from this subuser.
SpamReportDropsIntegerFalseNoThe number of emails automatically dropped because the emails were marked as spam by the recipients.
SpamReportsIntegerFalseNoThe number of emails from this subuser that were marked as spam by recipients.
UniqueClicksIntegerFalseNoThe number of unique recipients who clicked on links in your emails from this subuser.
UniqueOpensIntegerFalseNoThe number of unique recipients who opened your emails from this subuser.
UnsubscribeDropsIntegerFalseNoThe number of emails from this subuser dropped by SendGrid because the recipients unsubscribed from your emails.
UnsubscribesIntegerFalseNoThe number of recipients who unsubscribed from your emails from this subuser.
SubuserNameStringFalseNoThe name of the statistic.
TypeStringFalseNoThe type of the statistic.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Username [KEY]StringFalseNoThe username of the teammate.
EmailStringFalseNoEmail of the teammate.
FirstNameStringFalseNoFirst name of the teammate.
LastNameStringFalseNoLast name of the teammate.
UserTypeStringFalseNoUser type of the teammate.
IsAdminBooleanFalseNoIndicator if the teammate is admin.
PhoneStringFalseNoPhone of the teammate.
WebsiteStringFalseNoWebsite of the teammate.
CompanyStringFalseNoCompany of the teammate.
AddressStringFalseNoAddress of the teammate.
Address2StringFalseNoAddress 2 of the teammate.
CityStringFalseNoCity of the teammate.
StateStringFalseNoState of the teammate.
CountryStringFalseNoCountry of the teammate.
ZipStringFalseNoZip of the teammate.
ScopesStringFalseNoScope of the permissions for the new teammate. Multiple values are allowed and should be split by a comma symbol. Possible values are: user.account.read,user.credits.read,user.email.create,user.email.read,user.email.update,user.email.delete,user.profile.create,user.profile.read,user.profile.update,user.profile.delete
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId of the unsubscribe group.
NameStringFalseNoThe name of the unsubscribe group.
DescriptionStringFalseNoThe description of the unsubscribe group.
LastEmailSentAtDatetimeTrueNoThe last time an email was sent to the unsubscribe group.
IsDefaultBooleanFalseNoIf the unsubscribe group is the default group or not.
UnsubscribesIntegerTrueNoThe number of unsubscribes from this group.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id of the user.
AddressStringFalseNoThe address of the user.
Address2StringFalseNoThe secondary address field for the user.
CityStringFalseNoThe city of the user.
CompanyStringFalseNoThe company of the user.
CountryStringFalseNoThe country of the user.
FirstNameStringFalseNoThe first name of the user.
LastNameStringFalseNoThe last name of the user.
PhoneStringFalseNoThe phone number of the user.
StateStringFalseNoThe state the user is located in.
WebsiteStringFalseNoThe Web site URL of the user.
ZipStringFalseNoThe ZIP code of the user.
EmailStringTrueNoThe Email Address of the user.
AccountIdStringFalseYesThe ID of the account.
SubuserUsernameStringFalseYesThe username of the subuser.

Return to Top