--- schema_version: "1" id: 3f3b1f9482d2c5ece2fa14d1b6c653dcbccd69a037ff0d3c4b07c9a67622b4b2 title: SendGrid Connector Objects (NMC 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-nmc.md canonical_url: https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-sendgrid-objects-nmc.html source_site: developer.salesforce.com content_type: documentation content_hash: 5bce46e9e329631bbe3d32164b03a10c108aa589d10fb2625e38c2adbcbb8d24 products: - Data 360 Integration Guide - Data 360 Developer Documentation --- # SendGrid Connector Objects (NMC 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. | | [AutomationStats](#automationstats) | Get All Automation Stats | | [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. | | [Designs](#designs) | List Designs | | [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. | | [MailSettings](#mailsettings) | Query all the mail settings in SendGrid. | | [MessageEvents](#messageevents) | List of events related to email message in SendGrid. | | [Messages](#messages) | Query Email Activities in SendGrid. | | [NMCContacts](#nmccontacts) | Query New Marketing Campaign Contacts in SendGrid. | | [NMCCustomFields](#nmccustomfields) | Create, delete, and query New Marketing Campaign Custom Fields in SendGrid. | | [NMCLists](#nmclists) | Create, update, delete, and query the available New Marketing Campaign Lists in SendGrid. | | [NMCReservedFields](#nmcreservedfields) | Query the available New Marketing Campaign Reserved Fields in SendGrid. | | [NMCSegments](#nmcsegments) | Create, update, delete, and query New Marketing Campaign Segments in SendGrid. | | [NMCSenders](#nmcsenders) | Create, update, delete, and query New Marketing Campaign Senders in SendGrid. | | [NMCSingleSends](#nmcsinglesends) | Create, update, delete, and query the available New Marketing Campaign Single Sends in SendGrid. | | [PartnerSettings](#partnersettings) | Query all the partner settings in SendGrid. | | [SingleSendClickTrackingStats](#singlesendclicktrackingstats) | Get Single Send Click Tracking Stats by ID | | [SingleSendsStats](#singlesendsstats) | Get All Single Sends Stats | | [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. | | [Templates](#templates) | Retrieve paged transactional templates | | [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) ## AutomationStats | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------- | -------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Id | String | False | | No | This is the ID of the Automation you are requesting stats for. | | Aggregation | String | False | | No | This describes the time unit to which the stat is rolled up. It is based on the aggregated_by parameter included in the request. It can be 'total' or the date (in YYYY-MM-DD format) the stats are for. | | StepId | String | False | | No | This is the ID of the step if the stats were requested to be grouped by step_id. | | BounceDrops | Integer | False | | No | BounceDrops | | Bounces | Integer | False | | No | Bounces | | Clicks | Integer | False | | No | Clicks | | Delivered | Integer | False | | No | Delivered | | InvalidEmails | Integer | False | | No | InvalidEmails | | Opens | Integer | False | | No | Opens | | Requests | Integer | False | | No | Requests | | SpamReportDrops | Integer | False | | No | SpamReportDrops | | SpamReports | Integer | False | | No | SpamReports | | UniqueClicks | Integer | False | | No | UniqueClicks | | UniqueOpens | Integer | False | | No | UniqueOpens | | Unsubscribes | Integer | False | | No | Unsubscribes | [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) ## Designs | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------ | ------ | -------- | ---------- | ---------- | --------------------------------------------------- | | Id [KEY] | String | False | | No | ID of the Design. | | UpdatedAt | String | False | | No | Datetime that Design was last updated. | | CreatedAt | String | False | | No | Datetime that Design was created. | | ThumbnailURL | String | False | | No | A Thumbnail preview of the template's html content. | | Name | String | False | | No | The name of the new design. | | Editor | String | False | | No | The editor used in the UI. | | ItemUrl | String | False | | No | The URL of the Design Item. | [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) ## 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) ## 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) ## NMCContacts | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | -------- | -------- | ---------- | ---------- | ---------------------------------------------------------------------- | | Id [KEY] | String | True | | No | This column is dynamic and maps to the corresponding field in the API. | | AddressLine1 | String | True | | No | This column is dynamic and maps to the corresponding field in the API. | | AddressLine2 | String | True | | No | This column is dynamic and maps to the corresponding field in the API. | | City | String | True | | No | This column is dynamic and maps to the corresponding field in the API. | | Country | String | True | | No | This column is dynamic and maps to the corresponding field in the API. | | PostalCode | String | True | | No | This column is dynamic and maps to the corresponding field in the API. | | StateProvinceRegion | String | True | | No | This column is dynamic and maps to the corresponding field in the API. | | Line | String | True | | No | This column is dynamic and maps to the corresponding field in the API. | | Facebook | String | True | | No | This column is dynamic and maps to the corresponding field in the API. | | PhoneNumber | String | True | | No | This column is dynamic and maps to the corresponding field in the API. | | UniqueName | String | True | | No | This column is dynamic and maps to the corresponding field in the API. | | WhatsApp | String | True | | No | This column is dynamic and maps to the corresponding field in the API. | | Email | String | True | | No | This column is dynamic and maps to the corresponding field in the API. | | FirstName | String | True | | No | This column is dynamic and maps to the corresponding field in the API. | | LastName | String | True | | 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. | | UpdatedAt | Datetime | True | | No | This column is dynamic and maps to the corresponding field in the API. | | ItemUrl | String | True | | No | This column is dynamic and maps to the corresponding field in the API. | | SegmentId | String | False | | Yes | This column is dynamic and maps to the corresponding field in the API. | | ListId | String | False | | Yes | This column is dynamic and maps to the corresponding field in the API. | [Return to Top](#objects-supported) ## NMCCustomFields | Name | Type | ReadOnly | References | FilterOnly | Description | | -------- | ------ | -------- | ---------- | ---------- | ----------------------------------------------------------------------- | | Id [KEY] | String | True | | 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. | [Return to Top](#objects-supported) ## NMCLists | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------ | ------- | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | String | True | | No | The Id of the list. | | Name | String | False | | No | The name of the list. | | ContactCount | Integer | True | | No | The recipient count of the list. | | ItemUrl | String | True | | No | The URL of the List Item. | [Return to Top](#objects-supported) ## NMCReservedFields | Name | Type | ReadOnly | References | FilterOnly | Description | | ---- | ------ | -------- | ---------- | ---------- | ------------------------------- | | Id | String | False | | No | The Id of the reserved field. | | Name | String | False | | No | The name of the reserved field. | | Type | String | False | | No | The type of the reserved field. | [Return to Top](#objects-supported) ## NMCSegments | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------- | -------- | -------- | ---------- | ---------- | ----------------------------------------------- | | Id [KEY] | String | True | | No | The Id of the segment. | | Name | String | False | | No | The name of the segment. | | ParentListId | String | False | | No | The Id of the list associated with the segment. | | ContactsCount | Integer | True | | No | The recipient count of the segment. | | CreatedAt | Datetime | True | | No | Field name for the first condition. | | SampleUpdatedAt | Datetime | False | | No | Field name for the first condition. | | UpdatedAt | Datetime | True | | No | Field name for the first condition. | | QueryDSL | String | False | | No | Field name for the first condition. | | NextSampleUpdate | Datetime | True | | No | The last updated samples date. | | ItemUrl | String | True | | No | The URL of the Segment item. | [Return to Top](#objects-supported) ## NMCSenders | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | -------- | -------- | ---------- | ---------- | -------------------------------------------------------------------------------------- | | Id [KEY] | Integer | True | | 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. | | Locked | String | False | | No | Indicator if the sender is locked. | | VerifiedStatus | String | False | | No | Verified status of the sender. | | VerifiedReason | String | False | | No | Verified reason of the sender. | | 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. | | AccountId | String | False | | Yes | The ID of the account. | | SubuserUsername | String | False | | Yes | The username of the subuser. | [Return to Top](#objects-supported) ## NMCSingleSends | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------------------- | -------- | -------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Id [KEY] | String | True | | No | The Id of the single send. | | Name | String | False | | No | The name of the single send. | | Categories | String | False | | No | The name of the single send. | | Status | String | False | | No | The status of the single send. | | CreatedAt | String | True | | No | The created timestamp of the single send. | | UpdatedAt | String | True | | No | The updated timestamp of the single send. | | IsABTest | Boolean | False | | No | Indicator showing if the single send is an AB Test. | | SendAt | Datetime | False | | No | The ISO 8601 time at which to send the single send. | | EmailConfigCustomUnsubscribeUrl | String | False | | No | The URL allowing recipients to unsubscribe. | | EmailConfigEditor | String | False | | No | The editor, design or code, used to modify the Single Send's design in the Marketing Campaigns application user interface. This is populated only when Id is specified. | | EmailConfigGeneratePlainContent | Boolean | False | | No | If this property is set to true, plain_content is always generated from html_content. If it's set to false, plain_content is not altered. This is populated only when Id is specified. | | EmailConfigHtmlContent | String | False | | No | The HTML content of the Single Send. This property is not used when a design_id value is set. This is populated only when Id is specified. | | EmailConfigIpPool | String | False | | No | The name of the IP Pool from which the Single Send emails are sent. This is populated only when Id is specified. | | EmailConfigPlainContent | String | False | | No | The plain text content of the Single Send. This is populated only when Id is specified. | | EmailConfigSenderId | Integer | False | | No | The ID of the verified sender from whom the Single Send will be sent. This is populated only when Id is specified. | | EmailConfigSubject | String | False | | No | The subject line of the Single Send. This is populated only when Id is specified. | | EmailConfigSuppressionGroupId | Integer | False | | No | The ID of the Suppression Group to allow recipients to unsubscribe. This is populated only when Id is specified. | | SendToListIds | String | False | | No | The IDs of each contact list to which the Single Send will be sent. This is populated only when Id is specified. | | SendToSegmentIds | String | False | | No | The IDs of each segment to which the Single Send will be sent. This is populated only when Id is specified. | | SendToAll | Boolean | False | | No | If this property is set to true, the Single Send will be sent to all of your contacts. This is populated only when Id is specified. | | ItemUrl | String | True | | No | The URL of the Single Send Item. | [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) ## SingleSendClickTrackingStats | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------ | ------- | -------- | ------------------------------------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | SingleSendId | String | False | [NMCSingleSends.Id](#nmcsinglesends) | No | The ID of Single Send for which you want to retrieve Click Tracking stats. | | Url | String | False | | No | This is the URL of the link clicked. If {{custom_fields}} are part of the URL, they will be included. | | UrlLocation | Integer | False | | No | This is the location of the link clicked in each Single Send A/B variation, or in the Single Send itself if there are no variations. Links are numbered from the top down; the topmost link is index 0. | | ABvariation | String | False | | No | This is the A/B variation of the Single Send stat returned. It is set to 'all' if the ab_variation query parameter was not set in the request and group_by doesn't contain ab_variation. | | ABphase | String | False | | No | This is the A/B phase of the Single Send stat returned. If the ab_phase query parameter was not provided, it will return 'all'. | | Clicks | Integer | False | | No | The number of clicks on this particular link. | [Return to Top](#objects-supported) ## SingleSendsStats | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | ------- | -------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Id [KEY] | String | False | | No | This is the ID of the Single Send you require stats for. | | ABvariation | String | False | | No | This is the A/B variation of the Single Send stat returned. If the group_by parameter doesn't include ab_variation in the request, then the value is 'all'. | | ABphase | String | False | | No | This is the A/B phase of the Single Send stat returned. If the group_by parameter doesn't include ab_phase in the request, then the value is 'all'. | | Aggregation | String | False | | No | This describes the time unit to which the stat is rolled up. It is based on the aggregated_by parameter included in the request. It can be 'total' or the date (in YYYY-MM-DD format) the stats are for. | | BounceDrops | Integer | False | | No | BounceDrops | | Bounces | Integer | False | | No | Bounces | | Clicks | Integer | False | | No | Clicks | | Delivered | Integer | False | | No | Delivered | | InvalidEmails | Integer | False | | No | InvalidEmails | | Opens | Integer | False | | No | Opens | | Requests | Integer | False | | No | Requests | | SpamReportDrops | Integer | False | | No | SpamReportDrops | | SpamReports | Integer | False | | No | SpamReports | | UniqueClicks | Integer | False | | No | UniqueClicks | | UniqueOpens | Integer | False | | No | UniqueOpens | | Unsubscribes | Integer | False | | No | Unsubscribes | [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) ## Templates | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------- | ------ | -------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------- | | ID [KEY] | String | False | | No | The ID of the transactional template. | | Generation | String | False | | No | Defines the generation of the template. By default, we will get data for both dynamic and legacy. | | Name | String | False | | No | The name for the transactional template. | | UpdatedAt | String | False | | No | The date and time that this transactional template version was updated. | | Versions | String | False | | No | The different versions of this transactional template. | [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)