TDV Adapter for Outreach

Build 22.0.8462

Mailings

Get details of mailings.

Select

The adapter will use the API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the adapter.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • BouncedAt supports the '=,>=,<=,>,<' operators.
  • ClickedAt supports the '=,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • DeliveredAt supports the '=,>=,<=,>,<' operators.
  • MailingType supports the '=,IN' operators.
  • MessageId supports the '=,IN' operators.
  • NotifyThreadStatus supports the '=' operator.
  • OpenedAt supports the '=,>=,<=,>,<' operators.
  • RetryAt supports the '=,>=,<=,>,<' operators.
  • RepliedAt supports the '=,>=,<=,>,<' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
  • ScheduledAt supports the '=,>=,<=,>,<' operators.
  • StateChangedAt supports the '=,>=,<=,>,<' operators.
  • UnsubscribedAt supports the '=,>=,<=,>,<' operators.
  • UserId supports the '=' operator.
  • MailboxId supports the '=' operator.
  • OpportunityId supports the '=' operator.
  • ProspectId supports the '=' operator.
  • SequenceId supports the '=' operator.
  • SequenceStateId supports the '=' operator.
  • SequenceStepId supports the '=' operator.
  • TaskId supports the '=' operator.
For example, the following query is processed server side:
SELECT * FROM Mailings WHERE Id = 1

SELECT * FROM Mailings WHERE Id IN (1,2)

SELECT * FROM Mailings WHERE Id >= 1

SELECT * FROM Mailings WHERE Id <= 1

SELECT * FROM Mailings WHERE Id > 1

SELECT * FROM Mailings WHERE Id < 2

SELECT * FROM Mailings WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE UserId = 1

Columns

Name Type Description
Id [KEY] Integer Id of mailing.
BodyHtml String The mailing custom email body represented in HTML.
BodyText String The plain-text representation of the bodyHTML field.
BouncedAt Datetime The date and time the email was bounced.
ClickCount Integer The total number of times links within the email were clicked.
ClickedAt Datetime The most recent date and time a link was clicked.
CreatedAt Datetime The date and time the mailing was created.
DeliveredAt Datetime The date and time the email was delivered.
ErrorBacktrace String Technical details explaining the mailing error.
ErrorReason String A summary explaining the mailing error.
FollowUpTaskScheduledAt Datetime The date and time of when a follow-up task should be due for this mailing.
FollowUpTaskType String The type of follow-up task to create.
MailboxAddress String The email address the mailing was sent from.
MailingType String A description of the type of the emailing.
MarkedAsSpamAt Datetime The date and time the email was marked as spam.
MessageId String The MIME content MessageId of the delivered message.
NotifyThreadCondition String The condition of when to bump this mailing to the top of the user inbox.
NotifyThreadScheduledAt Datetime The date and time of when this mailing should be bumped to the top of the user inbox.
NotifyThreadStatus String The status of the bump.

The allowed values are pending, sent, skipped.

OpenCount Integer The total number of times the email was opened.
OpenedAt Datetime The most recent date and time the email was opened.
OverrideSafetySettings Boolean A boolean value indicating whether or not users can override submission if template variables have not all been replaced.
References String A list of references for the mailing taken from the email header.
RepliedAt Datetime The date and time the email was replied to.
RetryAt Datetime The date and time the email will retry to send.
RetryCount Integer The number of times the email has been retried to send.
RetryInterval Integer The amount of time in seconds between retry attempts.
ScheduledAt Datetime The date and time the email is scheduled to send.
State String The current state of the mailing.

The allowed values are bounced, delivered, delivering, drafted, failed, opened, placeholder, queued, replied, scheduled.

StateChangedAt Datetime The date and time the state last changed.
Subject String The subject line of the email.
TrackLinks Boolean A boolean value indicating whether or not the mailing is tracking link clicks.
TrackOpens Boolean A boolean value indicating whether or not the mailing is tracking email opens.
UnsubscribedAt Datetime The date and time the recepient unsubscribed from the mailing sequence.
UpdatedAt Datetime The date and time the mailing was last updated.
LinksSelf String Links self.
MailboxId Integer Id of mailbox.
MailboxType String Mailbox type.
OpportunityId Integer Opportunity's Id.
ProspectId Integer Prospect's Id.
ProspectType String Prospect's type.
SequenceId Integer Sequence Id.
SequenceStateId Integer SequenceState Id.
SequenceStepId Integer SequenceStep Id.
TaskId Integer Task's Id.
Type String Type.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462