Parameter | Example | Â API version |
SessionID* | The session Id obtained from doLogin() | string | 7viklshodc6cnsh4s5vu75mqk0 | Â |
FileID* | File identifier | integer | ffc50a5fdd43ff.046772a6b09987aa1 | Â |
OwnerID* | Owner identifier | integer | 0 - current user ownerOID - see getOwners() |  |
Name* | Proof name | string |
| Â |
Subject | File subject | string | Custom subject | Â |
Message | Message to reviewers | string | Email body text inserted here | Â |
WorkspaceId | Workspace identifier
| integer | 245 - see getWorkspaces()
| Â |
EnableSubscriptions
| Allows people who are not participants to subscribe themselves to the proof. See help for more information. | 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 replies 2: Replies to my comments 3: Daily summary 4: Hourly summary 5: Decisions only 9: Disabled | string | 4
| Â |
DefaultRole
| If EnableSubscriptionsValidation is turned on, there is a further setting that you can use, which sets the Role for subscribers. See help for more information on this setting and here for help on roles. 1: Read only 3: Reviewer 4: Approver 5: Reviewer and approver 6: Author 7: Moderator | string | 5
| Â |
AuthorizedOnly
| This is the same as the Login Required function on the new proof page.
If used, then EnableSubscriptions must be set tofalse .
See help for more information. | boolean | true false |  |
EnableAutoclose
| Note: EnableAutoLock() in createProof() (field name will be updated in the future) Locks the proof when all required decisions are made. See help for more information.
| boolean | true false | Â |
EnableOneDecision
| Note: LockAfterFirstDecision() in createProof() (field name will be updated in the future) Locks the proof after first decision is made. See help for more information.
| boolean | true false | Â |
EnableDownload
| Enables download of the source file.
| boolean | true false | Â |
EnableTeamURL
| Hides or shows the team URL.
| boolean | true false | Â |
EnableEmbedPlayer
| Shows or hides the embed viewer URL.
| boolean | true false | Â |
ShowDashboardLink
| Shows / hides the navigation link to the dashboard in the proof page. | boolean | true false | Â |
ShowWorkspaceLink
| Shows / hides the navigation link to the workspace in the proof page. | boolean | true false | Â |
ShowDetailsPageLink
| Shows / hides the navigation link to the proof details in the proof page. | boolean | true false | Â |
ShowVersionsLink
| Shows / hides the navigation link to the versions window will be displayed in the proof page.
| boolean | true false | Â |
ShowHelpLink
| Shows / hides the help link in the proof page.
| boolean | true false | Â |
ShowHelpQuickStartLink
| Shows / hides the Getting started link in the proof page. | boolean | true false | Â |
ShowHelpUserGuideLink
| Shows / hides the Knowledgebase link in the proof page. | boolean | true false | Â |
ShowHelpWelcomeScreenLink
| Displays or not Getting started popup | boolean | true false | Â |
ShowHelpForumLink
| Shows / hides the forum link. | boolean | true false | Â |
ShowHelpBlogLink
| Show / hides the blog link. | boolean | true false | Â |
CustomLinkUrl
| Allows you to specify a custom URL. | string | http://www.proofhq.com/ | Â |
CustomLinkLabel
| The label for the CustomLinkUrl | string | ProofHQ Home |  |
SWF
| When creating an SWF proof, you can specify whether this is an application or animation type. See our help for more information. | string | swf-application or swf-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 |  |
PrimaryDecisionMakerReviewerID | The reviewer ID who should be made the Primary Decision Maker. Note only if the reviewer can make decisions (at least Approver) will they be made the Primary Decision Maker. | String | 5555 |  |
 ShowCloseIcon |  Setting this to false will hide the close icon within the proof viewer |  boolean |  true (default)  false |  12.3 |
 ShowPublishToTheWeb |  Setting this to false will hide the publish to web option within the proof viewer |  boolean |  true (default)  false |  12.3 |
 ShowPrintComments |  Setting this to false will hide the print comments option within the proof viewer |  boolean |  true (default)  false |  12.3 |
 ShowEmailAlertSettings |  Setting this to false will hide the email alert settings within the proof viewer |  boolean |  true (default)  false |  12.3 |
 ShowSendDecisionConfirmationCheckbox |  Toggle on / off the "Send me an email confirmation of my decision" option in the Proofing tool (ProofViewer) |  boolean |  true (default)  false |  13.6 |
 SuppressNewOwnerNotification |  Disables the proof assignment email when re-assigning a proof to a new owner |  boolean |  true  false (default) |  13.7 |
 DisableSubscriptionEmail |   Determines if the subscription email should be send or not |  boolean |  |  14.5 |
 ShowProofWorkflow |  Setting this to false will hide the Workflow panel within the ProofHQ Viewer |  boolean |  true (default)  false |  15.1 |
 ShowProofDetails |   Setting this to false will hide the Details panel within the ProofHQ Viewer |  boolean |  true (default)  false |  15.1 |
ReferenceID | Reference id for a proof (it can be any string that could be used to identify a proof) | string | proof789 | 16.17 |