Field Squared API Services

<back to all web services

DocumentEmailTemplate

Represents the email output configuration for a single document template.

The following routes are available for this service:
GET,POST,DELETE/{Workspace}/DocumentTemplate/{Type}/Email
DocumentEmailTemplate Parameters:
NameParameterData TypeRequiredDescription
TypepathstringNo
WorkspacepathstringNo
EnginebodyEmailOutputEngineNo
FormatbodyEmailOutputFormatNo
PdfTemplatebodystringNo
BodyTemplatebodystringNo
SubjectTemplatebodystringNo
HeaderTemplatebodystringNo
FooterTemplatebodystringNo
PageSizebodystringNo
OrientationbodystringNo
MarginsbodystringNo
EmailOutputEngine Enum:
DefaultHtml
DefaultPdf
Custom
Standard
EmailOutputFormat Enum:
Embed
AttachPdf

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /{Workspace}/DocumentTemplate/{Type}/Email HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Type":"String","Workspace":"String","Engine":"DefaultHtml","Format":"Embed","PdfTemplate":"String","BodyTemplate":"String","SubjectTemplate":"String","HeaderTemplate":"String","FooterTemplate":"String","PageSize":"String","Orientation":"String","Margins":"String"}