Parameter

Example

API version

SessionID*

The session Id obtained from doLogin()

String

7viklshodc6cnsh4s5vu75mqk0

OwnerID

Result code

Int

0 - current user 

ownerOID - see getOwners()

Hash*

File identifier

String

ffc50a5fdd43ff.046772a6b09987aa1

Name

File name

String

SourceName*

Source file name. We allow you to provide a web URL as the source name in order to generate a web captured proof. In addition to this you can supply a set of space character delimited web source names that will automatically be combined into a single proof with multiple pages

String

Proofhq-api.pdf

Subject

File subject

String

Custom subject

Message

Message to reviewers. We accept the following formatting tags within the message: 

<a>        href

<i>         italic

<span>   group inline-elements

<div>      defines a division or a section

<p>        paragraph

<font>    specifying a font

<u>        underline

<br>       new line

String

Email body text inserted here

Deadline (not currently used)

Download deadline

String

2011-09-01 23:59 (YYYY-MM-DD hh:mm)

Recipients

List of recipient email addresses

String

email1@address.com email2@address.com

email1@address.com;email2@address.com

email1@address.com,email2@address.com

WorkspaceId

Workspace identifier

Int

245 - see getWorkspaces()

BatchID

Batch upload identifier (see Creating file shares)

Int

Identifier returned by createBatch()

SWF

When creating a SWF proof, you can specify if this is an application or animation type.See our help for more information.

String

application or animation

SuppressNewFileNotification

Determine if a new file notification email will be sent to the recipient

Boolean

true

false (default)

10.7