GrowthZone REST API API Reference
undefined
API Endpoint
https://app.memberzone.orgRequest Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0
Paths
GET /api/communication
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/communication
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"TenantKey": "string",
"CommunicationId": "string",
"OrganizationId": "string",
"GroupId": "string",
"EventId": "string",
"ProjectId": "string",
"ContactId": "string",
"ContactName": "string",
"ToContactName": "string",
"ToContactId": "string",
"CommunicationDateBetween": "string",
"CommunicationTypeId": "string",
"CommunicationStatusTypeId": "string",
"ExcludeCommunicationStatusTypeId": "string",
"CommunicationCategoryId": "string",
"IsNotLinkedToAProject": "boolean",
"HasUnmatchedEmailAddress": "boolean",
"HideJunkMail": "boolean",
"Criteria": "string",
"CommunicationListId": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/communication/{communicationid}/{contactid}
communicationid:
string
in path
(no description)
contactid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"Created": "string",
"CreatedContact": "string",
"Modified": "string",
"ModifiedContact": "string",
"CommunicationTypeIdReadOnly": "string",
"BodyReadOnly": "string"
}
GET /api/communication/address/book
200 OK
OK
Response Example (200 OK)
{
"ShowGroups": "boolean",
"ShowCategories": "boolean",
"ShowTags": "boolean",
"ShowMembershipTypes": "boolean",
"ShowMembershipStatus": "boolean",
"ShowEventRegistrants": "boolean",
"AddressBookItems": "string"
}
POST /api/communication/applymergedatacommunicationforwardemailmodel
undefined
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HasMergeFields": "boolean",
"CommunicationRecipientId": "string",
"Information": "string",
"MergeFieldSource": "string",
"RecipientName": "string",
"ApplyMergeData": "string",
"MoreInformation": "string",
"BaseCommunicationId": "integer"
}
OK
Response Example (200 OK)
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HasMergeFields": "boolean",
"CommunicationRecipientId": "string",
"Information": "string",
"MergeFieldSource": "string",
"RecipientName": "string",
"ApplyMergeData": "string",
"MoreInformation": "string",
"BaseCommunicationId": "integer"
}
GET /api/communication/autoemailtemplatechoices/{globalflags}
globalflags:
string
in path
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"TemplateName": "string",
"Subject": "string",
"EmailBody": "string",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactId": "string",
"EmailAttachments": "string",
"CommunicationTemplateTypeId": "string",
"IsNewsletter": "boolean",
"EmailTemplate": "string",
"GlobalFlags": "string"
}
]
GET /api/communication/automatedemails
options:
string
in query
(no description)
Response Example (200 OK)
[
{
"CommunicationTriggerId": "string",
"TriggerId": "string",
"CategoryType": "string",
"AuditId": "integer",
"DisplayName": "string",
"DelayMinutes": "integer",
"TemplateId": "string",
"DoNotSend": "boolean"
}
]
POST /api/communication/automatedemails
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"Criteria": "string",
"CategoryType": "string"
}
Response Example (200 OK)
[
{
"CommunicationTriggerId": "string",
"TriggerId": "string",
"CategoryType": "string",
"AuditId": "integer",
"DisplayName": "string",
"DelayMinutes": "integer",
"TemplateId": "string",
"DoNotSend": "boolean"
}
]
POST /api/communication/automatedemails/save
items:
string
in query
(no description)
200 OK
OK
GET /api/communication/batchstats/{batchid}
batchid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"Subject": "string",
"NoStatMessage": "string",
"ModalTitle": "string",
"RecipientsSelected": "integer",
"TotalNotSent": "integer",
"TotalNotSentAsLink": "string",
"TotalRecipients": "integer",
"TotalDeliverySoftFailures": "integer",
"TotalDeliverySoftFailuresAsLink": "string",
"TotalDeliveryHardFailures": "integer",
"TotalDeliveryHardFailuresAsLink": "string",
"SuccessfullyDelivered": "integer",
"DeliverabilityRate": "number",
"BounceRate": "number",
"RecipientCountThatOpened": "integer",
"TotalOpens": "integer",
"TotalOpensAsLink1": "string",
"TotalOpensAsLink2": "string",
"OpenRate": "number",
"RecipientsThatHaveClickedAtLeastOnce": "integer",
"TotalClickCount": "integer",
"TotalClickCountAsLink": "string",
"NumberOfDistinctClicks": "integer",
"ClickThroughRate": "number",
"ShowClickStats": "boolean",
"OpenData": "string",
"ClickData": "string"
}
GET /api/communication/batchstats/click/{batchid}/{descriptionhash}
batchid:
integer
in path
(no description)
descriptionhash:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"DescriptionHash": "string",
"CommunicationId": "integer",
"ClickEvents": "string"
}
GET /api/communication/billing/emailtemplatechoices/{globalflags}
globalflags:
string
in path
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"TemplateName": "string",
"Subject": "string",
"EmailBody": "string",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactId": "string",
"EmailAttachments": "string",
"CommunicationTemplateTypeId": "string",
"IsNewsletter": "boolean",
"EmailTemplate": "string",
"GlobalFlags": "string"
}
]
GET /api/communication/billingnote/{communicationid}/{contactid}
communicationid:
string
in path
(no description)
contactid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"Created": "string",
"CreatedContact": "string",
"Modified": "string",
"ModifiedContact": "string",
"CommunicationTypeIdReadOnly": "string",
"BodyReadOnly": "string"
}
GET /api/communication/blockedcommunicationbatchdetails/{batchid}
batchid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"FailedStats": "string"
}
GET /api/communication/blockedcommunicationdetails/{communicationid}
communicationid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"FailedStats": "string"
}
GET /api/communication/categories/{communicationcategoryid}
communicationcategoryid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationCategoryId": "integer",
"AuditId": "integer",
"Name": "string",
"CssColor": "string"
}
DELETE /api/communication/categories/{communicationcategoryid}/{auditid}
communicationcategoryid:
integer
in path
(no description)
auditid:
integer
in path
(no description)
200 OK
OK
GET /api/communication/categories/items
options:
string
in query
(no description)
Response Example (200 OK)
[
{
"CommunicationCategoryId": "integer",
"AuditId": "integer",
"Name": "string",
"CssColor": "string",
"Actions": "string"
}
]
GET /api/communication/categories/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
POST /api/communication/categories/save
undefined
Request Example
{
"CommunicationCategoryId": "integer",
"AuditId": "integer",
"Name": "string",
"CssColor": "string"
}
OK
Response Example (200 OK)
{
"CommunicationCategoryId": "integer",
"AuditId": "integer",
"Name": "string",
"CssColor": "string",
"Actions": "string"
}
GET /api/communication/clickeventscommunicationbatchdetails/{batchid}
batchid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"ClickData": "string"
}
GET /api/communication/clickeventscommunicationdetails/{communicationid}
communicationid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"ClickData": "string"
}
GET /api/communication/communication/download/{communicationid}
communicationid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/communication/communicationbase
200 OK
OK
Response Example (200 OK)
{
"ShowEmailDesigner": "boolean"
}
POST /api/communication/communicationfollowupreminder/add
undefined
Request Example
{
"ContactId": "integer",
"FollowUpDate": "string",
"FollowUpTaskPriorityId": "string",
"TaskTypeId": "string",
"FollowUpStaffContactId": "string",
"ContactName": "string",
"ProjectLookup": "string",
"ProjectId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string"
}
200 OK
OK
Response Example (200 OK)
{
"TaskItemId": "integer",
"ProjectId": "string",
"ProjectName": "string",
"Name": "string",
"TaskPriority": "string",
"TaskType": "string",
"Contact": "string",
"AssignedToContact": "string",
"DueDate": "string",
"CompletedDate": "string",
"PercentComplete": "string"
}
GET /api/communication/communicationfollowupreminder/add/{contactid}
contactid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"ContactId": "integer",
"FollowUpDate": "string",
"FollowUpTaskPriorityId": "string",
"TaskTypeId": "string",
"FollowUpStaffContactId": "string",
"ContactName": "string",
"ProjectLookup": "string",
"ProjectId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string"
}
DELETE /api/communication/communicationfollowupreminder/delete/{taskitemid}/{auditid}
taskitemid:
integer
in path
(no description)
auditid:
integer
in path
(no description)
200 OK
OK
GET /api/communication/communicationfollowupreminder/load/{taskitemid}
taskitemid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"TaskItemId": "integer",
"AuditId": "integer",
"DisplayName": "string",
"FollowUpDate": "string",
"IsCompleted": "boolean",
"FollowUpStaffContactId": "string",
"FollowUpNote": "string",
"FollowUpDescription": "string",
"Communication": "string",
"CommunicationCount": "integer",
"CreateFollowUpTask": "boolean",
"NewFollowUpDate": "string",
"NewFollowUpStaffContactId": "string",
"NewFollowUpName": "string",
"NewFollowUpDescription": "string"
}
POST /api/communication/communicationfollowupreminder/save
undefined
Request Example
{
"TaskItemId": "integer",
"AuditId": "integer",
"DisplayName": "string",
"FollowUpDate": "string",
"IsCompleted": "boolean",
"FollowUpStaffContactId": "string",
"FollowUpNote": "string",
"FollowUpDescription": "string",
"Communication": "string",
"CommunicationCount": "integer",
"CreateFollowUpTask": "boolean",
"NewFollowUpDate": "string",
"NewFollowUpStaffContactId": "string",
"NewFollowUpName": "string",
"NewFollowUpDescription": "string"
}
200 OK
OK
Response Example (200 OK)
{
"TaskItemId": "integer",
"ProjectId": "string",
"ProjectName": "string",
"Name": "string",
"TaskPriority": "string",
"TaskType": "string",
"Contact": "string",
"AssignedToContact": "string",
"DueDate": "string",
"CompletedDate": "string",
"PercentComplete": "string"
}
GET /api/communication/communicationscheduledemaildesignersummary/edit/{systemjobid}
systemjobid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HidePreview": "string",
"SystemJobId": "integer"
}
POST /api/communication/communicationscheduledemaildesignersummary/save/{systemjobid}
systemjobid:
integer
in path
(no description)
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HidePreview": "string",
"SystemJobId": "integer"
}
200 OK
OK
Response Example (200 OK)
{
"TotalRecordAvailable": "integer",
"CommunicationTypeId": "string",
"CommunicationId": "integer",
"SystemJobId": "integer",
"ScheduledDate": "string",
"SentDate": "string",
"Status": "string",
"Subject": "string",
"RecipientDisplayName": "string",
"From": "string",
"SenderName": "string",
"Actions": "string"
}
DELETE /api/communication/communicationscheduledemailsummary/delete/{systemjobid}
systemjobid:
integer
in path
(no description)
200 OK
OK
GET /api/communication/communicationscheduledemailsummary/edit/{systemjobid}
systemjobid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HidePreview": "string",
"SystemJobId": "integer"
}
POST /api/communication/communicationscheduledemailsummary/save/{systemjobid}
undefined
systemjobid:
integer
in path
(no description)
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HidePreview": "string",
"SystemJobId": "integer"
}
200 OK
OK
Response Example (200 OK)
{
"TotalRecordAvailable": "integer",
"CommunicationTypeId": "string",
"CommunicationId": "integer",
"SystemJobId": "integer",
"ScheduledDate": "string",
"SentDate": "string",
"Status": "string",
"Subject": "string",
"RecipientDisplayName": "string",
"From": "string",
"SenderName": "string",
"Actions": "string"
}
POST /api/communication/contacts/lognote/model
undefined
Request Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"SelectedIds": "string"
}
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"SelectedIds": "string"
}
Generates excel document containing for deliver stats for the communication item
Generates excel document containing for deliver stats for the communication item
batchid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
Generates excel document containing for deliver stats for the communication item
Generates excel document containing for deliver stats for the communication item
communicationid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
DELETE /api/communication/draft/{communicationid}/{auditid}
communicationid:
integer
in path
(no description)
auditid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"ShouldNotifyDebuggerOfWaitCompletion": "boolean",
"Id": "integer",
"CurrentId": "string",
"Exception": "string",
"Status": "string",
"IsCanceled": "boolean",
"IsCompleted": "boolean",
"CreationOptions": "string",
"System.IAsyncResult.AsyncWaitHandle": "string",
"AsyncState": "string",
"System.IAsyncResult.CompletedSynchronously": "boolean",
"Factory": "string",
"CompletedTask": "string",
"IsFaulted": "boolean",
"SavedStateForNextReplica": "string",
"SavedStateFromPreviousReplica": "string",
"HandedOverChildReplica": "string",
"Result": "string"
}
DELETE /api/communication/draft/delete/all
200 OK
OK
GET /api/communication/drafts
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"Criteria": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/communication/email/{communicationid}
communicationid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"AuditId": "integer",
"IsDeletable": "boolean",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Subject": "string",
"FromContact": "string",
"Contacts": "string",
"Projects": "string",
"CommunicationTypeId": "string",
"WebUrl": "string",
"Body": "string",
"AuditInfo": "string"
}
POST /api/communication/email/{communicationid}
undefined
communicationid:
integer
in path
(no description)
Request Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"IsDeletable": "boolean",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Subject": "string",
"FromContact": "string",
"Contacts": "string",
"Projects": "string",
"CommunicationTypeId": "string",
"WebUrl": "string",
"Body": "string",
"AuditInfo": "string"
}
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"AuditId": "integer",
"CommunicationStatusTypeId": "string",
"Date": "string",
"Subject": "string",
"Body": "string",
"TotalRowCount": "integer",
"RecipientCount": "integer",
"FirstRecipientName": "string",
"From": "string",
"To": "string",
"CommunicationTypeId": "string",
"IsEmail": "boolean",
"IsNote": "boolean",
"HideNoteDeleteAction": "boolean",
"Category": "string",
"SpamScore": "string",
"SpamScoreOriginTypeId": "string",
"FilesCount": "integer",
"Attachments": "string",
"Actions": "string"
}
GET /api/communication/emaildesigner/{communicationid}/{templateid}
communicationid:
string
in path
(no description)
templateid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"TemplateId": "string",
"TemplateName": "string",
"IsGlobalTemplate": "boolean",
"EmailTemplate": "string",
"ActionName": "string",
"GlobalFlags": "string"
}
POST /api/communication/emaildesigner/save
undefined
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"TemplateId": "string",
"TemplateName": "string",
"IsGlobalTemplate": "boolean",
"EmailTemplate": "string",
"ActionName": "string",
"GlobalFlags": "string"
}
200 OK
OK
Response Example (200 OK)
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"TemplateId": "string",
"TemplateName": "string",
"IsGlobalTemplate": "boolean",
"EmailTemplate": "string",
"ActionName": "string",
"GlobalFlags": "string"
}
GET /api/communication/emaildesignerdraftchoices
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
POST /api/communication/emaildesignersaveasnewtemplate
undefined
Request Example
{
"Subject": "string",
"EmailTemplate": "string",
"Name": "string"
}
200 OK
OK
Response Example (200 OK)
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"TemplateId": "string",
"TemplateName": "string",
"IsGlobalTemplate": "boolean",
"EmailTemplate": "string",
"ActionName": "string",
"GlobalFlags": "string"
}
POST /api/communication/emaildesignersavetemplate
undefined
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"TemplateId": "string",
"TemplateName": "string",
"IsGlobalTemplate": "boolean",
"EmailTemplate": "string",
"ActionName": "string",
"GlobalFlags": "string"
}
200 OK
OK
Response Example (200 OK)
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"TemplateId": "string",
"TemplateName": "string",
"IsGlobalTemplate": "boolean",
"EmailTemplate": "string",
"ActionName": "string",
"GlobalFlags": "string"
}
GET /api/communication/emaildesignertemplate/{templateid}
templateid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"TemplateId": "integer",
"AuditId": "integer",
"OverrideForTemplateId": "string",
"Name": "string",
"Description": "string",
"CommunicationTemplateTypeId": "string",
"Subject": "string",
"GlobalFlags": "string",
"NewsletterData": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddressId": "string",
"FromContactId": "string",
"IsPublic": "boolean",
"EmailAttachments": "string",
"IsSystemTemplate": "boolean",
"IsDeletable": "boolean",
"NotificationTypeId": "string"
}
POST /api/communication/emaildesignertemplate/{templateid}
undefined
templateid:
integer
in path
(no description)
Request Example
{
"TemplateId": "integer",
"AuditId": "integer",
"OverrideForTemplateId": "string",
"Name": "string",
"Description": "string",
"CommunicationTemplateTypeId": "string",
"Subject": "string",
"GlobalFlags": "string",
"NewsletterData": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddressId": "string",
"FromContactId": "string",
"IsPublic": "boolean",
"EmailAttachments": "string",
"IsSystemTemplate": "boolean",
"IsDeletable": "boolean",
"NotificationTypeId": "string"
}
200 OK
OK
Response Example (200 OK)
{
"ShowEmailDesigner": "boolean",
"TemplateId": "integer",
"EmailTemplateId": "integer",
"TenantId": "integer",
"TotalRecordAvailable": "integer",
"Name": "string",
"CommunicationTemplateTypeId": "string",
"Description": "string",
"IsDeletable": "boolean",
"IsActive": "boolean",
"Actions": "string"
}
DELETE /api/communication/emaildesignertemplate/{templateid}/{auditid}
templateid:
integer
in path
(no description)
auditid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"TemplateId": "integer",
"AuditId": "integer",
"OverrideForTemplateId": "string",
"Name": "string",
"Description": "string",
"CommunicationTemplateTypeId": "string",
"Subject": "string",
"GlobalFlags": "string",
"NewsletterData": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddressId": "string",
"FromContactId": "string",
"IsPublic": "boolean",
"EmailAttachments": "string",
"IsSystemTemplate": "boolean",
"IsDeletable": "boolean",
"NotificationTypeId": "string"
}
GET /api/communication/emaildesignertemplatechoices
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"TemplateName": "string",
"Subject": "string",
"EmailBody": "string",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactId": "string",
"EmailAttachments": "string",
"CommunicationTemplateTypeId": "string",
"IsNewsletter": "boolean",
"EmailTemplate": "string",
"GlobalFlags": "string",
"IsGlobalTemplate": "boolean"
}
]
POST /api/communication/emaildesignertemplates/{templateid}
undefined
templateid:
string
in path
(no description)
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"TemplateId": "string",
"TemplateName": "string",
"IsGlobalTemplate": "boolean",
"EmailTemplate": "string",
"ActionName": "string",
"GlobalFlags": "string"
}
Response Example (200 OK)
{
"Id": "integer",
"Name": "string",
"TemplateName": "string",
"Subject": "string",
"EmailBody": "string",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactId": "string",
"EmailAttachments": "string",
"CommunicationTemplateTypeId": "string",
"IsNewsletter": "boolean",
"EmailTemplate": "string",
"GlobalFlags": "string",
"IsGlobalTemplate": "boolean"
}
GET /api/communication/emaildraftchoices
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
POST /api/communication/emailprofileupdate
undefined
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"MembershipType": "string",
"MembershipContactName": "string",
"RenewalMonth": "string",
"CommunicationTemplateType": "string"
}
OK
Response Example (200 OK)
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"MembershipType": "string",
"MembershipContactName": "string",
"RenewalMonth": "string",
"CommunicationTemplateType": "string"
}
GET /api/communication/emailprofileupdate/{contactid}
contactid:
string
in path
(no description)
OK
Response Example (200 OK)
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"MembershipType": "string",
"MembershipContactName": "string",
"RenewalMonth": "string",
"CommunicationTemplateType": "string"
}
POST /api/communication/emailprofileupdatepreview
undefined
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"EmailPreviewRecipients": "string",
"DataSource": "string"
}
OK
Response Example (200 OK)
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"EmailPreviewRecipients": "string",
"DataSource": "string"
}
POST /api/communication/emailtemplate/{templateid}
undefined
templateid:
integer
in path
(no description)
Request Example
{
"TemplateId": "integer",
"TenantId": "integer",
"AuditId": "integer",
"OverrideForTemplateId": "string",
"Name": "string",
"Description": "string",
"CommunicationTemplateTypeId": "string",
"Subject": "string",
"GlobalFlags": "string",
"Body": "string",
"BodyRaw": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactId": "string",
"IsPublic": "boolean",
"IsActive": "boolean",
"IsActiveReadonly": "boolean",
"EmailAttachments": "string",
"LimitedEditMode": "boolean",
"IsSystemTemplate": "boolean",
"IsDeletable": "boolean",
"NotificationTypeId": "string",
"HasMergeFields": "boolean"
}
200 OK
OK
Response Example (200 OK)
{
"ShowEmailDesigner": "boolean",
"TemplateId": "integer",
"EmailTemplateId": "integer",
"TenantId": "integer",
"TotalRecordAvailable": "integer",
"Name": "string",
"CommunicationTemplateTypeId": "string",
"Description": "string",
"IsDeletable": "boolean",
"IsActive": "boolean",
"Actions": "string"
}
GET /api/communication/emailtemplate/{templateid}
templateid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"TemplateId": "integer",
"TenantId": "integer",
"AuditId": "integer",
"OverrideForTemplateId": "string",
"Name": "string",
"Description": "string",
"CommunicationTemplateTypeId": "string",
"Subject": "string",
"GlobalFlags": "string",
"Body": "string",
"BodyRaw": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactId": "string",
"IsPublic": "boolean",
"IsActive": "boolean",
"IsActiveReadonly": "boolean",
"EmailAttachments": "string",
"LimitedEditMode": "boolean",
"IsSystemTemplate": "boolean",
"IsDeletable": "boolean",
"NotificationTypeId": "string",
"HasMergeFields": "boolean"
}
DELETE /api/communication/emailtemplate/{templateid}/{auditid}
templateid:
integer
in path
(no description)
auditid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"TemplateId": "integer",
"TenantId": "integer",
"AuditId": "integer",
"OverrideForTemplateId": "string",
"Name": "string",
"Description": "string",
"CommunicationTemplateTypeId": "string",
"Subject": "string",
"GlobalFlags": "string",
"Body": "string",
"BodyRaw": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactId": "string",
"IsPublic": "boolean",
"IsActive": "boolean",
"IsActiveReadonly": "boolean",
"EmailAttachments": "string",
"LimitedEditMode": "boolean",
"IsSystemTemplate": "boolean",
"IsDeletable": "boolean",
"NotificationTypeId": "string",
"HasMergeFields": "boolean"
}
GET /api/communication/emailtemplatechoices/{globalflags}
globalflags:
string
in path
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"TemplateName": "string",
"Subject": "string",
"EmailBody": "string",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactId": "string",
"EmailAttachments": "string",
"CommunicationTemplateTypeId": "string",
"IsNewsletter": "boolean",
"EmailTemplate": "string",
"GlobalFlags": "string"
}
]
GET /api/communication/emailtemplatechoicesmemberprofileupdate/{communicationtemplatetype}
communicationtemplatetype:
string
in path
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"TemplateName": "string",
"Subject": "string",
"EmailBody": "string",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactId": "string",
"EmailAttachments": "string",
"CommunicationTemplateTypeId": "string",
"IsNewsletter": "boolean",
"EmailTemplate": "string",
"GlobalFlags": "string"
}
]
GET /api/communication/emailtemplates
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"Criteria": "string",
"Category": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
DELETE /api/communication/emailtemplates/{templateid}
templateid:
integer
in path
(no description)
200 OK
OK
GET /api/communication/emailtemplates/{templateid}/copy
templateid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"ShowEmailDesigner": "boolean",
"TemplateId": "integer",
"EmailTemplateId": "integer",
"TenantId": "integer",
"TotalRecordAvailable": "integer",
"Name": "string",
"CommunicationTemplateTypeId": "string",
"Description": "string",
"IsDeletable": "boolean",
"IsActive": "boolean",
"Actions": "string"
}
GET /api/communication/emailtemplatetype
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string"
}
]
GET /api/communication/event/{eventid}
eventid:
integer
in path
(no description)
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/communication/event/{eventid}
undefined
eventid:
integer
in path
(no description)
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"TenantKey": "string",
"CommunicationId": "string",
"OrganizationId": "string",
"GroupId": "string",
"EventId": "string",
"ProjectId": "string",
"ContactId": "string",
"ContactName": "string",
"ToContactName": "string",
"ToContactId": "string",
"CommunicationDateBetween": "string",
"CommunicationTypeId": "string",
"CommunicationStatusTypeId": "string",
"ExcludeCommunicationStatusTypeId": "string",
"CommunicationCategoryId": "string",
"IsNotLinkedToAProject": "boolean",
"HasUnmatchedEmailAddress": "boolean",
"HideJunkMail": "boolean",
"Criteria": "string",
"CommunicationListId": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/communication/event/lognote/{communicationid}
undefined
communicationid:
integer
in path
(no description)
Request Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"Name": "string"
}
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"AuditId": "integer",
"CommunicationStatusTypeId": "string",
"Date": "string",
"Subject": "string",
"Body": "string",
"TotalRowCount": "integer",
"RecipientCount": "integer",
"FirstRecipientName": "string",
"From": "string",
"To": "string",
"CommunicationTypeId": "string",
"IsEmail": "boolean",
"IsNote": "boolean",
"HideNoteDeleteAction": "boolean",
"Category": "string",
"SpamScore": "string",
"SpamScoreOriginTypeId": "string",
"FilesCount": "integer",
"Attachments": "string",
"Actions": "string"
}
GET /api/communication/event/lognote/{eventid}
eventid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"Name": "string"
}
POST /api/communication/exporthardfailedbatchdetails/{batchid}
batchid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
Generates excel document containing deliver hard failure stats for invalid emails with contact infomation
Generates excel document containing deliver hard failure stats for invalid emails with contact infomation
communicationid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
POST /api/communication/exportsoftfailedbatchdetails/{batchid}
batchid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
POST /api/communication/exportsoftfailedcommunicationdetails/{communicationid}
communicationid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/communication/failedcommunicationbatchdetails/{batchid}
batchid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"FailedStats": "string"
}
GET /api/communication/failedcommunicationdetails/{communicationid}
communicationid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"FailedStats": "string"
}
POST /api/communication/fromaddress
undefined
Request Example
{
"Id": "string",
"EmailAddressId": "integer",
"FromEmailAddressId": "integer",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"FromWillBeRewritten": "boolean",
"EmailAddress": "string",
"DisplayName": "string",
"forceSave": "boolean"
}
200 OK
OK
Response Example (200 OK)
{
"Id": "string",
"EmailAddressId": "integer",
"FromEmailAddressId": "integer",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"FromWillBeRewritten": "boolean",
"EmailAddress": "string",
"DisplayName": "string",
"forceSave": "boolean"
}
GET /api/communication/fromaddresses
onlyactive:
boolean
in query
(no description)
200 OK
OK
Response Example (200 OK)
[
{
"Id": "string",
"EmailAddressId": "integer",
"FromEmailAddressId": "integer",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"FromWillBeRewritten": "boolean",
"EmailAddress": "string",
"DisplayName": "string",
"forceSave": "boolean"
}
]
GET /api/communication/fundraisingemailtemplatechoices/{globalflags}
globalflags:
string
in path
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"TemplateName": "string",
"Subject": "string",
"EmailBody": "string",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactId": "string",
"EmailAttachments": "string",
"CommunicationTemplateTypeId": "string",
"IsNewsletter": "boolean",
"EmailTemplate": "string",
"GlobalFlags": "string"
}
]
GET /api/communication/getemailtemplate/{emailtemplateid}
emailtemplateid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"TemplateId": "integer",
"TenantId": "integer",
"AuditId": "integer",
"OverrideForTemplateId": "string",
"Name": "string",
"Description": "string",
"CommunicationTemplateTypeId": "string",
"Subject": "string",
"GlobalFlags": "string",
"Body": "string",
"BodyRaw": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactId": "string",
"IsPublic": "boolean",
"IsActive": "boolean",
"IsActiveReadonly": "boolean",
"EmailAttachments": "string",
"LimitedEditMode": "boolean",
"IsSystemTemplate": "boolean",
"IsDeletable": "boolean",
"NotificationTypeId": "string",
"HasMergeFields": "boolean"
}
GET /api/communication/group/{groupid}
groupid:
integer
in path
(no description)
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/communication/group/{groupid}
undefined
groupid:
integer
in path
(no description)
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"TenantKey": "string",
"CommunicationId": "string",
"OrganizationId": "string",
"GroupId": "string",
"EventId": "string",
"ProjectId": "string",
"ContactId": "string",
"ContactName": "string",
"ToContactName": "string",
"ToContactId": "string",
"CommunicationDateBetween": "string",
"CommunicationTypeId": "string",
"CommunicationStatusTypeId": "string",
"ExcludeCommunicationStatusTypeId": "string",
"CommunicationCategoryId": "string",
"IsNotLinkedToAProject": "boolean",
"HasUnmatchedEmailAddress": "boolean",
"HideJunkMail": "boolean",
"Criteria": "string",
"CommunicationListId": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/communication/hardfailedcommunicationbatchdetails/{batchid}
batchid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"FailedStats": "string"
}
GET /api/communication/hardfailedcommunicationdetails/{communicationid}
communicationid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"FailedStats": "string"
}
GET /api/communication/loadcommunicationforwardemailmodel/{communicationid}
communicationid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HasMergeFields": "boolean",
"CommunicationRecipientId": "string",
"Information": "string",
"MergeFieldSource": "string",
"RecipientName": "string",
"ApplyMergeData": "string",
"MoreInformation": "string",
"BaseCommunicationId": "integer"
}
POST /api/communication/loaddraftemaildesigner/{draftcommunicationid}
draftcommunicationid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"TemplateId": "string",
"TemplateName": "string",
"IsGlobalTemplate": "boolean",
"EmailTemplate": "string",
"ActionName": "string",
"GlobalFlags": "string"
}
POST /api/communication/loaddraftquickemail/{draftcommunicationid}
draftcommunicationid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string"
}
POST /api/communication/loademaildesignerpreview
undefined
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"TemplateId": "string",
"TemplateName": "string",
"IsGlobalTemplate": "boolean",
"EmailTemplate": "string",
"ActionName": "string",
"GlobalFlags": "string"
}
200 OK
OK
Response Example (200 OK)
{
"AuditId": "integer",
"FromEmailAddressId": "integer",
"FromContactId": "string",
"Subject": "string",
"EmailTemplate": "string",
"EmailRecipients": "string"
}
GET /api/communication/loadfinanceemailstatement/{contactid}
contactid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"ContactId": "integer",
"Balance": "number",
"HasNoPurchases": "boolean",
"SpecialNote": "string",
"FileFormat": "string",
"DocumentGenerationTemplateId": "integer",
"DisplayAllActivityEvenIfPaid": "boolean",
"StatementStartDate": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "integer",
"FromContactId": "string",
"TemplateId": "string",
"Subject": "string",
"EmailRecipients": "string",
"GlobalFlags": "string",
"Signatures": "string",
"EmailBody": "string"
}
POST /api/communication/loadmembershiprenewalemail
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"EndDateBetween": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"RenewalMonth": "string",
"Criteria": "string",
"MembershipStatus": "string",
"IsDuplicateEmail": "boolean",
"StartDateBetween": "string",
"Tags": "string",
"Frequency": "string",
"PaymentPlanIsFinished": "boolean"
}
200 OK
OK
Response Example (200 OK)
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HidePreview": "string"
}
GET /api/communication/loadquickemail/contactemailaddress/{contactid}/{contactemailaddressid}
contactid:
integer
in path
(no description)
contactemailaddressid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HidePreview": "string",
"ContactEmailAddressId": "integer"
}
POST /api/communication/loadquickemail/contactrepresentatives
undefined
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HidePreview": "string",
"SelectedIds": "string",
"TemplateGuid": "string"
}
200 OK
OK
Response Example (200 OK)
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HidePreview": "string"
}
DELETE /api/communication/lognote/delete/{communicationid}/{auditid}
communicationid:
integer
in path
(no description)
auditid:
integer
in path
(no description)
200 OK
OK
GET /api/communication/membership/emailtemplatechoices
200 OK
OK
type
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
Returns general merge fields and the ones, which are related to communication template area
Returns general merge fields and the ones, which are related to communication template area
globalflags:
string
in path
(no description)
communicationtemplatetypeid:
string
in path
(no description)
entityid:
string
in path
(no description)
200 OK
OK
type
Response Example (200 OK)
[
{
"Name": "string",
"Description": "string",
"GroupName": "string",
"Parameters": "string",
"IsUber": "boolean",
"HideFromSelection": "boolean"
}
]
GET /api/communication/newlettertemplatechoices
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"TemplateName": "string",
"Subject": "string",
"EmailBody": "string",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactId": "string",
"EmailAttachments": "string",
"CommunicationTemplateTypeId": "string",
"IsNewsletter": "boolean",
"EmailTemplate": "string",
"GlobalFlags": "string"
}
]
DELETE /api/communication/note/{communicationid}/{auditid}
communicationid:
integer
in path
(no description)
auditid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"ShouldNotifyDebuggerOfWaitCompletion": "boolean",
"Id": "integer",
"CurrentId": "string",
"Exception": "string",
"Status": "string",
"IsCanceled": "boolean",
"IsCompleted": "boolean",
"CreationOptions": "string",
"System.IAsyncResult.AsyncWaitHandle": "string",
"AsyncState": "string",
"System.IAsyncResult.CompletedSynchronously": "boolean",
"Factory": "string",
"CompletedTask": "string",
"IsFaulted": "boolean",
"SavedStateForNextReplica": "string",
"SavedStateFromPreviousReplica": "string",
"HandedOverChildReplica": "string",
"Result": "string"
}
GET /api/communication/openeventscommunicationbatchdetails/{batchid}
batchid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"OpenData": "string"
}
GET /api/communication/openeventscommunicationdetails/{communicationid}
communicationid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"OpenData": "string"
}
GET /api/communication/organization/{contactid}
contactid:
integer
in path
(no description)
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/communication/organization/{contactid}
undefined
contactid:
integer
in path
(no description)
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"TenantKey": "string",
"CommunicationId": "string",
"OrganizationId": "string",
"GroupId": "string",
"EventId": "string",
"ProjectId": "string",
"ContactId": "string",
"ContactName": "string",
"ToContactName": "string",
"ToContactId": "string",
"CommunicationDateBetween": "string",
"CommunicationTypeId": "string",
"CommunicationStatusTypeId": "string",
"ExcludeCommunicationStatusTypeId": "string",
"CommunicationCategoryId": "string",
"IsNotLinkedToAProject": "boolean",
"HasUnmatchedEmailAddress": "boolean",
"HideJunkMail": "boolean",
"Criteria": "string",
"CommunicationListId": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/communication/organization/edit/{contactid}/{communicationtypeid}/{setrecipient}
contactid:
string
in path
(no description)
communicationtypeid:
string
in path
(no description)
setrecipient:
boolean
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"ContactDisplayName": "string",
"RecipientCount": "integer",
"CommunicationTypeIdReadOnly": "string",
"BodyReadOnly": "string"
}
GET /api/communication/organization/load/{communicationid}/{contactid}
communicationid:
integer
in path
(no description)
contactid:
string
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"ContactDisplayName": "string",
"RecipientCount": "integer",
"CommunicationTypeIdReadOnly": "string",
"BodyReadOnly": "string"
}
POST /api/communication/organization/lognote/{communicationid}
undefined
communicationid:
integer
in path
(no description)
Request Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"ContactDisplayName": "string"
}
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"AuditId": "integer",
"CommunicationStatusTypeId": "string",
"Date": "string",
"Subject": "string",
"Body": "string",
"TotalRowCount": "integer",
"RecipientCount": "integer",
"FirstRecipientName": "string",
"From": "string",
"To": "string",
"CommunicationTypeId": "string",
"IsEmail": "boolean",
"IsNote": "boolean",
"HideNoteDeleteAction": "boolean",
"Category": "string",
"SpamScore": "string",
"SpamScoreOriginTypeId": "string",
"FilesCount": "integer",
"Attachments": "string",
"Actions": "string"
}
POST /api/communication/organization/save/{communicationid}
undefined
communicationid:
integer
in path
(no description)
Request Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"ContactDisplayName": "string",
"RecipientCount": "integer",
"CommunicationTypeIdReadOnly": "string",
"BodyReadOnly": "string"
}
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"AuditId": "integer",
"CommunicationStatusTypeId": "string",
"Date": "string",
"Subject": "string",
"Body": "string",
"TotalRowCount": "integer",
"RecipientCount": "integer",
"FirstRecipientName": "string",
"From": "string",
"To": "string",
"CommunicationTypeId": "string",
"IsEmail": "boolean",
"IsNote": "boolean",
"HideNoteDeleteAction": "boolean",
"Category": "string",
"SpamScore": "string",
"SpamScoreOriginTypeId": "string",
"FilesCount": "integer",
"Attachments": "string",
"Actions": "string"
}
GET /api/communication/person/{contactid}/load/{communicationid}
contactid:
integer
in path
(no description)
communicationid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"ContactDisplayName": "string",
"CommunicationTypeIdReadOnly": "string",
"BodyReadOnly": "string"
}
POST /api/communication/person/lognote/{communicationid}
undefined
communicationid:
integer
in path
(no description)
Request Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"DisplayName": "string"
}
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"AuditId": "integer",
"CommunicationStatusTypeId": "string",
"Date": "string",
"Subject": "string",
"Body": "string",
"TotalRowCount": "integer",
"RecipientCount": "integer",
"FirstRecipientName": "string",
"From": "string",
"To": "string",
"CommunicationTypeId": "string",
"IsEmail": "boolean",
"IsNote": "boolean",
"HideNoteDeleteAction": "boolean",
"Category": "string",
"SpamScore": "string",
"SpamScoreOriginTypeId": "string",
"FilesCount": "integer",
"Attachments": "string",
"Actions": "string"
}
GET /api/communication/person/lognote/{contactid}
contactid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"DisplayName": "string"
}
GET /api/communication/person/notifications/{contactid}
contactid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"ContactId": "integer",
"Notifications": "string"
}
POST /api/communication/person/notifications/{contactid}
undefined
contactid:
integer
in path
(no description)
Request Example
{
"ContactId": "integer",
"Notifications": "string"
}
OK
Response Example (200 OK)
{
"ContactId": "integer",
"Notifications": "string"
}
POST /api/communication/person/save/{communicationid}
undefined
communicationid:
integer
in path
(no description)
Request Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"ContactDisplayName": "string",
"CommunicationTypeIdReadOnly": "string",
"BodyReadOnly": "string"
}
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"AuditId": "integer",
"CommunicationStatusTypeId": "string",
"Date": "string",
"Subject": "string",
"Body": "string",
"TotalRowCount": "integer",
"RecipientCount": "integer",
"FirstRecipientName": "string",
"From": "string",
"To": "string",
"CommunicationTypeId": "string",
"IsEmail": "boolean",
"IsNote": "boolean",
"HideNoteDeleteAction": "boolean",
"Category": "string",
"SpamScore": "string",
"SpamScoreOriginTypeId": "string",
"FilesCount": "integer",
"Attachments": "string",
"Actions": "string"
}
POST /api/communication/postcalendar
calendars:
string
in query
(no description)
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
POST /api/communication/postcontact
contacts:
string
in query
(no description)
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
POST /api/communication/postmail
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/communication/preview/{communicationid}
communicationid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"IsBodyHtml": "boolean",
"Subject": "string",
"Type": "string",
"CommunicationTypeId": "string",
"From": "string",
"To": "string",
"Cc": "string",
"Ucc": "string",
"Bcc": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalBcc": "integer",
"TotalCc": "integer",
"TotalTo": "integer",
"CommunicationDate": "string",
"EmailAttachments": "string",
"Projects": "string",
"ProjectsNames": "string",
"Body": "string",
"UntrackedCcMessage": "string"
}
GET /api/communication/project/{projectid}
projectid:
integer
in path
(no description)
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/communication/project/{projectid}
undefined
projectid:
integer
in path
(no description)
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"TenantKey": "string",
"CommunicationId": "string",
"OrganizationId": "string",
"GroupId": "string",
"EventId": "string",
"ProjectId": "string",
"ContactId": "string",
"ContactName": "string",
"ToContactName": "string",
"ToContactId": "string",
"CommunicationDateBetween": "string",
"CommunicationTypeId": "string",
"CommunicationStatusTypeId": "string",
"ExcludeCommunicationStatusTypeId": "string",
"CommunicationCategoryId": "string",
"IsNotLinkedToAProject": "boolean",
"HasUnmatchedEmailAddress": "boolean",
"HideJunkMail": "boolean",
"Criteria": "string",
"CommunicationListId": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/communication/project/load/{communicationid}/{projectid}
communicationid:
integer
in path
(no description)
projectid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"ProjectId": "integer",
"Name": "string",
"CommunicationTypeIdReadOnly": "string",
"BodyReadOnly": "string"
}
POST /api/communication/project/lognote/{communicationid}
undefined
communicationid:
integer
in path
(no description)
Request Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"ProjectId": "integer",
"Name": "string"
}
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"AuditId": "integer",
"CommunicationStatusTypeId": "string",
"Date": "string",
"Subject": "string",
"Body": "string",
"TotalRowCount": "integer",
"RecipientCount": "integer",
"FirstRecipientName": "string",
"From": "string",
"To": "string",
"CommunicationTypeId": "string",
"IsEmail": "boolean",
"IsNote": "boolean",
"HideNoteDeleteAction": "boolean",
"Category": "string",
"SpamScore": "string",
"SpamScoreOriginTypeId": "string",
"FilesCount": "integer",
"Attachments": "string",
"Actions": "string"
}
GET /api/communication/project/lognote/{projectid}
projectid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"ProjectId": "integer",
"Name": "string"
}
POST /api/communication/project/save/{communicationid}
undefined
communicationid:
integer
in path
(no description)
Request Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"ProjectId": "integer",
"Name": "string",
"CommunicationTypeIdReadOnly": "string",
"BodyReadOnly": "string"
}
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"AuditId": "integer",
"CommunicationStatusTypeId": "string",
"Date": "string",
"Subject": "string",
"Body": "string",
"TotalRowCount": "integer",
"RecipientCount": "integer",
"FirstRecipientName": "string",
"From": "string",
"To": "string",
"CommunicationTypeId": "string",
"IsEmail": "boolean",
"IsNote": "boolean",
"HideNoteDeleteAction": "boolean",
"Category": "string",
"SpamScore": "string",
"SpamScoreOriginTypeId": "string",
"FilesCount": "integer",
"Attachments": "string",
"Actions": "string"
}
GET /api/communication/pushnotifications
OK
Response Example (200 OK)
{
"Directions": "string",
"SendToAll": "boolean",
"Groups": "string",
"Title": "string",
"Message": "string",
"HubType": "string"
}
POST /api/communication/pushnotifications/save
undefined
Request Example
{
"Directions": "string",
"SendToAll": "boolean",
"Groups": "string",
"Title": "string",
"Message": "string",
"HubType": "string"
}
OK
Response Example (200 OK)
{
"Directions": "string",
"SendToAll": "boolean",
"Groups": "string",
"Title": "string",
"Message": "string",
"HubType": "string"
}
GET /api/communication/recipients/{communicationid}
communicationid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"Recipients": "string"
}
GET /api/communication/recipients/edit/{communicationrecipientid}
communicationrecipientid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationRecipientId": "integer",
"ContactName": "string",
"ContactId": "integer"
}
GET /api/communication/recipients/typeahead/{basecommunicationid}
basecommunicationid:
integer
in path
(no description)
this[]:
string
in query
(no description)
length:
string
in query
(no description)
Response Example (200 OK)
[
{
"RecipientName": "string",
"CommunicationRecipientId": "string",
"Name": "string",
"AdditionalData": "string"
}
]
POST /api/communication/resolvemergefield/{name}
name:
object
in path
(no description)
Request Example
[
{
"System.Collections.Generic.IDictionary<System.String,System.Object>.Keys": "string",
"System.Collections.Generic.IDictionary<System.String,System.Object>.Values": "string",
"System.Collections.Generic.IDictionary<System.String,System.Object>.Item": "string",
"System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String,System.Object>>.Count": "integer",
"System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String,System.Object>>.IsReadOnly": "boolean"
}
]
200 OK
OK
Response Example (200 OK)
{
"ShouldNotifyDebuggerOfWaitCompletion": "boolean",
"Id": "integer",
"CurrentId": "string",
"Exception": "string",
"Status": "string",
"IsCanceled": "boolean",
"IsCompleted": "boolean",
"CreationOptions": "string",
"System.IAsyncResult.AsyncWaitHandle": "string",
"AsyncState": "string",
"System.IAsyncResult.CompletedSynchronously": "boolean",
"Factory": "string",
"CompletedTask": "string",
"IsFaulted": "boolean",
"SavedStateForNextReplica": "string",
"SavedStateFromPreviousReplica": "string",
"HandedOverChildReplica": "string",
"Result": "string"
}
POST /api/communication/save/{communicationid}
undefined
communicationid:
string
in path
(no description)
Request Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"Created": "string",
"CreatedContact": "string",
"Modified": "string",
"ModifiedContact": "string",
"CommunicationTypeIdReadOnly": "string",
"BodyReadOnly": "string"
}
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"AuditId": "integer",
"CommunicationStatusTypeId": "string",
"Date": "string",
"Subject": "string",
"Body": "string",
"TotalRowCount": "integer",
"RecipientCount": "integer",
"FirstRecipientName": "string",
"From": "string",
"To": "string",
"CommunicationTypeId": "string",
"IsEmail": "boolean",
"IsNote": "boolean",
"HideNoteDeleteAction": "boolean",
"Category": "string",
"SpamScore": "string",
"SpamScoreOriginTypeId": "string",
"FilesCount": "integer",
"Attachments": "string",
"Actions": "string"
}
POST /api/communication/savedraft
undefined
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HidePreview": "string"
}
200 OK
OK
POST /api/communication/savedraft2
undefined
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HidePreview": "string"
}
OK
Response Example (200 OK)
{
"Date": "string",
"Subject": "string",
"From": "string",
"CommunicationTypeId": "string",
"Category": "string",
"Attachments": "string",
"Actions": "string",
"CommunicationId": "integer",
"TotalRecordAvailable": "integer",
"DraftCommunicationId": "integer",
"AuditId": "integer",
"FilesCount": "integer"
}
GET /api/communication/scheduled/emailableentitylist/{communicationid}
communicationid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"To": "string"
}
GET /api/communication/scheduledemailableentitylist/{systemjobid}
systemjobid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"SystemJobId": "integer",
"To": "string"
}
GET /api/communication/scheduledemaillistitems
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"ContactId": "string",
"ContactName": "string",
"ScheduledDate": "string",
"Status": "string",
"Criteria": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/communication/sendcommunicationforwardemailmodel
undefined
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HasMergeFields": "boolean",
"CommunicationRecipientId": "string",
"Information": "string",
"MergeFieldSource": "string",
"RecipientName": "string",
"ApplyMergeData": "string",
"MoreInformation": "string",
"BaseCommunicationId": "integer"
}
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"AuditId": "integer",
"CommunicationStatusTypeId": "string",
"Date": "string",
"Subject": "string",
"Body": "string",
"TotalRowCount": "integer",
"RecipientCount": "integer",
"FirstRecipientName": "string",
"From": "string",
"To": "string",
"CommunicationTypeId": "string",
"IsEmail": "boolean",
"IsNote": "boolean",
"HideNoteDeleteAction": "boolean",
"Category": "string",
"SpamScore": "string",
"SpamScoreOriginTypeId": "string",
"FilesCount": "integer",
"Attachments": "string",
"Actions": "string"
}
POST /api/communication/sendemaildesigner
undefined
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"TemplateId": "string",
"TemplateName": "string",
"IsGlobalTemplate": "boolean",
"EmailTemplate": "string",
"ActionName": "string",
"GlobalFlags": "string"
}
200 OK
OK
Response Example (200 OK)
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"TemplateId": "string",
"TemplateName": "string",
"IsGlobalTemplate": "boolean",
"EmailTemplate": "string",
"ActionName": "string",
"GlobalFlags": "string"
}
POST /api/communication/sendemaildesignerpreview
undefined
Request Example
{
"AuditId": "integer",
"FromEmailAddressId": "integer",
"FromContactId": "string",
"Subject": "string",
"EmailTemplate": "string",
"EmailRecipients": "string"
}
200 OK
OK
Response Example (200 OK)
{
"AuditId": "integer",
"FromEmailAddressId": "integer",
"FromContactId": "string",
"Subject": "string",
"EmailTemplate": "string",
"EmailRecipients": "string"
}
POST /api/communication/sendemailpreviewdata
undefined
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string"
}
200 OK
OK
POST /api/communication/sendquickemail
undefined
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HidePreview": "string"
}
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"AuditId": "integer",
"CommunicationStatusTypeId": "string",
"Date": "string",
"Subject": "string",
"Body": "string",
"TotalRowCount": "integer",
"RecipientCount": "integer",
"FirstRecipientName": "string",
"From": "string",
"To": "string",
"CommunicationTypeId": "string",
"IsEmail": "boolean",
"IsNote": "boolean",
"HideNoteDeleteAction": "boolean",
"Category": "string",
"SpamScore": "string",
"SpamScoreOriginTypeId": "string",
"FilesCount": "integer",
"Attachments": "string",
"Actions": "string"
}
POST /api/communication/sendquickemailpreview
undefined
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"EmailPreviewRecipients": "string",
"DataSource": "string"
}
200 OK
OK
POST /api/communication/statistics
undefined
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string"
}
OK
Response Example (200 OK)
{
"Stats": "string"
}
GET /api/communication/stats/{communicationid}
communicationid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"CommunicationId": "integer",
"BatchId": "string",
"Subject": "string",
"NoStatMessage": "string",
"ModalTitle": "string",
"RecipientsSelected": "integer",
"TotalNotSent": "integer",
"TotalNotSentAsLink": "string",
"TotalRecipients": "integer",
"TotalDeliverySoftFailures": "integer",
"TotalDeliverySoftFailuresAsLink": "string",
"TotalDeliveryHardFailures": "integer",
"TotalDeliveryHardFailuresAsLink": "string",
"SuccessfullyDelivered": "integer",
"DeliverabilityRate": "number",
"BounceRate": "number",
"RecipientCountThatOpened": "integer",
"TotalOpens": "integer",
"TotalOpensAsLink1": "string",
"TotalOpensAsLink2": "string",
"OpenRate": "number",
"RecipientsThatHaveClickedAtLeastOnce": "integer",
"TotalClickCount": "integer",
"TotalClickCountAsLink": "string",
"NumberOfDistinctClicks": "integer",
"ClickThroughRate": "number",
"ShowClickStats": "boolean",
"OpenData": "string",
"ClickData": "string"
}
GET /api/communication/stats/click/{communicationid}/{descriptionhash}
communicationid:
integer
in path
(no description)
descriptionhash:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"DescriptionHash": "string",
"CommunicationId": "integer",
"ClickEvents": "string"
}
GET /api/communication/synced/{since}
since:
string
in path
(no description)
OK
Response Example (200 OK)
{
"ExceptionMessage": "string",
"Exception": "string",
"Items": "string"
}
GET /api/communication/systememailtemplate/{templateid}
templateid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"TemplateId": "integer",
"TenantId": "integer",
"AuditId": "integer",
"OverrideForTemplateId": "string",
"Name": "string",
"Description": "string",
"CommunicationTemplateTypeId": "string",
"Subject": "string",
"GlobalFlags": "string",
"Body": "string",
"BodyRaw": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactId": "string",
"IsPublic": "boolean",
"IsActive": "boolean",
"IsActiveReadonly": "boolean",
"EmailAttachments": "string",
"LimitedEditMode": "boolean",
"IsSystemTemplate": "boolean",
"IsDeletable": "boolean",
"NotificationTypeId": "string",
"HasMergeFields": "boolean"
}
POST /api/communication/template/{templateid}
undefined
templateid:
string
in path
(no description)
Request Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string"
}
OK
Response Example (200 OK)
{
"Id": "integer",
"Name": "string",
"TemplateName": "string",
"Subject": "string",
"EmailBody": "string",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactId": "string",
"EmailAttachments": "string",
"CommunicationTemplateTypeId": "string",
"IsNewsletter": "boolean",
"EmailTemplate": "string",
"GlobalFlags": "string"
}
GET /api/communication/template/categories/lookup/
Response Example (200 OK)
[
{
"Id": "string",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
POST /api/communication/threads/add
undefined
Request Example
{
"CommunicationThreadId": "integer",
"CommunicationCategoryId": "string",
"Subject": "string"
}
200 OK
OK
Response Example (200 OK)
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
GET /api/communication/threads/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
POST /api/communication/unmatched/email
undefined
Request Example
{
"UnMatchedEmailAddressId": "integer",
"EmailAddressLeaveMeAlone": "string",
"Title": "string",
"RecentCommunicationSubjects": "string",
"IndividualMatchType": "string",
"PotentialIndividualMatches": "string",
"ContactId": "string",
"Individual": "string",
"IndividualFirstName": "string",
"IndividualLastName": "string",
"OrganizationMatchType": "string",
"PotentialOrgMatches": "string",
"OrganizationContactId": "string",
"Organization": "string",
"OrganizationName": "string"
}
Response Example (200 OK)
{
"UnMatchedEmailAddressId": "integer",
"EmailAddress": "string",
"NumberOfCommunications": "integer",
"MostRecentCommunication": "string",
"MostRecentCommunicationDate": "string",
"Actions": "string",
"TotalRecordAvailable": "integer"
}
GET /api/communication/unmatched/email/{unmatchedemailaddressid}
unmatchedemailaddressid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"UnMatchedEmailAddressId": "integer",
"EmailAddressLeaveMeAlone": "string",
"Title": "string",
"RecentCommunicationSubjects": "string",
"IndividualMatchType": "string",
"PotentialIndividualMatches": "string",
"ContactId": "string",
"Individual": "string",
"IndividualFirstName": "string",
"IndividualLastName": "string",
"OrganizationMatchType": "string",
"PotentialOrgMatches": "string",
"OrganizationContactId": "string",
"Organization": "string",
"OrganizationName": "string"
}
GET /api/communication/unmatched/list
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"Criteria": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/communication/upload/bulkunsubscribe
undefined
Request Example
{
"BulkUnsubscribeUpload": "string",
"FileUploadResults": "string"
}
200 OK
OK
POST /api/communication/upload/bulkunsubscribe/validate
OK
Response Example (200 OK)
{
"LineItems": "string",
"Errors": "string",
"InvalidRows": "string",
"IsImportSummaryEmpty": "boolean",
"ImportSummary": "string",
"ImportSummaryColumnErrors": "string",
"ImportSummaryRowErrors": "string"
}
GET /api/communication/watchersearch
search:
string
in query
(no description)
200 OK
OK
type
Response Example (200 OK)
[
{
"WatcherId": "integer",
"DisplayName": "string",
"ContactId": "string",
"EmailAddressId": "string",
"GroupId": "string",
"UniqueKey": "string",
"SemiUniqueKey": "string",
"AutoTypeText": "string"
}
]
Schema Definitions
CommunicationCategoryCollectionItemModel: object
- CommunicationCategoryId: integer
- AuditId: integer
- Name: string
- CssColor: string
- Actions: string
Example
{
"CommunicationCategoryId": "integer",
"AuditId": "integer",
"Name": "string",
"CssColor": "string",
"Actions": "string"
}
CommunicationCategoryAddEditModel: object
- CommunicationCategoryId: integer
- AuditId: integer
- Name: string
- CssColor: string
Example
{
"CommunicationCategoryId": "integer",
"AuditId": "integer",
"Name": "string",
"CssColor": "string"
}
GenericLookUpChoice<Int32>: object
- Id: integer
- Name: string
- ExtraData: string
- CssColor: string
- IsSelected: boolean
- IsDeleted: boolean
- Order: integer
Example
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
CommunicationThreadAddEditModel: object
- CommunicationThreadId: integer
- CommunicationCategoryId: string
- Subject: string
Example
{
"CommunicationThreadId": "integer",
"CommunicationCategoryId": "string",
"Subject": "string"
}
ListViewReturnModel<CommunicationCollectionItemModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
ListViewReturnModel<UnmatchedCommunicationCollectionItemModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
UnmatchedCommunicationCollectionFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- Criteria: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"Criteria": "string"
}
EmailAddressMatchToContactModel: object
- UnMatchedEmailAddressId: integer
- EmailAddressLeaveMeAlone: string
- Title: string
- RecentCommunicationSubjects: string
- IndividualMatchType: string
- PotentialIndividualMatches: string
- ContactId: string
- Individual: string
- IndividualFirstName: string
- IndividualLastName: string
- OrganizationMatchType: string
- PotentialOrgMatches: string
- OrganizationContactId: string
- Organization: string
- OrganizationName: string
Example
{
"UnMatchedEmailAddressId": "integer",
"EmailAddressLeaveMeAlone": "string",
"Title": "string",
"RecentCommunicationSubjects": "string",
"IndividualMatchType": "string",
"PotentialIndividualMatches": "string",
"ContactId": "string",
"Individual": "string",
"IndividualFirstName": "string",
"IndividualLastName": "string",
"OrganizationMatchType": "string",
"PotentialOrgMatches": "string",
"OrganizationContactId": "string",
"Organization": "string",
"OrganizationName": "string"
}
UnmatchedCommunicationCollectionItemModel: object
- UnMatchedEmailAddressId: integer
- EmailAddress: string
- NumberOfCommunications: integer
- MostRecentCommunication: string
- MostRecentCommunicationDate: string
- Actions: string
- TotalRecordAvailable: integer
Example
{
"UnMatchedEmailAddressId": "integer",
"EmailAddress": "string",
"NumberOfCommunications": "integer",
"MostRecentCommunication": "string",
"MostRecentCommunicationDate": "string",
"Actions": "string",
"TotalRecordAvailable": "integer"
}
ListViewReturnModel<CommunicationDraftsCollectionItemModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
CommunicationDraftsAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- Criteria: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"Criteria": "string"
}
Task<dynamic>: object
- ShouldNotifyDebuggerOfWaitCompletion: boolean
- Id: integer
- CurrentId: string
- Exception: string
- Status: string
- IsCanceled: boolean
- IsCompleted: boolean
- CreationOptions: string
- System.IAsyncResult.AsyncWaitHandle: string
- AsyncState: string
- System.IAsyncResult.CompletedSynchronously: boolean
- Factory: string
- CompletedTask: string
- IsFaulted: boolean
- SavedStateForNextReplica: string
- SavedStateFromPreviousReplica: string
- HandedOverChildReplica: string
- Result: string
Example
{
"ShouldNotifyDebuggerOfWaitCompletion": "boolean",
"Id": "integer",
"CurrentId": "string",
"Exception": "string",
"Status": "string",
"IsCanceled": "boolean",
"IsCompleted": "boolean",
"CreationOptions": "string",
"System.IAsyncResult.AsyncWaitHandle": "string",
"AsyncState": "string",
"System.IAsyncResult.CompletedSynchronously": "boolean",
"Factory": "string",
"CompletedTask": "string",
"IsFaulted": "boolean",
"SavedStateForNextReplica": "string",
"SavedStateFromPreviousReplica": "string",
"HandedOverChildReplica": "string",
"Result": "string"
}
CommunicationAdvancedFilterBase: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- TenantKey: string
- CommunicationId: string
- OrganizationId: string
- GroupId: string
- EventId: string
- ProjectId: string
- ContactId: string
- ContactName: string
- ToContactName: string
- ToContactId: string
- CommunicationDateBetween: string
- CommunicationTypeId: string
- CommunicationStatusTypeId: string
- ExcludeCommunicationStatusTypeId: string
- CommunicationCategoryId: string
- IsNotLinkedToAProject: boolean
- HasUnmatchedEmailAddress: boolean
- HideJunkMail: boolean
- Criteria: string
- CommunicationListId: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"TenantKey": "string",
"CommunicationId": "string",
"OrganizationId": "string",
"GroupId": "string",
"EventId": "string",
"ProjectId": "string",
"ContactId": "string",
"ContactName": "string",
"ToContactName": "string",
"ToContactId": "string",
"CommunicationDateBetween": "string",
"CommunicationTypeId": "string",
"CommunicationStatusTypeId": "string",
"ExcludeCommunicationStatusTypeId": "string",
"CommunicationCategoryId": "string",
"IsNotLinkedToAProject": "boolean",
"HasUnmatchedEmailAddress": "boolean",
"HideJunkMail": "boolean",
"Criteria": "string",
"CommunicationListId": "string"
}
CommunicationAddEditModel: object
- CommunicationId: integer
- AuditId: integer
- ContactId: string
- FromContactId: string
- FromContactDisplayName: string
- EmailFromAddress: string
- FromEmailAddressId: string
- EmailFromDisplay: string
- CommunicationCategoryName: string
- TotalRecipients: integer
- CommunicationThreadId: string
- EventId: string
- IsBodyStatic: boolean
- IsBodyHtml: boolean
- ExternalBodyUri: string
- MergeData: string
- RecipientJson: string
- EmailKey: string
- Signatures: string
- AuditInfo: string
- IsDeletable: boolean
- CommunicationTypeId: string
- CommunicationCategoryId: string
- CommunicationDate: string
- Recipients: string
- Subject: string
- Body: string
- Projects: string
- CreateFollowUpTask: boolean
- FollowUpDate: string
- FollowUpStaffContactId: string
- FollowUpTaskPriorityId: string
- FollowUpName: string
- FollowUpDescription: string
- EmailAttachments: string
- Created: string
- CreatedContact: string
- Modified: string
- ModifiedContact: string
- CommunicationTypeIdReadOnly: string
- BodyReadOnly: string
Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"Created": "string",
"CreatedContact": "string",
"Modified": "string",
"ModifiedContact": "string",
"CommunicationTypeIdReadOnly": "string",
"BodyReadOnly": "string"
}
CommunicationViewOnly: object
- CommunicationId: integer
- IsBodyHtml: boolean
- Subject: string
- Type: string
- CommunicationTypeId: string
- From: string
- To: string
- Cc: string
- Ucc: string
- Bcc: string
- FromContactDisplayName: string
- EmailFromAddress: string
- EmailFromDisplay: string
- CommunicationCategoryName: string
- TotalBcc: integer
- TotalCc: integer
- TotalTo: integer
- CommunicationDate: string
- EmailAttachments: string
- Projects: string
- ProjectsNames: string
- Body: string
- UntrackedCcMessage: string
Example
{
"CommunicationId": "integer",
"IsBodyHtml": "boolean",
"Subject": "string",
"Type": "string",
"CommunicationTypeId": "string",
"From": "string",
"To": "string",
"Cc": "string",
"Ucc": "string",
"Bcc": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalBcc": "integer",
"TotalCc": "integer",
"TotalTo": "integer",
"CommunicationDate": "string",
"EmailAttachments": "string",
"Projects": "string",
"ProjectsNames": "string",
"Body": "string",
"UntrackedCcMessage": "string"
}
CommunicationRecipientListModel: object
- CommunicationId: integer
- Recipients: string
Example
{
"CommunicationId": "integer",
"Recipients": "string"
}
CommunicationRecipientEditModel: object
- CommunicationRecipientId: integer
- ContactName: string
- ContactId: integer
Example
{
"CommunicationRecipientId": "integer",
"ContactName": "string",
"ContactId": "integer"
}
CommunicationRecipientTypeAheadItem: object
- RecipientName: string
- CommunicationRecipientId: string
- Name: string
- AdditionalData: string
Example
{
"RecipientName": "string",
"CommunicationRecipientId": "string",
"Name": "string",
"AdditionalData": "string"
}
CommunicationCollectionItemBaseModel: object
- CommunicationId: integer
- BatchId: string
- AuditId: integer
- CommunicationStatusTypeId: string
- Date: string
- Subject: string
- Body: string
- TotalRowCount: integer
- RecipientCount: integer
- FirstRecipientName: string
- From: string
- To: string
- CommunicationTypeId: string
- IsEmail: boolean
- IsNote: boolean
- HideNoteDeleteAction: boolean
- Category: string
- SpamScore: string
- SpamScoreOriginTypeId: string
- FilesCount: integer
- Attachments: string
- Actions: string
Example
{
"CommunicationId": "integer",
"BatchId": "string",
"AuditId": "integer",
"CommunicationStatusTypeId": "string",
"Date": "string",
"Subject": "string",
"Body": "string",
"TotalRowCount": "integer",
"RecipientCount": "integer",
"FirstRecipientName": "string",
"From": "string",
"To": "string",
"CommunicationTypeId": "string",
"IsEmail": "boolean",
"IsNote": "boolean",
"HideNoteDeleteAction": "boolean",
"Category": "string",
"SpamScore": "string",
"SpamScoreOriginTypeId": "string",
"FilesCount": "integer",
"Attachments": "string",
"Actions": "string"
}
CommunicationDeliveryStatisticsModel: object
- CommunicationId: integer
- BatchId: string
- Subject: string
- NoStatMessage: string
- ModalTitle: string
- RecipientsSelected: integer
- TotalNotSent: integer
- TotalNotSentAsLink: string
- TotalRecipients: integer
- TotalDeliverySoftFailures: integer
- TotalDeliverySoftFailuresAsLink: string
- TotalDeliveryHardFailures: integer
- TotalDeliveryHardFailuresAsLink: string
- SuccessfullyDelivered: integer
- DeliverabilityRate: number
- BounceRate: number
- RecipientCountThatOpened: integer
- TotalOpens: integer
- TotalOpensAsLink1: string
- TotalOpensAsLink2: string
- OpenRate: number
- RecipientsThatHaveClickedAtLeastOnce: integer
- TotalClickCount: integer
- TotalClickCountAsLink: string
- NumberOfDistinctClicks: integer
- ClickThroughRate: number
- ShowClickStats: boolean
- OpenData: string
- ClickData: string
Example
{
"CommunicationId": "integer",
"BatchId": "string",
"Subject": "string",
"NoStatMessage": "string",
"ModalTitle": "string",
"RecipientsSelected": "integer",
"TotalNotSent": "integer",
"TotalNotSentAsLink": "string",
"TotalRecipients": "integer",
"TotalDeliverySoftFailures": "integer",
"TotalDeliverySoftFailuresAsLink": "string",
"TotalDeliveryHardFailures": "integer",
"TotalDeliveryHardFailuresAsLink": "string",
"SuccessfullyDelivered": "integer",
"DeliverabilityRate": "number",
"BounceRate": "number",
"RecipientCountThatOpened": "integer",
"TotalOpens": "integer",
"TotalOpensAsLink1": "string",
"TotalOpensAsLink2": "string",
"OpenRate": "number",
"RecipientsThatHaveClickedAtLeastOnce": "integer",
"TotalClickCount": "integer",
"TotalClickCountAsLink": "string",
"NumberOfDistinctClicks": "integer",
"ClickThroughRate": "number",
"ShowClickStats": "boolean",
"OpenData": "string",
"ClickData": "string"
}
HttpResponseMessage: object
- Version: string
- Content: string
- StatusCode: string
- ReasonPhrase: string
- Headers: string
- RequestMessage: string
- IsSuccessStatusCode: boolean
Example
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
SmtpClickDetails: object
- DescriptionHash: string
- CommunicationId: integer
- ClickEvents: string
Example
{
"DescriptionHash": "string",
"CommunicationId": "integer",
"ClickEvents": "string"
}
FailedCommunicationDetailsViewModel: object
- CommunicationId: integer
- BatchId: string
- FailedStats: string
Example
{
"CommunicationId": "integer",
"BatchId": "string",
"FailedStats": "string"
}
BlockedCommunicationDetailsViewModel: object
- CommunicationId: integer
- BatchId: string
- FailedStats: string
Example
{
"CommunicationId": "integer",
"BatchId": "string",
"FailedStats": "string"
}
CommunicationDeliveryOpenEventsModel: object
- CommunicationId: integer
- BatchId: string
- OpenData: string
Example
{
"CommunicationId": "integer",
"BatchId": "string",
"OpenData": "string"
}
CommunicationDeliveryClickEventsModel: object
- CommunicationId: integer
- BatchId: string
- ClickData: string
Example
{
"CommunicationId": "integer",
"BatchId": "string",
"ClickData": "string"
}
ListViewReturnModel<ScheduledEmailListItem>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
ScheduledEmailListItemFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- ContactId: string
- ContactName: string
- ScheduledDate: string
- Status: string
- Criteria: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"ContactId": "string",
"ContactName": "string",
"ScheduledDate": "string",
"Status": "string",
"Criteria": "string"
}
ScheduledEmailableEntityList: object
- SystemJobId: integer
- To: string
Example
{
"SystemJobId": "integer",
"To": "string"
}
ScheduledEmailRecipientList: object
- CommunicationId: integer
- To: string
Example
{
"CommunicationId": "integer",
"To": "string"
}
CommunicationScheduledEmailEditModel: object
- AuditId: integer
- IsEventInvite: boolean
- CommunicationId: integer
- EventId: string
- BatchId: string
- CommunicationTypeId: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactRelatedContactId: string
- FromContactId: string
- EmailRecipients: string
- Cc: string
- Bcc: string
- AntiRecipients: string
- Subject: string
- CommunicationCategoryId: string
- DraftCommunicationId: string
- IsNewsletter: boolean
- EmailSendDate: string
- IsAvailableAsWebPage: boolean
- BlockUnsubscribeFooter: boolean
- Stats: string
- ContactId: string
- GroupId: string
- CommContactRelatedOrganizationId: string
- InvoiceId: string
- PaymentId: string
- RefundId: string
- MembershipId: string
- InvoicePayUrl: string
- EventSponsorId: string
- Signatures: string
- SupplementaryData: string
- GlobalFlags: string
- TemplateId: string
- IsNotNewsletter: boolean
- EmailBody: string
- EmailTemplate: string
- EmailAttachments: string
- ProjectId: string
- ProjectName: string
- ExcludeAlreadyRegistered: boolean
- ExcludeDeclined: boolean
- ExcludePreviouslyInvited: boolean
- FundraisingCampaignId: string
- Attachment: string
- SendEmailsIndivdiually: boolean
- EngagementContactId: string
- SendActionButtonText: string
- ScheduleActionButtonText: string
- HidePreview: string
- SystemJobId: integer
Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HidePreview": "string",
"SystemJobId": "integer"
}
ScheduledEmailListItem: object
- TotalRecordAvailable: integer
- CommunicationTypeId: string
- CommunicationId: integer
- SystemJobId: integer
- ScheduledDate: string
- SentDate: string
- Status: string
- Subject: string
- RecipientDisplayName: string
- From: string
- SenderName: string
- Actions: string
Example
{
"TotalRecordAvailable": "integer",
"CommunicationTypeId": "string",
"CommunicationId": "integer",
"SystemJobId": "integer",
"ScheduledDate": "string",
"SentDate": "string",
"Status": "string",
"Subject": "string",
"RecipientDisplayName": "string",
"From": "string",
"SenderName": "string",
"Actions": "string"
}
CommunicationScheduledEmailDesignerEditModel: object
- AuditId: integer
- IsEventInvite: boolean
- CommunicationId: integer
- EventId: string
- BatchId: string
- CommunicationTypeId: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactRelatedContactId: string
- FromContactId: string
- EmailRecipients: string
- Cc: string
- Bcc: string
- AntiRecipients: string
- Subject: string
- CommunicationCategoryId: string
- DraftCommunicationId: string
- IsNewsletter: boolean
- EmailSendDate: string
- IsAvailableAsWebPage: boolean
- BlockUnsubscribeFooter: boolean
- Stats: string
- ContactId: string
- GroupId: string
- CommContactRelatedOrganizationId: string
- InvoiceId: string
- PaymentId: string
- RefundId: string
- MembershipId: string
- InvoicePayUrl: string
- EventSponsorId: string
- Signatures: string
- SupplementaryData: string
- GlobalFlags: string
- TemplateId: string
- IsNotNewsletter: boolean
- EmailBody: string
- EmailTemplate: string
- EmailAttachments: string
- ProjectId: string
- ProjectName: string
- ExcludeAlreadyRegistered: boolean
- ExcludeDeclined: boolean
- ExcludePreviouslyInvited: boolean
- FundraisingCampaignId: string
- Attachment: string
- SendEmailsIndivdiually: boolean
- EngagementContactId: string
- SendActionButtonText: string
- ScheduleActionButtonText: string
- HidePreview: string
- SystemJobId: integer
Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HidePreview": "string",
"SystemJobId": "integer"
}
AddEditFollowUpReminder: object
- ContactId: integer
- FollowUpDate: string
- FollowUpTaskPriorityId: string
- TaskTypeId: string
- FollowUpStaffContactId: string
- ContactName: string
- ProjectLookup: string
- ProjectId: string
- FollowUpName: string
- FollowUpDescription: string
Example
{
"ContactId": "integer",
"FollowUpDate": "string",
"FollowUpTaskPriorityId": "string",
"TaskTypeId": "string",
"FollowUpStaffContactId": "string",
"ContactName": "string",
"ProjectLookup": "string",
"ProjectId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string"
}
ContactTasksViewModel: object
- TaskItemId: integer
- ProjectId: string
- ProjectName: string
- Name: string
- TaskPriority: string
- TaskType: string
- Contact: string
- AssignedToContact: string
- DueDate: string
- CompletedDate: string
- PercentComplete: string
Example
{
"TaskItemId": "integer",
"ProjectId": "string",
"ProjectName": "string",
"Name": "string",
"TaskPriority": "string",
"TaskType": "string",
"Contact": "string",
"AssignedToContact": "string",
"DueDate": "string",
"CompletedDate": "string",
"PercentComplete": "string"
}
EditFollowUpReminderViewModel: object
- TaskItemId: integer
- AuditId: integer
- DisplayName: string
- FollowUpDate: string
- IsCompleted: boolean
- FollowUpStaffContactId: string
- FollowUpNote: string
- FollowUpDescription: string
- Communication: string
- CommunicationCount: integer
- CreateFollowUpTask: boolean
- NewFollowUpDate: string
- NewFollowUpStaffContactId: string
- NewFollowUpName: string
- NewFollowUpDescription: string
Example
{
"TaskItemId": "integer",
"AuditId": "integer",
"DisplayName": "string",
"FollowUpDate": "string",
"IsCompleted": "boolean",
"FollowUpStaffContactId": "string",
"FollowUpNote": "string",
"FollowUpDescription": "string",
"Communication": "string",
"CommunicationCount": "integer",
"CreateFollowUpTask": "boolean",
"NewFollowUpDate": "string",
"NewFollowUpStaffContactId": "string",
"NewFollowUpName": "string",
"NewFollowUpDescription": "string"
}
PersonCommunicationAddEditModel: object
- CommunicationId: integer
- AuditId: integer
- ContactId: string
- FromContactId: string
- FromContactDisplayName: string
- EmailFromAddress: string
- FromEmailAddressId: string
- EmailFromDisplay: string
- CommunicationCategoryName: string
- TotalRecipients: integer
- CommunicationThreadId: string
- EventId: string
- IsBodyStatic: boolean
- IsBodyHtml: boolean
- ExternalBodyUri: string
- MergeData: string
- RecipientJson: string
- EmailKey: string
- Signatures: string
- AuditInfo: string
- IsDeletable: boolean
- CommunicationTypeId: string
- CommunicationCategoryId: string
- CommunicationDate: string
- Recipients: string
- Subject: string
- Body: string
- Projects: string
- CreateFollowUpTask: boolean
- FollowUpDate: string
- FollowUpStaffContactId: string
- FollowUpTaskPriorityId: string
- FollowUpName: string
- FollowUpDescription: string
- EmailAttachments: string
- ContactDisplayName: string
- CommunicationTypeIdReadOnly: string
- BodyReadOnly: string
Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"ContactDisplayName": "string",
"CommunicationTypeIdReadOnly": "string",
"BodyReadOnly": "string"
}
PersonLogNoteModel: object
- CommunicationId: integer
- AuditId: integer
- ContactId: string
- FromContactId: string
- FromContactDisplayName: string
- EmailFromAddress: string
- FromEmailAddressId: string
- EmailFromDisplay: string
- CommunicationCategoryName: string
- TotalRecipients: integer
- CommunicationThreadId: string
- EventId: string
- IsBodyStatic: boolean
- IsBodyHtml: boolean
- ExternalBodyUri: string
- MergeData: string
- RecipientJson: string
- EmailKey: string
- Signatures: string
- AuditInfo: string
- IsDeletable: boolean
- CommunicationTypeId: string
- CommunicationCategoryId: string
- CommunicationDate: string
- Recipients: string
- Subject: string
- Body: string
- Projects: string
- CreateFollowUpTask: boolean
- FollowUpDate: string
- FollowUpStaffContactId: string
- FollowUpTaskPriorityId: string
- FollowUpName: string
- FollowUpDescription: string
- EmailAttachments: string
- DisplayName: string
Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"DisplayName": "string"
}
ListViewReturnModel<ContactCommunicationCollectionItemModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
OrganizationCommunicationAddEditModel: object
- CommunicationId: integer
- AuditId: integer
- ContactId: string
- FromContactId: string
- FromContactDisplayName: string
- EmailFromAddress: string
- FromEmailAddressId: string
- EmailFromDisplay: string
- CommunicationCategoryName: string
- TotalRecipients: integer
- CommunicationThreadId: string
- EventId: string
- IsBodyStatic: boolean
- IsBodyHtml: boolean
- ExternalBodyUri: string
- MergeData: string
- RecipientJson: string
- EmailKey: string
- Signatures: string
- AuditInfo: string
- IsDeletable: boolean
- CommunicationTypeId: string
- CommunicationCategoryId: string
- CommunicationDate: string
- Recipients: string
- Subject: string
- Body: string
- Projects: string
- CreateFollowUpTask: boolean
- FollowUpDate: string
- FollowUpStaffContactId: string
- FollowUpTaskPriorityId: string
- FollowUpName: string
- FollowUpDescription: string
- EmailAttachments: string
- ContactDisplayName: string
- RecipientCount: integer
- CommunicationTypeIdReadOnly: string
- BodyReadOnly: string
Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"ContactDisplayName": "string",
"RecipientCount": "integer",
"CommunicationTypeIdReadOnly": "string",
"BodyReadOnly": "string"
}
ContactCollectionLogNoteModel: object
- CommunicationId: integer
- AuditId: integer
- ContactId: string
- FromContactId: string
- FromContactDisplayName: string
- EmailFromAddress: string
- FromEmailAddressId: string
- EmailFromDisplay: string
- CommunicationCategoryName: string
- TotalRecipients: integer
- CommunicationThreadId: string
- EventId: string
- IsBodyStatic: boolean
- IsBodyHtml: boolean
- ExternalBodyUri: string
- MergeData: string
- RecipientJson: string
- EmailKey: string
- Signatures: string
- AuditInfo: string
- IsDeletable: boolean
- CommunicationTypeId: string
- CommunicationCategoryId: string
- CommunicationDate: string
- Recipients: string
- Subject: string
- Body: string
- Projects: string
- CreateFollowUpTask: boolean
- FollowUpDate: string
- FollowUpStaffContactId: string
- FollowUpTaskPriorityId: string
- FollowUpName: string
- FollowUpDescription: string
- EmailAttachments: string
- SelectedIds: string
Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"SelectedIds": "string"
}
OrganizationLogNoteModel: object
- CommunicationId: integer
- AuditId: integer
- ContactId: string
- FromContactId: string
- FromContactDisplayName: string
- EmailFromAddress: string
- FromEmailAddressId: string
- EmailFromDisplay: string
- CommunicationCategoryName: string
- TotalRecipients: integer
- CommunicationThreadId: string
- EventId: string
- IsBodyStatic: boolean
- IsBodyHtml: boolean
- ExternalBodyUri: string
- MergeData: string
- RecipientJson: string
- EmailKey: string
- Signatures: string
- AuditInfo: string
- IsDeletable: boolean
- CommunicationTypeId: string
- CommunicationCategoryId: string
- CommunicationDate: string
- Recipients: string
- Subject: string
- Body: string
- Projects: string
- CreateFollowUpTask: boolean
- FollowUpDate: string
- FollowUpStaffContactId: string
- FollowUpTaskPriorityId: string
- FollowUpName: string
- FollowUpDescription: string
- EmailAttachments: string
- ContactDisplayName: string
Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"ContactDisplayName": "string"
}
ListViewReturnModel<GroupCommunicationCollectionItemModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
ListViewReturnModel<EventCommunicationCollectionItemModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
EventCommunicationAddEditModel: object
- CommunicationId: integer
- AuditId: integer
- ContactId: string
- FromContactId: string
- FromContactDisplayName: string
- EmailFromAddress: string
- FromEmailAddressId: string
- EmailFromDisplay: string
- CommunicationCategoryName: string
- TotalRecipients: integer
- CommunicationThreadId: string
- EventId: string
- IsBodyStatic: boolean
- IsBodyHtml: boolean
- ExternalBodyUri: string
- MergeData: string
- RecipientJson: string
- EmailKey: string
- Signatures: string
- AuditInfo: string
- IsDeletable: boolean
- CommunicationTypeId: string
- CommunicationCategoryId: string
- CommunicationDate: string
- Recipients: string
- Subject: string
- Body: string
- Projects: string
- CreateFollowUpTask: boolean
- FollowUpDate: string
- FollowUpStaffContactId: string
- FollowUpTaskPriorityId: string
- FollowUpName: string
- FollowUpDescription: string
- EmailAttachments: string
- Name: string
Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"Name": "string"
}
ListViewReturnModel<ProjectCommunicationCollectionItemModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
ProjectLogNoteModel: object
- CommunicationId: integer
- AuditId: integer
- ContactId: string
- FromContactId: string
- FromContactDisplayName: string
- EmailFromAddress: string
- FromEmailAddressId: string
- EmailFromDisplay: string
- CommunicationCategoryName: string
- TotalRecipients: integer
- CommunicationThreadId: string
- EventId: string
- IsBodyStatic: boolean
- IsBodyHtml: boolean
- ExternalBodyUri: string
- MergeData: string
- RecipientJson: string
- EmailKey: string
- Signatures: string
- AuditInfo: string
- IsDeletable: boolean
- CommunicationTypeId: string
- CommunicationCategoryId: string
- CommunicationDate: string
- Recipients: string
- Subject: string
- Body: string
- Projects: string
- CreateFollowUpTask: boolean
- FollowUpDate: string
- FollowUpStaffContactId: string
- FollowUpTaskPriorityId: string
- FollowUpName: string
- FollowUpDescription: string
- EmailAttachments: string
- ProjectId: integer
- Name: string
Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"ProjectId": "integer",
"Name": "string"
}
ProjectCommunicationAddEditModel: object
- CommunicationId: integer
- AuditId: integer
- ContactId: string
- FromContactId: string
- FromContactDisplayName: string
- EmailFromAddress: string
- FromEmailAddressId: string
- EmailFromDisplay: string
- CommunicationCategoryName: string
- TotalRecipients: integer
- CommunicationThreadId: string
- EventId: string
- IsBodyStatic: boolean
- IsBodyHtml: boolean
- ExternalBodyUri: string
- MergeData: string
- RecipientJson: string
- EmailKey: string
- Signatures: string
- AuditInfo: string
- IsDeletable: boolean
- CommunicationTypeId: string
- CommunicationCategoryId: string
- CommunicationDate: string
- Recipients: string
- Subject: string
- Body: string
- Projects: string
- CreateFollowUpTask: boolean
- FollowUpDate: string
- FollowUpStaffContactId: string
- FollowUpTaskPriorityId: string
- FollowUpName: string
- FollowUpDescription: string
- EmailAttachments: string
- ProjectId: integer
- Name: string
- CommunicationTypeIdReadOnly: string
- BodyReadOnly: string
Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"ContactId": "string",
"FromContactId": "string",
"FromContactDisplayName": "string",
"EmailFromAddress": "string",
"FromEmailAddressId": "string",
"EmailFromDisplay": "string",
"CommunicationCategoryName": "string",
"TotalRecipients": "integer",
"CommunicationThreadId": "string",
"EventId": "string",
"IsBodyStatic": "boolean",
"IsBodyHtml": "boolean",
"ExternalBodyUri": "string",
"MergeData": "string",
"RecipientJson": "string",
"EmailKey": "string",
"Signatures": "string",
"AuditInfo": "string",
"IsDeletable": "boolean",
"CommunicationTypeId": "string",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Recipients": "string",
"Subject": "string",
"Body": "string",
"Projects": "string",
"CreateFollowUpTask": "boolean",
"FollowUpDate": "string",
"FollowUpStaffContactId": "string",
"FollowUpTaskPriorityId": "string",
"FollowUpName": "string",
"FollowUpDescription": "string",
"EmailAttachments": "string",
"ProjectId": "integer",
"Name": "string",
"CommunicationTypeIdReadOnly": "string",
"BodyReadOnly": "string"
}
ServerResult<SyncedItemModel>: object
- ExceptionMessage: string
- Exception: string
- Items: string
Example
{
"ExceptionMessage": "string",
"Exception": "string",
"Items": "string"
}
CommunicationBaseModel: object
- ShowEmailDesigner: boolean
Example
{
"ShowEmailDesigner": "boolean"
}
ListViewReturnModel<EmailTemplateListItem>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
EmailTemplateAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- Criteria: string
- Category: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"Criteria": "string",
"Category": "string"
}
EmailTemplateListItem: object
- ShowEmailDesigner: boolean
- TemplateId: integer
- EmailTemplateId: integer
- TenantId: integer
- TotalRecordAvailable: integer
- Name: string
- CommunicationTemplateTypeId: string
- Description: string
- IsDeletable: boolean
- IsActive: boolean
- Actions: string
Example
{
"ShowEmailDesigner": "boolean",
"TemplateId": "integer",
"EmailTemplateId": "integer",
"TenantId": "integer",
"TotalRecordAvailable": "integer",
"Name": "string",
"CommunicationTemplateTypeId": "string",
"Description": "string",
"IsDeletable": "boolean",
"IsActive": "boolean",
"Actions": "string"
}
CommunicationTemplateViewModel: object
- Id: integer
- Name: string
- TemplateName: string
- Subject: string
- EmailBody: string
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactId: string
- EmailAttachments: string
- CommunicationTemplateTypeId: string
- IsNewsletter: boolean
- EmailTemplate: string
- GlobalFlags: string
Example
{
"Id": "integer",
"Name": "string",
"TemplateName": "string",
"Subject": "string",
"EmailBody": "string",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactId": "string",
"EmailAttachments": "string",
"CommunicationTemplateTypeId": "string",
"IsNewsletter": "boolean",
"EmailTemplate": "string",
"GlobalFlags": "string"
}
EmailTemplateSelectionModel: object
- Id: integer
- Name: string
Example
{
"Id": "integer",
"Name": "string"
}
IQueryable: object
- Expression: string
- ElementType: string
- Provider: string
Example
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
EmailDesignerCommunicationTemplateViewModel: object
- Id: integer
- Name: string
- TemplateName: string
- Subject: string
- EmailBody: string
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactId: string
- EmailAttachments: string
- CommunicationTemplateTypeId: string
- IsNewsletter: boolean
- EmailTemplate: string
- GlobalFlags: string
- IsGlobalTemplate: boolean
Example
{
"Id": "integer",
"Name": "string",
"TemplateName": "string",
"Subject": "string",
"EmailBody": "string",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactId": "string",
"EmailAttachments": "string",
"CommunicationTemplateTypeId": "string",
"IsNewsletter": "boolean",
"EmailTemplate": "string",
"GlobalFlags": "string",
"IsGlobalTemplate": "boolean"
}
QuickEmailViewModelBase: object
- AuditId: integer
- IsEventInvite: boolean
- CommunicationId: integer
- EventId: string
- BatchId: string
- CommunicationTypeId: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactRelatedContactId: string
- FromContactId: string
- EmailRecipients: string
- Cc: string
- Bcc: string
- AntiRecipients: string
- Subject: string
- CommunicationCategoryId: string
- DraftCommunicationId: string
- IsNewsletter: boolean
- EmailSendDate: string
- IsAvailableAsWebPage: boolean
- BlockUnsubscribeFooter: boolean
- Stats: string
- ContactId: string
- GroupId: string
- CommContactRelatedOrganizationId: string
- InvoiceId: string
- PaymentId: string
- RefundId: string
- MembershipId: string
- InvoicePayUrl: string
- EventSponsorId: string
- Signatures: string
- SupplementaryData: string
- GlobalFlags: string
- TemplateId: string
- IsNotNewsletter: boolean
- EmailBody: string
- EmailTemplate: string
- EmailAttachments: string
- ProjectId: string
- ProjectName: string
- ExcludeAlreadyRegistered: boolean
- ExcludeDeclined: boolean
- ExcludePreviouslyInvited: boolean
- FundraisingCampaignId: string
- Attachment: string
- SendEmailsIndivdiually: boolean
- EngagementContactId: string
- SendActionButtonText: string
- ScheduleActionButtonText: string
Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string"
}
EmailViewModelStatsModelWrapper: object
- Stats: string
-
Gets or sets counts of various email addresses
Example
{
"Stats": "string"
}
QuickEmailStatsViewModel: object
- AuditId: integer
- IsEventInvite: boolean
- CommunicationId: integer
- EventId: string
- BatchId: string
- CommunicationTypeId: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactRelatedContactId: string
- FromContactId: string
- EmailRecipients: string
- Cc: string
- Bcc: string
- AntiRecipients: string
- Subject: string
- CommunicationCategoryId: string
- DraftCommunicationId: string
- IsNewsletter: boolean
- EmailSendDate: string
- IsAvailableAsWebPage: boolean
- BlockUnsubscribeFooter: boolean
- Stats: string
- ContactId: string
- GroupId: string
- CommContactRelatedOrganizationId: string
- InvoiceId: string
- PaymentId: string
- RefundId: string
- MembershipId: string
- InvoicePayUrl: string
- EventSponsorId: string
- Signatures: string
- SupplementaryData: string
- GlobalFlags: string
- TemplateId: string
- IsNotNewsletter: boolean
- EmailBody: string
- EmailTemplate: string
- EmailAttachments: string
- ProjectId: string
- ProjectName: string
- ExcludeAlreadyRegistered: boolean
- ExcludeDeclined: boolean
- ExcludePreviouslyInvited: boolean
- FundraisingCampaignId: string
- Attachment: string
- SendEmailsIndivdiually: boolean
- EngagementContactId: string
- SendActionButtonText: string
- ScheduleActionButtonText: string
Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string"
}
EmailDesignerModel: object
- AuditId: integer
- IsEventInvite: boolean
- CommunicationId: integer
- EventId: string
- BatchId: string
- CommunicationTypeId: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactRelatedContactId: string
- FromContactId: string
- EmailRecipients: string
- Cc: string
- Bcc: string
- AntiRecipients: string
- Subject: string
- CommunicationCategoryId: string
- DraftCommunicationId: string
- IsNewsletter: boolean
- EmailSendDate: string
- IsAvailableAsWebPage: boolean
- BlockUnsubscribeFooter: boolean
- Stats: string
- TemplateId: string
- TemplateName: string
- IsGlobalTemplate: boolean
- EmailTemplate: string
- ActionName: string
- GlobalFlags: string
Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"TemplateId": "string",
"TemplateName": "string",
"IsGlobalTemplate": "boolean",
"EmailTemplate": "string",
"ActionName": "string",
"GlobalFlags": "string"
}
AddEditTemplateModel: object
- TemplateId: integer
- TenantId: integer
- AuditId: integer
- OverrideForTemplateId: string
- Name: string
- Description: string
- CommunicationTemplateTypeId: string
- Subject: string
- GlobalFlags: string
- Body: string
- BodyRaw: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactId: string
- IsPublic: boolean
- IsActive: boolean
- IsActiveReadonly: boolean
- EmailAttachments: string
- LimitedEditMode: boolean
- IsSystemTemplate: boolean
- IsDeletable: boolean
- NotificationTypeId: string
- HasMergeFields: boolean
Example
{
"TemplateId": "integer",
"TenantId": "integer",
"AuditId": "integer",
"OverrideForTemplateId": "string",
"Name": "string",
"Description": "string",
"CommunicationTemplateTypeId": "string",
"Subject": "string",
"GlobalFlags": "string",
"Body": "string",
"BodyRaw": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactId": "string",
"IsPublic": "boolean",
"IsActive": "boolean",
"IsActiveReadonly": "boolean",
"EmailAttachments": "string",
"LimitedEditMode": "boolean",
"IsSystemTemplate": "boolean",
"IsDeletable": "boolean",
"NotificationTypeId": "string",
"HasMergeFields": "boolean"
}
AddEmailDesignerTemplateModel: object
- TemplateId: integer
- AuditId: integer
- OverrideForTemplateId: string
- Name: string
- Description: string
- CommunicationTemplateTypeId: string
- Subject: string
- GlobalFlags: string
- NewsletterData: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddressId: string
- FromContactId: string
- IsPublic: boolean
- EmailAttachments: string
- IsSystemTemplate: boolean
- IsDeletable: boolean
- NotificationTypeId: string
Example
{
"TemplateId": "integer",
"AuditId": "integer",
"OverrideForTemplateId": "string",
"Name": "string",
"Description": "string",
"CommunicationTemplateTypeId": "string",
"Subject": "string",
"GlobalFlags": "string",
"NewsletterData": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddressId": "string",
"FromContactId": "string",
"IsPublic": "boolean",
"EmailAttachments": "string",
"IsSystemTemplate": "boolean",
"IsDeletable": "boolean",
"NotificationTypeId": "string"
}
EmailFromAddressModel: object
- Id: string
- EmailAddressId: integer
- FromEmailAddressId: integer
- FromContactRelatedContactId: string
- FromContactId: string
- FromWillBeRewritten: boolean
- EmailAddress: string
- DisplayName: string
- forceSave: boolean
Example
{
"Id": "string",
"EmailAddressId": "integer",
"FromEmailAddressId": "integer",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"FromWillBeRewritten": "boolean",
"EmailAddress": "string",
"DisplayName": "string",
"forceSave": "boolean"
}
CommunicationAutoSendEmailItemModel: object
- CommunicationTriggerId: string
- TriggerId: string
- CategoryType: string
- AuditId: integer
- DisplayName: string
- DelayMinutes: integer
- TemplateId: string
- DoNotSend: boolean
Example
{
"CommunicationTriggerId": "string",
"TriggerId": "string",
"CategoryType": "string",
"AuditId": "integer",
"DisplayName": "string",
"DelayMinutes": "integer",
"TemplateId": "string",
"DoNotSend": "boolean"
}
AutomatedMessagingAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- Criteria: string
- CategoryType: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"Criteria": "string",
"CategoryType": "string"
}
EmailAndNewsletterModel: object
- AuditId: integer
- IsEventInvite: boolean
- CommunicationId: integer
- EventId: string
- BatchId: string
- CommunicationTypeId: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactRelatedContactId: string
- FromContactId: string
- EmailRecipients: string
- Cc: string
- Bcc: string
- AntiRecipients: string
- Subject: string
- CommunicationCategoryId: string
- DraftCommunicationId: string
- IsNewsletter: boolean
- EmailSendDate: string
- IsAvailableAsWebPage: boolean
- BlockUnsubscribeFooter: boolean
- Stats: string
Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string"
}
CommunicationForwardEmailModel: object
- AuditId: integer
- IsEventInvite: boolean
- CommunicationId: integer
- EventId: string
- BatchId: string
- CommunicationTypeId: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactRelatedContactId: string
- FromContactId: string
- EmailRecipients: string
- Cc: string
- Bcc: string
- AntiRecipients: string
- Subject: string
- CommunicationCategoryId: string
- DraftCommunicationId: string
- IsNewsletter: boolean
- EmailSendDate: string
- IsAvailableAsWebPage: boolean
- BlockUnsubscribeFooter: boolean
- Stats: string
- ContactId: string
- GroupId: string
- CommContactRelatedOrganizationId: string
- InvoiceId: string
- PaymentId: string
- RefundId: string
- MembershipId: string
- InvoicePayUrl: string
- EventSponsorId: string
- Signatures: string
- SupplementaryData: string
- GlobalFlags: string
- TemplateId: string
- IsNotNewsletter: boolean
- EmailBody: string
- EmailTemplate: string
- EmailAttachments: string
- ProjectId: string
- ProjectName: string
- ExcludeAlreadyRegistered: boolean
- ExcludeDeclined: boolean
- ExcludePreviouslyInvited: boolean
- FundraisingCampaignId: string
- Attachment: string
- SendEmailsIndivdiually: boolean
- EngagementContactId: string
- SendActionButtonText: string
- ScheduleActionButtonText: string
- HasMergeFields: boolean
- CommunicationRecipientId: string
- Information: string
- MergeFieldSource: string
- RecipientName: string
- ApplyMergeData: string
- MoreInformation: string
- BaseCommunicationId: integer
Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HasMergeFields": "boolean",
"CommunicationRecipientId": "string",
"Information": "string",
"MergeFieldSource": "string",
"RecipientName": "string",
"ApplyMergeData": "string",
"MoreInformation": "string",
"BaseCommunicationId": "integer"
}
QuickEmailViewModel: object
- AuditId: integer
- IsEventInvite: boolean
- CommunicationId: integer
- EventId: string
- BatchId: string
- CommunicationTypeId: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactRelatedContactId: string
- FromContactId: string
- EmailRecipients: string
- Cc: string
- Bcc: string
- AntiRecipients: string
- Subject: string
- CommunicationCategoryId: string
- DraftCommunicationId: string
- IsNewsletter: boolean
- EmailSendDate: string
- IsAvailableAsWebPage: boolean
- BlockUnsubscribeFooter: boolean
- Stats: string
- ContactId: string
- GroupId: string
- CommContactRelatedOrganizationId: string
- InvoiceId: string
- PaymentId: string
- RefundId: string
- MembershipId: string
- InvoicePayUrl: string
- EventSponsorId: string
- Signatures: string
- SupplementaryData: string
- GlobalFlags: string
- TemplateId: string
- IsNotNewsletter: boolean
- EmailBody: string
- EmailTemplate: string
- EmailAttachments: string
- ProjectId: string
- ProjectName: string
- ExcludeAlreadyRegistered: boolean
- ExcludeDeclined: boolean
- ExcludePreviouslyInvited: boolean
- FundraisingCampaignId: string
- Attachment: string
- SendEmailsIndivdiually: boolean
- EngagementContactId: string
- SendActionButtonText: string
- ScheduleActionButtonText: string
- HidePreview: string
Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HidePreview": "string"
}
QuickEmailViewModelContacts: object
- AuditId: integer
- IsEventInvite: boolean
- CommunicationId: integer
- EventId: string
- BatchId: string
- CommunicationTypeId: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactRelatedContactId: string
- FromContactId: string
- EmailRecipients: string
- Cc: string
- Bcc: string
- AntiRecipients: string
- Subject: string
- CommunicationCategoryId: string
- DraftCommunicationId: string
- IsNewsletter: boolean
- EmailSendDate: string
- IsAvailableAsWebPage: boolean
- BlockUnsubscribeFooter: boolean
- Stats: string
- ContactId: string
- GroupId: string
- CommContactRelatedOrganizationId: string
- InvoiceId: string
- PaymentId: string
- RefundId: string
- MembershipId: string
- InvoicePayUrl: string
- EventSponsorId: string
- Signatures: string
- SupplementaryData: string
- GlobalFlags: string
- TemplateId: string
- IsNotNewsletter: boolean
- EmailBody: string
- EmailTemplate: string
- EmailAttachments: string
- ProjectId: string
- ProjectName: string
- ExcludeAlreadyRegistered: boolean
- ExcludeDeclined: boolean
- ExcludePreviouslyInvited: boolean
- FundraisingCampaignId: string
- Attachment: string
- SendEmailsIndivdiually: boolean
- EngagementContactId: string
- SendActionButtonText: string
- ScheduleActionButtonText: string
- HidePreview: string
- SelectedIds: string
- TemplateGuid: string
Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HidePreview": "string",
"SelectedIds": "string",
"TemplateGuid": "string"
}
QuickEmailViewModelContactEmail: object
- AuditId: integer
- IsEventInvite: boolean
- CommunicationId: integer
- EventId: string
- BatchId: string
- CommunicationTypeId: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactRelatedContactId: string
- FromContactId: string
- EmailRecipients: string
- Cc: string
- Bcc: string
- AntiRecipients: string
- Subject: string
- CommunicationCategoryId: string
- DraftCommunicationId: string
- IsNewsletter: boolean
- EmailSendDate: string
- IsAvailableAsWebPage: boolean
- BlockUnsubscribeFooter: boolean
- Stats: string
- ContactId: string
- GroupId: string
- CommContactRelatedOrganizationId: string
- InvoiceId: string
- PaymentId: string
- RefundId: string
- MembershipId: string
- InvoicePayUrl: string
- EventSponsorId: string
- Signatures: string
- SupplementaryData: string
- GlobalFlags: string
- TemplateId: string
- IsNotNewsletter: boolean
- EmailBody: string
- EmailTemplate: string
- EmailAttachments: string
- ProjectId: string
- ProjectName: string
- ExcludeAlreadyRegistered: boolean
- ExcludeDeclined: boolean
- ExcludePreviouslyInvited: boolean
- FundraisingCampaignId: string
- Attachment: string
- SendEmailsIndivdiually: boolean
- EngagementContactId: string
- SendActionButtonText: string
- ScheduleActionButtonText: string
- HidePreview: string
- ContactEmailAddressId: integer
Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"HidePreview": "string",
"ContactEmailAddressId": "integer"
}
MembershipRenewalsAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- EndDateBetween: string
- MembershipTypeId: string
- MembershipLevelId: string
- RenewalMonth: string
- Criteria: string
- MembershipStatus: string
- IsDuplicateEmail: boolean
- StartDateBetween: string
- Tags: string
- Frequency: string
- PaymentPlanIsFinished: boolean
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"EndDateBetween": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"RenewalMonth": "string",
"Criteria": "string",
"MembershipStatus": "string",
"IsDuplicateEmail": "boolean",
"StartDateBetween": "string",
"Tags": "string",
"Frequency": "string",
"PaymentPlanIsFinished": "boolean"
}
NewsletterModel: object
- AuditId: integer
- IsEventInvite: boolean
- CommunicationId: integer
- EventId: string
- BatchId: string
- CommunicationTypeId: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactRelatedContactId: string
- FromContactId: string
- EmailRecipients: string
- Cc: string
- Bcc: string
- AntiRecipients: string
- Subject: string
- CommunicationCategoryId: string
- DraftCommunicationId: string
- IsNewsletter: boolean
- EmailSendDate: string
- IsAvailableAsWebPage: boolean
- BlockUnsubscribeFooter: boolean
- Stats: string
- TemplateId: string
- PrimaryColor: string
- SecondaryColor: string
- FontFamily: string
- EmailTemplate: string
- ActionName: string
Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"TemplateId": "string",
"PrimaryColor": "string",
"SecondaryColor": "string",
"FontFamily": "string",
"EmailTemplate": "string",
"ActionName": "string"
}
QuickEmailPreviewViewModel: object
- AuditId: integer
- IsEventInvite: boolean
- CommunicationId: integer
- EventId: string
- BatchId: string
- CommunicationTypeId: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactRelatedContactId: string
- FromContactId: string
- EmailRecipients: string
- Cc: string
- Bcc: string
- AntiRecipients: string
- Subject: string
- CommunicationCategoryId: string
- DraftCommunicationId: string
- IsNewsletter: boolean
- EmailSendDate: string
- IsAvailableAsWebPage: boolean
- BlockUnsubscribeFooter: boolean
- Stats: string
- ContactId: string
- GroupId: string
- CommContactRelatedOrganizationId: string
- InvoiceId: string
- PaymentId: string
- RefundId: string
- MembershipId: string
- InvoicePayUrl: string
- EventSponsorId: string
- Signatures: string
- SupplementaryData: string
- GlobalFlags: string
- TemplateId: string
- IsNotNewsletter: boolean
- EmailBody: string
- EmailTemplate: string
- EmailAttachments: string
- ProjectId: string
- ProjectName: string
- ExcludeAlreadyRegistered: boolean
- ExcludeDeclined: boolean
- ExcludePreviouslyInvited: boolean
- FundraisingCampaignId: string
- Attachment: string
- SendEmailsIndivdiually: boolean
- EngagementContactId: string
- SendActionButtonText: string
- ScheduleActionButtonText: string
- EmailPreviewRecipients: string
- DataSource: string
Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"EmailPreviewRecipients": "string",
"DataSource": "string"
}
QuickEmailPreviewDataViewModel: object
- AuditId: integer
- IsEventInvite: boolean
- CommunicationId: integer
- EventId: string
- BatchId: string
- CommunicationTypeId: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactRelatedContactId: string
- FromContactId: string
- EmailRecipients: string
- Cc: string
- Bcc: string
- AntiRecipients: string
- Subject: string
- CommunicationCategoryId: string
- DraftCommunicationId: string
- IsNewsletter: boolean
- EmailSendDate: string
- IsAvailableAsWebPage: boolean
- BlockUnsubscribeFooter: boolean
- Stats: string
- ContactId: string
- GroupId: string
- CommContactRelatedOrganizationId: string
- InvoiceId: string
- PaymentId: string
- RefundId: string
- MembershipId: string
- InvoicePayUrl: string
- EventSponsorId: string
- Signatures: string
- SupplementaryData: string
- GlobalFlags: string
- TemplateId: string
- IsNotNewsletter: boolean
- EmailBody: string
- EmailTemplate: string
- EmailAttachments: string
- ProjectId: string
- ProjectName: string
- ExcludeAlreadyRegistered: boolean
- ExcludeDeclined: boolean
- ExcludePreviouslyInvited: boolean
- FundraisingCampaignId: string
- Attachment: string
- SendEmailsIndivdiually: boolean
- EngagementContactId: string
- SendActionButtonText: string
- ScheduleActionButtonText: string
Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string"
}
NewsletterPreviewModel: object
- AuditId: integer
- FromEmailAddressId: integer
- FromContactId: string
- Subject: string
- EmailTemplate: string
- EmailRecipients: string
Example
{
"AuditId": "integer",
"FromEmailAddressId": "integer",
"FromContactId": "string",
"Subject": "string",
"EmailTemplate": "string",
"EmailRecipients": "string"
}
CommunicationDraftsCollectionItemModel: object
- Date: string
- Subject: string
- From: string
- CommunicationTypeId: string
- Category: string
- Attachments: string
- Actions: string
- CommunicationId: integer
- TotalRecordAvailable: integer
- DraftCommunicationId: integer
-
Gets or sets property for loading the draft when the load method is called for quick email
- AuditId: integer
- FilesCount: integer
Example
{
"Date": "string",
"Subject": "string",
"From": "string",
"CommunicationTypeId": "string",
"Category": "string",
"Attachments": "string",
"Actions": "string",
"CommunicationId": "integer",
"TotalRecordAvailable": "integer",
"DraftCommunicationId": "integer",
"AuditId": "integer",
"FilesCount": "integer"
}
EmailableEntity: object
- DisplayName: string
- EmailAddress: string
- ContactId: string
- OrganizationId: string
- EmailAddressId: string
- ExtraMergeData: string
- Type: string
- ObjectId: integer
- SubObjectId: string
- ObjectParametersJson: string
- AddrCount: integer
- UniqueKey: string
- SemiUniqueKey: string
- AutoTypeText: string
- BlockUnsubscribeFooter: boolean
Example
{
"DisplayName": "string",
"EmailAddress": "string",
"ContactId": "string",
"OrganizationId": "string",
"EmailAddressId": "string",
"ExtraMergeData": "string",
"Type": "string",
"ObjectId": "integer",
"SubObjectId": "string",
"ObjectParametersJson": "string",
"AddrCount": "integer",
"UniqueKey": "string",
"SemiUniqueKey": "string",
"AutoTypeText": "string",
"BlockUnsubscribeFooter": "boolean"
}
WatcherEntity: object
- WatcherId: integer
- DisplayName: string
- ContactId: string
- EmailAddressId: string
- GroupId: string
- UniqueKey: string
- SemiUniqueKey: string
- AutoTypeText: string
Example
{
"WatcherId": "integer",
"DisplayName": "string",
"ContactId": "string",
"EmailAddressId": "string",
"GroupId": "string",
"UniqueKey": "string",
"SemiUniqueKey": "string",
"AutoTypeText": "string"
}
MergeField: object
- Name: string
- Description: string
- GroupName: string
- Parameters: string
- IsUber: boolean
-
Gets or sets whether the merge field is an "uber" field (i.e. editable HTML).
- HideFromSelection: boolean
Example
{
"Name": "string",
"Description": "string",
"GroupName": "string",
"Parameters": "string",
"IsUber": "boolean",
"HideFromSelection": "boolean"
}
ExpandoObject: object
- System.Collections.Generic.IDictionary<System.String,System.Object>.Keys: string
- System.Collections.Generic.IDictionary<System.String,System.Object>.Values: string
- System.Collections.Generic.IDictionary<System.String,System.Object>.Item: string
- System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String,System.Object>>.Count: integer
- System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String,System.Object>>.IsReadOnly: boolean
Example
{
"System.Collections.Generic.IDictionary<System.String,System.Object>.Keys": "string",
"System.Collections.Generic.IDictionary<System.String,System.Object>.Values": "string",
"System.Collections.Generic.IDictionary<System.String,System.Object>.Item": "string",
"System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String,System.Object>>.Count": "integer",
"System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String,System.Object>>.IsReadOnly": "boolean"
}
EditNotificationSubscriptionModel: object
- ContactId: integer
- Notifications: string
Example
{
"ContactId": "integer",
"Notifications": "string"
}
AddressBookListItemModel: object
- DisplayName: string
- EmailAddress: string
- ContactId: string
- OrganizationId: string
- EmailAddressId: string
- ExtraMergeData: string
- Type: string
- ObjectId: integer
- SubObjectId: string
- ObjectParametersJson: string
- AddrCount: integer
- UniqueKey: string
- SemiUniqueKey: string
- AutoTypeText: string
- BlockUnsubscribeFooter: boolean
- IsSelected: boolean
- PreviouslySelected: boolean
Example
{
"DisplayName": "string",
"EmailAddress": "string",
"ContactId": "string",
"OrganizationId": "string",
"EmailAddressId": "string",
"ExtraMergeData": "string",
"Type": "string",
"ObjectId": "integer",
"SubObjectId": "string",
"ObjectParametersJson": "string",
"AddrCount": "integer",
"UniqueKey": "string",
"SemiUniqueKey": "string",
"AutoTypeText": "string",
"BlockUnsubscribeFooter": "boolean",
"IsSelected": "boolean",
"PreviouslySelected": "boolean"
}
AddressBookListView: object
- ShowGroups: boolean
- ShowCategories: boolean
- ShowTags: boolean
- ShowMembershipTypes: boolean
- ShowMembershipStatus: boolean
- ShowEventRegistrants: boolean
- AddressBookItems: string
Example
{
"ShowGroups": "boolean",
"ShowCategories": "boolean",
"ShowTags": "boolean",
"ShowMembershipTypes": "boolean",
"ShowMembershipStatus": "boolean",
"ShowEventRegistrants": "boolean",
"AddressBookItems": "string"
}
AddEditEmailViewModel: object
- CommunicationId: integer
- AuditId: integer
- IsDeletable: boolean
- CommunicationCategoryId: string
- CommunicationDate: string
- Subject: string
- FromContact: string
- Contacts: string
- Projects: string
- CommunicationTypeId: string
- WebUrl: string
- Body: string
- AuditInfo: string
Example
{
"CommunicationId": "integer",
"AuditId": "integer",
"IsDeletable": "boolean",
"CommunicationCategoryId": "string",
"CommunicationDate": "string",
"Subject": "string",
"FromContact": "string",
"Contacts": "string",
"Projects": "string",
"CommunicationTypeId": "string",
"WebUrl": "string",
"Body": "string",
"AuditInfo": "string"
}
CommunicationCollectionItemModel: object
- CommunicationId: integer
- BatchId: string
- AuditId: integer
- CommunicationStatusTypeId: string
- Date: string
- Subject: string
- Body: string
- TotalRowCount: integer
- RecipientCount: integer
- FirstRecipientName: string
- From: string
- To: string
- CommunicationTypeId: string
- IsEmail: boolean
- IsNote: boolean
- HideNoteDeleteAction: boolean
- Category: string
- SpamScore: string
- SpamScoreOriginTypeId: string
- FilesCount: integer
- Attachments: string
- Actions: string
Example
{
"CommunicationId": "integer",
"BatchId": "string",
"AuditId": "integer",
"CommunicationStatusTypeId": "string",
"Date": "string",
"Subject": "string",
"Body": "string",
"TotalRowCount": "integer",
"RecipientCount": "integer",
"FirstRecipientName": "string",
"From": "string",
"To": "string",
"CommunicationTypeId": "string",
"IsEmail": "boolean",
"IsNote": "boolean",
"HideNoteDeleteAction": "boolean",
"Category": "string",
"SpamScore": "string",
"SpamScoreOriginTypeId": "string",
"FilesCount": "integer",
"Attachments": "string",
"Actions": "string"
}
ContactStatementEmailModel: object
- ContactId: integer
- Balance: number
- HasNoPurchases: boolean
- SpecialNote: string
- FileFormat: string
- DocumentGenerationTemplateId: integer
- DisplayAllActivityEvenIfPaid: boolean
- StatementStartDate: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddress: string
- FromEmailAddressId: integer
- FromContactId: string
- TemplateId: string
- Subject: string
- EmailRecipients: string
- GlobalFlags: string
- Signatures: string
- EmailBody: string
Example
{
"ContactId": "integer",
"Balance": "number",
"HasNoPurchases": "boolean",
"SpecialNote": "string",
"FileFormat": "string",
"DocumentGenerationTemplateId": "integer",
"DisplayAllActivityEvenIfPaid": "boolean",
"StatementStartDate": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "integer",
"FromContactId": "string",
"TemplateId": "string",
"Subject": "string",
"EmailRecipients": "string",
"GlobalFlags": "string",
"Signatures": "string",
"EmailBody": "string"
}
CommunicationPushNotificationModel: object
- Directions: string
- SendToAll: boolean
- Groups: string
- Title: string
- Message: string
- HubType: string
-
if we consolidate notification logic this should allow us to easily tell which hub to send to
Example
{
"Directions": "string",
"SendToAll": "boolean",
"Groups": "string",
"Title": "string",
"Message": "string",
"HubType": "string"
}
EmailDesignerPreviewModel: object
- AuditId: integer
- FromEmailAddressId: integer
- FromContactId: string
- Subject: string
- EmailTemplate: string
- EmailRecipients: string
Example
{
"AuditId": "integer",
"FromEmailAddressId": "integer",
"FromContactId": "string",
"Subject": "string",
"EmailTemplate": "string",
"EmailRecipients": "string"
}
SaveNewEmailDesignerTemplateModel: object
- Subject: string
- EmailTemplate: string
- Name: string
Example
{
"Subject": "string",
"EmailTemplate": "string",
"Name": "string"
}
EmailMemberProfileUpdateModel: object
- AuditId: integer
- IsEventInvite: boolean
- CommunicationId: integer
- EventId: string
- BatchId: string
- CommunicationTypeId: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactRelatedContactId: string
- FromContactId: string
- EmailRecipients: string
- Cc: string
- Bcc: string
- AntiRecipients: string
- Subject: string
- CommunicationCategoryId: string
- DraftCommunicationId: string
- IsNewsletter: boolean
- EmailSendDate: string
- IsAvailableAsWebPage: boolean
- BlockUnsubscribeFooter: boolean
- Stats: string
- ContactId: string
- GroupId: string
- CommContactRelatedOrganizationId: string
- InvoiceId: string
- PaymentId: string
- RefundId: string
- MembershipId: string
- InvoicePayUrl: string
- EventSponsorId: string
- Signatures: string
- SupplementaryData: string
- GlobalFlags: string
- TemplateId: string
- IsNotNewsletter: boolean
- EmailBody: string
- EmailTemplate: string
- EmailAttachments: string
- ProjectId: string
- ProjectName: string
- ExcludeAlreadyRegistered: boolean
- ExcludeDeclined: boolean
- ExcludePreviouslyInvited: boolean
- FundraisingCampaignId: string
- Attachment: string
- SendEmailsIndivdiually: boolean
- EngagementContactId: string
- SendActionButtonText: string
- ScheduleActionButtonText: string
- MembershipType: string
- MembershipContactName: string
- RenewalMonth: string
- CommunicationTemplateType: string
Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"MembershipType": "string",
"MembershipContactName": "string",
"RenewalMonth": "string",
"CommunicationTemplateType": "string"
}
EmailMemberProfileUpdatePreviewModel: object
- AuditId: integer
- IsEventInvite: boolean
- CommunicationId: integer
- EventId: string
- BatchId: string
- CommunicationTypeId: string
- FromAddressError: string
- FromWillBeRewritten: boolean
- FromEmailAddress: string
- FromEmailAddressId: string
- FromContactRelatedContactId: string
- FromContactId: string
- EmailRecipients: string
- Cc: string
- Bcc: string
- AntiRecipients: string
- Subject: string
- CommunicationCategoryId: string
- DraftCommunicationId: string
- IsNewsletter: boolean
- EmailSendDate: string
- IsAvailableAsWebPage: boolean
- BlockUnsubscribeFooter: boolean
- Stats: string
- ContactId: string
- GroupId: string
- CommContactRelatedOrganizationId: string
- InvoiceId: string
- PaymentId: string
- RefundId: string
- MembershipId: string
- InvoicePayUrl: string
- EventSponsorId: string
- Signatures: string
- SupplementaryData: string
- GlobalFlags: string
- TemplateId: string
- IsNotNewsletter: boolean
- EmailBody: string
- EmailTemplate: string
- EmailAttachments: string
- ProjectId: string
- ProjectName: string
- ExcludeAlreadyRegistered: boolean
- ExcludeDeclined: boolean
- ExcludePreviouslyInvited: boolean
- FundraisingCampaignId: string
- Attachment: string
- SendEmailsIndivdiually: boolean
- EngagementContactId: string
- SendActionButtonText: string
- ScheduleActionButtonText: string
- EmailPreviewRecipients: string
- DataSource: string
Example
{
"AuditId": "integer",
"IsEventInvite": "boolean",
"CommunicationId": "integer",
"EventId": "string",
"BatchId": "string",
"CommunicationTypeId": "string",
"FromAddressError": "string",
"FromWillBeRewritten": "boolean",
"FromEmailAddress": "string",
"FromEmailAddressId": "string",
"FromContactRelatedContactId": "string",
"FromContactId": "string",
"EmailRecipients": "string",
"Cc": "string",
"Bcc": "string",
"AntiRecipients": "string",
"Subject": "string",
"CommunicationCategoryId": "string",
"DraftCommunicationId": "string",
"IsNewsletter": "boolean",
"EmailSendDate": "string",
"IsAvailableAsWebPage": "boolean",
"BlockUnsubscribeFooter": "boolean",
"Stats": "string",
"ContactId": "string",
"GroupId": "string",
"CommContactRelatedOrganizationId": "string",
"InvoiceId": "string",
"PaymentId": "string",
"RefundId": "string",
"MembershipId": "string",
"InvoicePayUrl": "string",
"EventSponsorId": "string",
"Signatures": "string",
"SupplementaryData": "string",
"GlobalFlags": "string",
"TemplateId": "string",
"IsNotNewsletter": "boolean",
"EmailBody": "string",
"EmailTemplate": "string",
"EmailAttachments": "string",
"ProjectId": "string",
"ProjectName": "string",
"ExcludeAlreadyRegistered": "boolean",
"ExcludeDeclined": "boolean",
"ExcludePreviouslyInvited": "boolean",
"FundraisingCampaignId": "string",
"Attachment": "string",
"SendEmailsIndivdiually": "boolean",
"EngagementContactId": "string",
"SendActionButtonText": "string",
"ScheduleActionButtonText": "string",
"EmailPreviewRecipients": "string",
"DataSource": "string"
}
DesignTagsModel: object
- LogoUrl: string
- AssociationName: string
- Website: string
- MainPhone: string
- Address: string
- City: string
- State: string
Example
{
"LogoUrl": "string",
"AssociationName": "string",
"Website": "string",
"MainPhone": "string",
"Address": "string",
"City": "string",
"State": "string"
}
GenericLookUpChoice<SystemCommunicationTemplateTypeOption>: object
- Id: string
- Name: string
- ExtraData: string
- CssColor: string
- IsSelected: boolean
- IsDeleted: boolean
- Order: integer
Example
{
"Id": "string",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
BulkUnsubscribeImportResultModel: object
- LineItems: string
- Errors: string
- InvalidRows: string
- IsImportSummaryEmpty: boolean
- ImportSummary: string
- ImportSummaryColumnErrors: string
- ImportSummaryRowErrors: string
Example
{
"LineItems": "string",
"Errors": "string",
"InvalidRows": "string",
"IsImportSummaryEmpty": "boolean",
"ImportSummary": "string",
"ImportSummaryColumnErrors": "string",
"ImportSummaryRowErrors": "string"
}