updateWorkflowProof()

This method allows you to update most of the fields on a automated workflow proof. Any data that should remain unchanged must be populated here otherwise this method will overwrite the existing data.

Since version: 14.4

Unlimited only

Request parameters
* denotes a required field

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
? 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://app.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
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
ShowSendDecisionConfirmationCheckbox Toggle on / off the "Send me an email confirmation of my decision" option in the Proofing tool (ProofViewer) boolean true (default)
 false
SuppressNewOwnerNotification Disables the proof assignment email when re-assigning a proof to a new owner boolean true
 false (default)
14.5


Response parameters
SOAPWorkflowProofObject

Comments