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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /jsv/reply/CreateEmail HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/jsv
Content-Length: length

{
	toEmailAddress: String,
	fromEmail: String,
	emailMessage: String,
	emailSubject: String,
	emailisHtml: False,
	collectionAttemptID: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	success: False
}