POST v1/Emails/Send

Send an email document

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DistributionListID	globally unique identifier	None.
DistributionListName	string	None.
DataSourceCategoryID	integer	None.
EntityID	integer	None.
EntityType	string	None.
DocumentID	integer	None.
DocumentName	string	None.
Description	string	None.
EditMode	boolean	None.
CopyMode	boolean	None.
EmailTo	string	None.
EmailFrom	string	None.
UseSystemEmailFrom	boolean	None.
EmailSubject	string	None.
EmailBcc	string	None.
Emailcc	string	None.
EmailBody	string	None.
EmailHeaderValidated	boolean	None.
DistributionListRecipients	Collection of BulkLetterDistributionRecipients	None.
EmailSource	string	None.
TemplateDataSource	string	None.
ReportCategory	DtoReportCategory	None.
CancelUrl	string	None.
LogoUrl	string	None.
SelectedSignatureId	string	None.
SignatureUrl	string	None.
OrderBy	string	None.
SortDirection	string	None.
StandardDistributionList	StandardDistributionListDTO	None.
CustomDistributionListData	CustomDistributionList	None.
TemplateWasSelected	boolean	None.
SelectedTemplate	string	None.
SelectedLocation	integer	None.
TemplateID	globally unique identifier	None.
Template	string	None.
TemplateHasPolicyRelatedFields	boolean	None.
Title	string	None.
Notes	string	None.
DeliveryOpt	string	None.
ShowEmailAttachTab	boolean	None.
CreatedBy	integer	None.
CreatedOn	date	None.
ModifiedOn	date	None.
BlobFileID	integer	None.
IsEmail	boolean	None.
ContactID	integer	None.
PolicyID	integer	None.
ResendEmail	boolean	None.
UseSendGridApi	boolean	None.
EmailEventId	globally unique identifier	None.
CampaignGuid	globally unique identifier	None.
EnableOpenTracking	boolean	None.
EnableClickTracking	boolean	None.
EnableSpamCheck	boolean	None.
InsertEventTracker	boolean	None.
TemplateDocumentDataSource	QQDocumentDataSource	None.
TemplateDocumentMetadata	QQDocumentMetadata	None.
EmailAttachments	Collection of integer	None.
EmailAttachmentsFileNames	Collection of string	None.
EmailAcords	Collection of DocumentSessionAcordData	None.
contextInfo	ContextInfo	None.

Request Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected for property 'ReportCategory' with type 'CommonDbApiContracts.Dto.Report.DtoReportCategory'. Path 'ReportCategory.ReportGroups[0]'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected for property 'ReportCategory' with type 'CommonDbApiContracts.Dto.Report.DtoReportCategory'. Path 'ReportCategory.ReportGroups[0]'.

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[CommonDbApiContracts.Dto.Report.DtoReportGroup, CommonDbApiContracts, Version=1.0.50.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[CommonDbApiContracts.Dto.Report.DtoReportGroup, CommonDbApiContracts, Version=1.0.50.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DocumentSessionData'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.