--- schema_version: "1" id: dfcd8d43228424557d069ff7e363bfb98a19cdddea62ddd79ae5e93523220bd2 title: SendGrid Connector Objects (Legacy Schema) collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/data-cloud/data-cloud-int/guides/sendgrid/c360-a-sendgrid-objects-legacy.md canonical_url: https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-sendgrid-objects-legacy.html source_site: developer.salesforce.com content_type: documentation content_hash: 84c869e88c25abeffb57775ab53ba3b727da418f901d14bb9be95dd32b90fefa products: - Data 360 Integration Guide - Data 360 Developer Documentation --- # SendGrid Connector Objects (Legacy Schema) **note:** This feature is a Beta Service. A customer may opt to try a Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at [Agreements and Terms.](https://www.salesforce.com/company/legal/agreements/) If you have questions or feedback about this Beta Service, contact the Data 360 Connector team at [datacloud-connectors-beta@salesforce.com.](mailto:datacloud-connectors-beta@salesforce.com) ## Objects Supported | Name | Description | | ------------------------------------------------- | ------------------------------------------------------------------- | | [Alerts](#alerts) | Create, update, delete, and query Alerts in SendGrid. | | [ApiKeys](#apikeys) | Query, Create, Update and Delete the available ApiKeys in SendGrid. | | [Blocks](#blocks) | Query and Delete the available Blocks in SendGrid. | | [Bounces](#bounces) | Query and Delete the available Bounces in SendGrid. | | [CancelScheduledSends](#cancelscheduledsends) | Update, delete, and query Cancel Scheduled Sends in SendGrid. | | [Categories](#categories) | Query the available Categories in SendGrid. | | [CategoryStats](#categorystats) | Query the available Category Stats in SendGrid. | | [CustomFields](#customfields) | Create, delete, and query Custom Fields in SendGrid. | | [DynamicTemplates](#dynamictemplates) | Query Teammates in SendGrid. | | [GlobalStats](#globalstats) | Query the available Global Stats in SendGrid. | | [GlobalUnsubscribes](#globalunsubscribes) | Query Global Unsubscribes in SendGrid. | | [GroupSuppressions](#groupsuppressions) | Query group suppressions in SendGrid. | | [InvalidEmails](#invalidemails) | Query and Delete invalid emails in SendGrid. | | [IPAccessManagement](#ipaccessmanagement) | Query Global Unsubscribes in SendGrid. | | [Lists](#lists) | Create, update, delete, and query the available Lists in SendGrid. | | [MailSettings](#mailsettings) | Query all the mail settings in SendGrid. | | [MarketingCampaigns](#marketingcampaigns) | Create, update, delete, and query Marketing Campaigns in SendGrid. | | [MessageEvents](#messageevents) | List of events related to email message in SendGrid. | | [Messages](#messages) | Query Email Activities in SendGrid. | | [PartnerSettings](#partnersettings) | Query all the partner settings in SendGrid. | | [Recipients](#recipients) | The SendGrid table Recipients. | | [ReservedFields](#reservedfields) | Query the available Reserved Fields in SendGrid. | | [Schedules](#schedules) | Create, update, delete, and query Campaign Schedules in SendGrid. | | [Segments](#segments) | Create, update, delete, and query Segments in SendGrid. | | [SenderIdentities](#senderidentities) | Create, update, delete, and query Sender Identities in SendGrid. | | [Spam](#spam) | Query and delete Spam reports in SendGrid. | | [StatsByBrowser](#statsbybrowser) | Query Browser Statistics in SendGrid. | | [StatsByClient](#statsbyclient) | Query Client Statistics in SendGrid. | | [StatsByDevice](#statsbydevice) | Query Device Statistics in SendGrid. | | [StatsByLocation](#statsbylocation) | Query Location Statistics in SendGrid. | | [StatsByMailboxProvider](#statsbymailboxprovider) | Query Mailbox Provider Statistics in SendGrid. | | [Subusers](#subusers) | Query all the subusers in sendgrid. | | [SubuserStats](#subuserstats) | Query Subuser Statistics in SendGrid. | | [Teammates](#teammates) | Query Teammates in SendGrid. | | [UnsubscribeGroups](#unsubscribegroups) | Create, update, delete, and query Unsubscribe Groups in SendGrid. | | [Users](#users) | Query the available Users in SendGrid. | ## Alerts | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | -------- | -------- | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | Id [KEY] | Integer | False | | No | The ID of the alert. | | CreatedAt | Datetime | True | | No | Date when the alert was created. | | UpdatedAt | Datetime | True | | No | Date when the alert was updated. | | EmailTo | String | False | | No | The email address that the alert will be sent to. | | Percentage | Integer | False | | No | The email address that the alert will be sent to. | | Type | String | False | | No | The type of alert. Allowed values (usage_limit, stats_notification). | | Frequency | String | False | | No | If the alert is of type stats_notification, this indicates how frequently the stats notifications will be sent.(daily, weekly, monthly). | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## ApiKeys | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------ | -------- | ---------- | ---------- | ---------------------------------------------------------------------------------------- | | ApiKeyId [KEY] | String | False | | No | The ID of your API Key. | | Name | String | False | | No | The name of your API Key. | | Scopes | String | False | | No | The permissions this API Key has access to. This is populated only when Id is specified. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## Blocks | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | -------- | -------- | ---------- | ---------- | --------------------------------- | | CreatedAt | Datetime | True | | No | The time the block was created. | | Reason | String | False | | No | The reason for the block. | | Email [KEY] | String | False | | No | The email that blocked. | | Status | String | False | | No | The enhanced SMTP block response. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## Bounces | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | -------- | -------- | ---------- | ---------- | ---------------------------------- | | CreatedAt | Datetime | True | | No | The time the bounce was created. | | Reason | String | False | | No | The reason for the bounce. | | Email [KEY] | String | False | | No | The email that bounced. | | Status | String | False | | No | The enhanced SMTP bounce response. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## CancelScheduledSends | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------ | -------- | ---------- | ---------- | -------------------------------------------------------------- | | BatchId [KEY] | String | False | | No | The Id of the batch. | | Status | String | False | | No | The status of the scheduled send.Allowed Values: cancel, pause | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## Categories | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------ | -------- | ---------- | ---------- | ---------------------------- | | Name | String | True | | No | The name of the categories. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## CategoryStats | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------- | ------- | -------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------- | | Type | String | False | | No | The type of the statistic. | | Name | String | False | | No | The name of the category. | | Date | Date | True | | No | The time the global statistic was created. | | Blocks | Integer | False | | No | The number of emails that were not allowed to be delivered by ISPs. | | Drops | Integer | False | | No | The number of emails automatically dropped by SendGrid because they appear on one of the suppression lists. | | Bounces | Integer | False | | No | The number of emails that bounced instead of being delivered. | | Clicks | Integer | False | | No | The number of links clicked in your emails. | | Deferred | Integer | False | | No | The number of emails temporarily refused by the receiving server. | | Delivered | Integer | False | | No | The number of emails confirmed delivered. | | InvalidEmails | Integer | False | | No | The number of emails with a malformed address or reported as invalid by the receiving server. | | Opens | Integer | False | | No | The number of times your emails were opened by recipients. | | Processed | Integer | False | | No | The number of emails pushed to SendGrid. | | Requests | Integer | False | | No | The number of emails you requested to send via SendGrid. | | SpamReportDrops | Integer | False | | No | The number of emails automatically dropped because the emails were marked as spam by the recipients. | | SpamReports | Integer | False | | No | The number of emails marked as spam by recipients. | | UniqueClicks | Integer | False | | No | The number of unique recipients who clicked links in your emails. | | UniqueOpens | Integer | False | | No | The number of unique recipients who opened your emails. | | UnsubscribeDrops | Integer | False | | No | The number of emails in this category dropped by SendGrid because the recipient unsubscribed from your emails. | | Unsubscribes | Integer | False | | No | The number of recipients who unsubscribed from your emails. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## CustomFields | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------ | -------- | ---------- | ---------- | ----------------------------------------------------------------------- | | Id [KEY] | String | False | | No | The Id of the custom field. | | Name | String | False | | No | The name of the custom field. | | Type | String | False | | No | The type of the custom field. Allowed values are number, text, or date. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## DynamicTemplates | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------- | -------- | -------- | ---------- | ---------- | --------------------------------------- | | Id [KEY] | String | False | | No | The ID of the template. | | Name | String | False | | No | Name of the template. | | Generation | String | False | | No | Generation of the template. (dynamic) | | UpdatedAt | Datetime | False | | No | The last time the template was updated. | [Return to Top](#objects-supported) ## GlobalStats | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------- | ------- | -------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------- | | Date | Date | True | | No | The time the global statistic was created. | | Blocks | Integer | False | | No | The number of emails that were not allowed to be delivered by ISPs. | | BounceDrops | Integer | False | | No | The number of emails automatically dropped by SendGrid because they appear on one of the suppression lists. | | Bounces | Integer | False | | No | The number of emails that bounced instead of being delivered. | | Clicks | Integer | False | | No | The number of links clicked in your emails. | | Deferred | Integer | False | | No | The number of emails temporarily refused by the receiving server. | | Delivered | Integer | False | | No | The number of emails confirmed delivered. | | InvalidEmails | Integer | False | | No | The number of emails with a malformed address or reported as invalid by the receiving server. | | Opens | Integer | False | | No | The number of times your emails were opened by recipients. | | Processed | Integer | False | | No | The number of emails pushed to SendGrid. | | Requests | Integer | False | | No | The number of emails you requested to send via SendGrid. | | SpamReportDrops | Integer | False | | No | The number of emails automatically dropped because the emails were marked as spam by the recipients. | | SpamReports | Integer | False | | No | The number of emails marked as spam by recipients. | | UniqueClicks | Integer | False | | No | The number of unique recipients who clicked links in your emails. | | UniqueOpens | Integer | False | | No | The number of unique recipients who opened your emails. | | UnsubscribeDrops | Integer | False | | No | The number of emails globally dropped by SendGrid because the recipient unsubscribed from your emails. | | Unsubscribes | Integer | False | | No | The number of recipients who unsubscribed from your emails. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## GlobalUnsubscribes | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | -------- | -------- | ---------- | ---------- | -------------------------------------- | | Email [KEY] | String | False | | No | Email of the unsubscriber. | | CreatedAt | Datetime | True | | No | The time the unsubscriber was created. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## GroupSuppressions | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------- | -------- | ---------- | ---------- | -------------------------------------- | | GroupId [KEY] | Integer | False | | No | Email of the unsubscriber. | | Emails | String | False | | No | The time the unsubscriber was created. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## InvalidEmails | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | -------- | -------- | ---------- | ---------- | ------------------------------------------------------------------------- | | Created | Datetime | True | | No | The time the when the email address was added to the invalid emails list. | | Reason | String | False | | No | A reason explaining why the email address was marked as invalid.. | | Email [KEY] | String | False | | No | The email address that was marked as invalid. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## IPAccessManagement | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | --------- | -------- | ---------- | ---------- | -------------------------------------------- | | IP | String | False | | No | IP Address. | | Allowed | Boolean | False | | No | Indicator if this IP is allowed for access. | | AuthMethod | String | False | | No | Authentication method. | | FirstAt | Timestamp | False | | No | First time when IP has accessed the account. | | LastAt | Timestamp | False | | No | Last time when IP has accessed the account. | | Location | String | False | | No | Location of the IP. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## Lists | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------- | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Integer | True | | No | The Id of the list. | | Name | String | False | | No | The name of the list. | | RecipientCount | Integer | True | | No | The recipient count of the list. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## MailSettings | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------ | -------- | ---------- | ---------- | ---------------------------------------------------- | | Title | String | False | | No | The title of the mail setting. | | Enabled | String | False | | No | Indicates if this mail setting is currently enabled. | | Name | String | False | | No | The name of the mail setting. | | Description | String | False | | No | A description of the mail setting. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## MarketingCampaigns | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------------- | ------- | -------- | ---------- | ---------- | ------------------------------------------------------------------------ | | Id [KEY] | String | True | | No | The Id of the marketing campaign. | | Title | String | False | | No | The title of the marketing campaign. | | Subject | String | False | | No | The subject of the marketing campaign. | | SenderId | Integer | False | | No | The sender Ids of the marketing campaign, separated by a comma. | | ListIds | String | False | | No | The list of list Ids of the marketing campaign, separated by a comma. | | SegmentIds | String | False | | No | The list of segment Ids of the marketing campaign, separated by a comma. | | Categories | String | False | | No | The categories of the marketing campaign. | | SuppressionGroupId | Integer | False | | No | The suppression group Id of the marketing campaign. | | CustomUnsubscribeUrl | String | False | | No | The custom unsubscribe URL of the marketing campaign. | | IpPool | String | False | | No | The IP pool of the marketing campaign. | | HtmlContent | String | False | | No | The HTML content of the marketing campaign. | | PlainContent | String | False | | No | The content of the marketing campaign. | | Status | String | True | | No | The status of the marketing campaign. | | Editor | String | False | | No | The editor used in the UI. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## MessageEvents | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ---------- | ---------- | --------------------------------------------------------------------------------- | | MessageId | String | True | | No | The Id of the message. | | EventName | String | True | | No | Name of event. | | Processed | Datetime | True | | No | The date when the event was processed. | | Reason | String | True | | No | Explanation of what caused the message to be 'bounced', 'deferred', or 'blocked'. | | AttemptNum | Integer | True | | No | Used with 'deferred' events to indicate the attempt number out of 10. | | Url | String | True | | No | Used with 'clicked' event to indicate which url the user clicked. | | BounceType | String | True | | No | Use to distinguish between types of bounces. | | HttpUserAgent | String | True | | No | Client recipient used to click or open message. | | MXServer | String | True | | No | The MX server that received the email. | | ApiKeyId | String | True | | No | Id of the API Key. | | AsmGroupId | String | True | | No | ASM Group Id. | | Categories | String | True | | No | Categories users associated to the message. | | UniqueArgs | String | True | | No | JSON hash of key-value pairs associated with the message. | | OriginatingIp | String | True | | No | This is the IP address of the person sending the message | | OutboundIp | String | True | | No | This is the SendGrid dedicated IP address used to send the email | | OutboundIpType | String | True | | No | The type of the outbound IP. | | Teammate | String | True | | No | Username of the teammate. | | TemplateId | String | True | | No | Template ID of the email. | [Return to Top](#objects-supported) ## Messages | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------------ | -------- | -------- | ---------- | ---------- | ---------------------------------------------------------------- | | Id [KEY] | String | True | | No | The Id of the message. | | Status | String | True | | No | Status of the email. | | Subject | String | True | | No | Subject of the email. | | FromEmail | String | True | | No | The email of the sender. | | ToEmail | String | True | | No | The email of the receiver. | | ClicksCount | Integer | True | | No | The number of clicks. | | OpensCount | Integer | True | | No | The number of times that the email was opened. | | LastEventTime | Datetime | True | | No | The datetime of the event. | | ApiKeyId | String | True | | No | Id of the API Key. | | AsmGroupId | String | True | | No | ASM Group Id. | | MarketingCampaignId | String | True | | No | The id of the marketing campaign. | | MarketingCampaignName | String | True | | No | The name of the marketing campaign. | | MarketingCampaignSplitId | String | True | | No | Split id of the campaign. | | MarketingCampaignVersion | String | True | | No | Version of the campaign. | | OriginatingIp | String | True | | No | This is the IP address of the person sending the message | | OutboundIp | String | True | | No | This is the SendGrid dedicated IP address used to send the email | | OutboundIpType | String | True | | No | The type of the outbound IP. | | Teammate | String | True | | No | Username of the teammate. | | TemplateId | String | True | | No | Template ID of the email. | | Events | String | True | | No | List of events related to email message in SendGrid. | [Return to Top](#objects-supported) ## PartnerSettings | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------ | -------- | ---------- | ---------- | --------------------------------------------------- | | Title | String | False | | No | The title of the partner. | | Enabled | String | False | | No | Indicates if this partner setting has been enabled. | | Name | String | False | | No | The name of the partner setting. | | Description | String | False | | No | A description of this partner setting. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## Recipients | Name | Type | ReadOnly | References | FilterOnly | Description | | ----------- | -------- | -------- | ---------- | ---------- | ---------------------------------------------------------------------- | | Id [KEY] | String | False | | No | This column is dynamic and maps to the corresponding field in the API. | | SegmentId | Int32 | False | | No | This column is dynamic and maps to the corresponding field in the API. | | ListId | Int32 | False | | No | This column is dynamic and maps to the corresponding field in the API. | | Email | String | False | | No | This column is dynamic and maps to the corresponding field in the API. | | FirstName | String | False | | No | This column is dynamic and maps to the corresponding field in the API. | | LastName | String | False | | No | This column is dynamic and maps to the corresponding field in the API. | | CreatedAt | Datetime | True | | No | This column is dynamic and maps to the corresponding field in the API. | | LastClicked | Datetime | True | | No | This column is dynamic and maps to the corresponding field in the API. | | LastEmailed | Datetime | False | | No | This column is dynamic and maps to the corresponding field in the API. | | LastOpened | Datetime | True | | No | This column is dynamic and maps to the corresponding field in the API. | | UpdatedAt | Datetime | True | | No | This column is dynamic and maps to the corresponding field in the API. | | Age | String | False | | No | This column is dynamic and maps to the corresponding field in the API. | | Department | String | False | | No | This column is dynamic and maps to the corresponding field in the API. | | University | String | False | | No | This column is dynamic and maps to the corresponding field in the API. | [Return to Top](#objects-supported) ## ReservedFields | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------ | -------- | ---------- | ---------- | ------------------------------- | | Name | String | False | | No | The name of the reserved field. | | Type | String | False | | No | The type of the reserved field. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## Schedules | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------------- | -------- | -------- | ---------- | ---------- | ---------------------------- | | MarketingCampaignId [KEY] | Integer | False | | No | Id of the campaign. | | Status | String | True | | No | Status of the campaign. | | SendAt | Datetime | False | | No | Date to start the campaign. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## Segments | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------- | -------- | ---------- | ---------- | ----------------------------------------------------------------------- | | Id [KEY] | Integer | True | | No | The Id of the segment. | | Name | String | False | | No | The name of the segment. | | ListId | Integer | False | | No | The Id of the list associated with the segment. | | RecipientCount | Integer | True | | No | The recipient count of the segment. | | ConditionsField1 | String | False | | No | Field name for the first condition. | | ConditionsValue1 | String | False | | No | Field value for the first condition. | | ConditionsOperator1 | String | False | | No | Condition operator for the first condition. | | ConditionsAndOr1 | String | False | | No | How to connect to the previous condition. Allowed values are AND or OR. | | ConditionsField2 | String | False | | No | Field name for the second condition. | | ConditionsValue2 | String | False | | No | Field value for the second condition. | | ConditionsOperator2 | String | False | | No | Condition operator for the second condition. | | ConditionsAndOr2 | String | False | | No | How to connect to the previous condition. Allowed values are AND or OR. | | ConditionsField3 | String | False | | No | Field name for the third condition. | | ConditionsValue3 | String | False | | No | Field value for the third condition. | | ConditionsOperator3 | String | False | | No | Condition operator for the third condition. | | ConditionsAndOr3 | String | False | | No | How to connect to the previous condition. Allowed values are AND or OR. | | ConditionsField4 | String | False | | No | Field name for the fourth condition. | | ConditionsValue4 | String | False | | No | Field value for the fourth condition. | | ConditionsOperator4 | String | False | | No | Condition operator for the fourth condition. | | ConditionsAndOr4 | String | False | | No | How to connect to the previous condition. Allowed values are AND or OR. | | ConditionsField5 | String | False | | No | Field name for the fifth condition. | | ConditionsValue5 | String | False | | No | Field value for the fifth condition. | | ConditionsOperator5 | String | False | | No | Condition operator for the fifth condition. | | ConditionsAndOr5 | String | False | | No | How to connect to the previous condition. Allowed values are AND or OR. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## SenderIdentities | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | -------- | -------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Id [KEY] | Integer | False | | No | The unique identifier of the sender identity. | | Nickname | String | False | | No | A nickname for the sender identity. Not used for sending.. | | FromEmail | String | False | | No | This is where the email will appear to originate from for your recipient. | | FromName | String | False | | No | This is the name appended to the from email field. IE - Your name or company name. | | ReplytoEmail | String | False | | No | This is the email that your recipient will reply to. | | ReplytoName | String | False | | No | This is the name appended to the reply to email field. IE - Your name or company name. | | Address | String | False | | No | The physical address of the sender identity. | | Address2 | String | False | | No | Additional sender identity address information. | | City | String | False | | No | The city of the sender identity. | | State | String | False | | No | The state of the sender identity. | | Zip | String | False | | No | The zipcode of the sender identity. | | Country | String | False | | No | The country of the sender identity. | | CreatedAt | Datetime | True | | No | The end of the time range when the bounce was created. | | UpdatedAt | Datetime | True | | No | The end of the time range when the bounce was created. | | Locked | Boolean | True | | No | A 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. | | VerifiedReason | String | True | | No | The reason for verifying the sender | | VerifiedStatus | Boolean | True | | No | A boolean flag indicating whether the Sender is verified or not. Only verified Senders can be used to send email. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## Spam | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | -------- | -------- | ---------- | ---------- | ------------------------------------------------------------------- | | CreatedAt | Datetime | True | | No | The time when the spam report was made. | | Email [KEY] | String | False | | No | The email address of the recipient who marked your message as spam. | | Ip | String | False | | No | The IP address that the message was sent on. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## StatsByBrowser | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------- | -------- | ---------- | ---------- | ----------------------------------------------------------------- | | Type | String | False | | No | The type of the statistic. | | Name | String | False | | No | The name of the statistic. | | Date | Date | True | | No | The time the global statistic was created. | | Clicks | Integer | False | | No | The number of links clicked in your emails. | | UniqueClicks | Integer | False | | No | The number of unique recipients who clicked links in your emails. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## StatsByClient | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------- | -------- | ---------- | ---------- | ---------------------------------------------------------- | | Type | String | False | | No | The type of the statistic. | | Name | String | False | | No | The name of the statistic. | | Date | Date | True | | No | The time the global statistic was created. | | Opens | Integer | False | | No | The number of times your emails were opened by recipients. | | UniqueOpens | Integer | False | | No | The number of unique recipients who opened your emails. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## StatsByDevice | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------- | -------- | ---------- | ---------- | ---------------------------------------------------------- | | Type | String | False | | No | The type of the statistic. | | Name | String | False | | No | The name of the statistic. | | Date | Date | True | | No | The time the global statistic was created. | | Opens | Integer | False | | No | The number of times your emails were opened by recipients. | | UniqueOpens | Integer | False | | No | The number of unique recipients who opened your emails. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## StatsByLocation | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------- | -------- | ---------- | ---------- | ----------------------------------------------------------------- | | Type | String | False | | No | The type of the statistic. | | Name | String | False | | No | The name of the statistic. | | Date | Date | True | | No | The time the global statistic was created. | | Clicks | Integer | False | | No | The number of links clicked in your emails. | | Opens | Integer | False | | No | The number of times your emails were opened by recipients. | | UniqueClicks | Integer | False | | No | The number of unique recipients who clicked links in your emails. | | UniqueOpens | Integer | False | | No | The number of unique recipients who opened your emails. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## StatsByMailboxProvider | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------- | -------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------- | | Type | String | False | | No | The type of the statistic. | | Name | String | False | | No | The name of the statistic. | | Date | Date | True | | No | The time the global statistic was created. | | Blocks | Integer | False | | No | The number of emails that were not allowed to be delivered by ISPs. | | Drops | Integer | False | | No | The number of emails automatically dropped by SendGrid because they appear on one of the suppression lists. | | Bounces | Integer | False | | No | The number of emails that bounced instead of being delivered. | | Clicks | Integer | False | | No | The number of links clicked in your emails. | | Deferred | Integer | False | | No | The number of emails temporarily refused by the receiving server. | | Delivered | Integer | False | | No | The number of emails confirmed delivered. | | Opens | Integer | False | | No | The number of times your emails were opened by recipients. | | Processed | Integer | False | | No | The number of emails pushed to SendGrid. | | Requests | Integer | False | | No | The number of emails you requested to send via SendGrid. | | SpamReports | Integer | False | | No | The number of emails marked as spam by recipients. | | UniqueClicks | Integer | False | | No | The number of unique recipients who clicked links in your emails. | | UniqueOpens | Integer | False | | No | The number of unique recipients who opened your emails. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## Subusers | Name | Type | ReadOnly | References | FilterOnly | Description | | -------- | ------- | -------- | ---------- | ---------- | ----------------------------------------------------- | | Id | Integer | True | | No | The Id of the subuser. | | Email | String | True | | No | The email of the subuser. | | Username | String | True | | No | The username of the subuser. | | Disabled | Boolean | True | | No | Indicates whether the subuser is enabled or disabled. | [Return to Top](#objects-supported) ## SubuserStats | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------- | ------- | -------- | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------- | | Date | Date | True | | No | The time the subuser statistic was created. | | Blocks | Integer | False | | No | The number of emails that were not allowed to be delivered by ISPs. | | Drops | Integer | False | | No | The number of emails automatically dropped because they appear on one of the suppression lists. | | Bounces | Integer | False | | No | The number of emails that bounced instead of being delivered. | | Clicks | Integer | False | | No | The number of links that were clicked in the emails from this subuser. | | Deferred | Integer | False | | No | The number of emails temporarily refused by the receiving server. | | Delivered | Integer | False | | No | The number of emails from this subsuer that were confirmed delivered. | | InvalidEmails | Integer | False | | No | The number of emails with a malformed address or reported as invalid by the receiving server. | | Opens | Integer | False | | No | The number of times emails from this subuser were opened by recipients. | | Processed | Integer | False | | No | The number of emails pushed to SendGrid by this subuser. | | Requests | Integer | False | | No | The number of emails that you requested to send via SendGrid from this subuser. | | SpamReportDrops | Integer | False | | No | The number of emails automatically dropped because the emails were marked as spam by the recipients. | | SpamReports | Integer | False | | No | The number of emails from this subuser that were marked as spam by recipients. | | UniqueClicks | Integer | False | | No | The number of unique recipients who clicked on links in your emails from this subuser. | | UniqueOpens | Integer | False | | No | The number of unique recipients who opened your emails from this subuser. | | UnsubscribeDrops | Integer | False | | No | The number of emails from this subuser dropped by SendGrid because the recipients unsubscribed from your emails. | | Unsubscribes | Integer | False | | No | The number of recipients who unsubscribed from your emails from this subuser. | | SubuserName | String | False | | No | The name of the statistic. | | Type | String | False | | No | The type of the statistic. | [Return to Top](#objects-supported) ## Teammates | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------- | -------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Username [KEY] | String | False | | No | The username of the teammate. | | Email | String | False | | No | Email of the teammate. | | FirstName | String | False | | No | First name of the teammate. | | LastName | String | False | | No | Last name of the teammate. | | UserType | String | False | | No | User type of the teammate. | | IsAdmin | Boolean | False | | No | Indicator if the teammate is admin. | | Phone | String | False | | No | Phone of the teammate. | | Website | String | False | | No | Website of the teammate. | | Company | String | False | | No | Company of the teammate. | | Address | String | False | | No | Address of the teammate. | | Address2 | String | False | | No | Address 2 of the teammate. | | City | String | False | | No | City of the teammate. | | State | String | False | | No | State of the teammate. | | Country | String | False | | No | Country of the teammate. | | Zip | String | False | | No | Zip of the teammate. | | Scopes | String | False | | No | Scope 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 | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## UnsubscribeGroups | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | -------- | -------- | ---------- | ---------- | --------------------------------------------------------- | | Id [KEY] | Integer | True | | No | Id of the unsubscribe group. | | Name | String | False | | No | The name of the unsubscribe group. | | Description | String | False | | No | The description of the unsubscribe group. | | LastEmailSentAt | Datetime | True | | No | The last time an email was sent to the unsubscribe group. | | IsDefault | Boolean | False | | No | If the unsubscribe group is the default group or not. | | Unsubscribes | Integer | True | | No | The number of unsubscribes from this group. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## Users | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------ | -------- | ---------- | ---------- | ----------------------------------------- | | Id [KEY] | String | True | | No | The Id of the user. | | Address | String | False | | No | The address of the user. | | Address2 | String | False | | No | The secondary address field for the user. | | City | String | False | | No | The city of the user. | | Company | String | False | | No | The company of the user. | | Country | String | False | | No | The country of the user. | | FirstName | String | False | | No | The first name of the user. | | LastName | String | False | | No | The last name of the user. | | Phone | String | False | | No | The phone number of the user. | | State | String | False | | No | The state the user is located in. | | Website | String | False | | No | The Web site URL of the user. | | Zip | String | False | | No | The ZIP code of the user. | | Email | String | True | | No | The Email Address of the user. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported)