BootView WebApi

<back to all web services

CreateEmail

The following routes are available for this service:
POST/emailCreates and new email and, if a Collection Attempt is provided add's a note to the attempt
CreateEmail Parameters:
NameParameterData TypeRequiredDescription
ToEmailAddressbodystringYesThe To email address.
FromEmailbodystringYesThe From email address.
EmailMessagebodystringYesThe email Message.
EmailSubjectbodystringYesThe email Subject.
EmailisHtmlbodyboolNoSet to true if the body of EmailMessage is in HTML format
CollectionAttemptIDbodyGuidNoThe collection attempt ID.
CreateEmailResult Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /email HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateEmail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CollectionAttemptID>00000000-0000-0000-0000-000000000000</CollectionAttemptID>
  <EmailMessage>String</EmailMessage>
  <EmailSubject>String</EmailSubject>
  <EmailisHtml>false</EmailisHtml>
  <FromEmail>String</FromEmail>
  <ToEmailAddress>String</ToEmailAddress>
</CreateEmail>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateEmailResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Success>false</Success>
</CreateEmailResult>