Request parameters

* denotes a required field

Parameter			Example	API version
SessionID*	The session Id obtained from doLogin()	String	7viklshodc6cnsh4s5vu75mqk0
ParentFileID*	Parent proof identifier	Int	280755
OwnerID*	Result code	Int	0 - current user  ownerID - see getOwners()
Hash*	File identifier	String	ffc50a5fdd43ff.046772a6b09987aa1
Name*	Proof 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 OR http://www.myurl1.com http://www.mmyurl2.com
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
Stages	The object identifying the stages for this proof	SOAPWorkflowProofStageRequestObject	See SOAPWorkflowProofStageRequestObject
WorkspaceId	Workspace identifier	Int	245 - see getWorkspaces()
EnableSubscriptions	Allows people who are not participants to subscribe themselves to the proof. See help for more information.  Default taken from the user's personal settings -> proofing defaults	Boolean	true false
EnableSubscriptionsValidation	People subscribing can only access the proof using their personal URL sent in the email. See help for more information.	Boolean	true false
DefaultEmailNotifications	Email notification settings for reviewers. It will not override a user's personal setting or the proof-level setting set by a reviewer. See help for more information.1: All new comments and replies2: Replies to my comments3: Daily summary4: Hourly summary5: Decisions only9: Disabled	String	4
DefaultRole	IfEnableSubscriptionsValidationis turned on, there is a further setting that you can use, which sets the Role for subscribers. Seehelpfor more information on this setting andherefor help on roles.1: Read only3: Reviewer4: Approver5: Reviewer and approver6: Author7: Moderator	String	5
AuthorizedOnly	This is the same as the Login Required function on the new proof page.If used, thenEnableSubscriptionsmust be set tofalse.Seehelpfor more information. Default taken from the user's personal settings -> proofing defaults	Boolean	true false
EnableAutoLock	Locks the proof when all required decisions are made. See help for more information.  Default taken from the user's personal settings -> proofing defaults	Boolean	true false
EnableDownload	Enables download of the source file. Default taken from the user's personal settings -> proofing defaults	Boolean	true false
EnableTeamURL	Hides or shows the team URL. Default taken from the user's personal settings -> proofing defaults	Boolean	true false
EnableEmbedPlayer	Shows or hides the embed viewer URL.	Boolean	true false (default)
ShowDashboardLink	Shows / hides the navigation link to the dashboard in the proof page.	Boolean	true false (default)
ShowWorkspaceLink	Shows / hides the navigation link to the workspace in the proof page.	Boolean	true false (default)
ShowDetailsPageLink	Shows / hides the navigation link to the proof details in the proof page.	Boolean	true false (default)
ShowVersionsLink	Shows / hides the navigation link to the versions window will be displayed in the proof page.	Boolean	true false (default)
ShowHelpLink	Shows / hides the help links in the proof page.	Boolean	true false (default)
ShowHelpQuickStartLink	Shows / hides the Getting started link in the proof page.	Boolean	true false (default)
ShowHelpUserGuideLink	Shows / hides the Knowledgebase link in the proof page.	Boolean	true false (default)
ShowHelpWelcomeScreenLink	Displays or not Getting started popup	Boolean	true false (default)
ShowHelpForumLink	Shows / hides the forum link.	Boolean	true false (default)
ShowHelpBlogLink	Show / hides the blog link.	Boolean	true false (default)
CustomLinkUrl	Allows you to specify a custom URL.	String	http://app.proofhq.com/
CustomLinkLabel	The label for the CustomLinkUrl	String	ProofHQ Home
SuppressNewProofNotification	Determine if a new proof notification email will be sent to the recipient	Boolean	true false (default)
SWF	When creating a SWF proof, you can specify if this is an application or animation type.See our helpfor more information.	String	application or animation
ShowDashboardFunctions	Setting this to false will hide all functions that will navigate the user to the ProofHQ application. This is applicable when proof management is done outside of ProofHQ	Boolean	true false (default)
ShowCloseIcon	Setting this to false will hide the close icon within the proof viewer	Boolean	true (default) false
ShowPublishToTheWeb	Setting this to false will hide the publish to web option within the proof viewer	Boolean	true (default) false
ShowPrintComments	Setting this to false will hide the print comments option within the proof viewer	Boolean	true (default) false
ShowEmailAlertSettings	Setting this to false will hide the email alert settings within the proof viewer	Boolean	true (default) false
CombinedProof	Determines if a single combined proof will be created from all the sources	Boolean	true false (default)
EnableElectronicSignatures	Setting this to true will enable electronic signatures on this proof. If electronic signatures have been enabled on the account then this parameter will be ignored	Boolean	true false (default)
DisableSubscriptionEmail	Determines if the subscription email should be send or not	Boolean	true false (default)	14.5

Response parameters

SOAPWorkflowProofObjectArray: array of SOAPWorkflowProofObject