API updates

Upcoming enhancements 

  • new methods for adding contacts

Recent updates

API version 16.24 (release date 18/01/17)

The WSDL can be found here:

  • createWorkspace() and updateWorkspace()
    This method is being extended to include the OwnerID parameter which allow you to assign workspace owner different than workspace creator.

API version 16.23 (release date 07/12/16)

The WSDL can be found here:

  • deleteProof()
    This method is being extended to include the AllVersions parameter which allow you to delete a proof with its all versions

API version 16.22 (release date 23/11/16)

The WSDL can be found here:

  • updateAccount()
    This method is being extended to include the AccountID parameter which allow you to update satellite account details


API version 16.18 (release date 28/09/16)

The WSDL can be found here:


API version 16.13 (release date 13/07/16)

The WSDL can be found here:

  • addUser() and updateUser()
    This method is being extended to include the DefaultEmailNotifications and UpdateExistingProofEmailNotifications parameters which allow you to apply additional notification settings for the user 


API version 16.12 (release date 29/06/16)

The WSDL can be found here:

  • SOAPWorkspaceObject
    This object is being extended to include parent_workspace_id of a given folder


API version 16.7 (release date 20/04/16)

The WSDL can be found here:

Announcement 11/04/2016

  • Old API entry point and WSDL was disabled on 11 April (https://www.proofhq.com/soap and https://www.proofhq.com/soap?wsdl)
    • New API entry point: https://soap.proofhq.com/soap
    • New WSDL: https://soap.proofhq.com/soap?wsdl
  • Old Upload service URL was disabled on 11 April (https://www.proofhq.com/upload.php)
    • New Upload service URL: https://soap.proofhq.com/upload.php
Make sure to update your integration code as from 11 April old links will not work.

Recent updates

API version 16.5 (release date 23/03/16)

The WSDL can be found here:

  • getActivityLog()
    This method will allow to obtain different types of activity logs (proofs and media logs, folders logs, profile logs, account logs, authentication logs, billing logs, email logs)

API version 16.3 (release date 24/02/16)

The WSDL can be found here:


API version 16.1 (release date 07/02/16)

The WSDL can be found here:


API version 15.25 (release date 20/01/16)

The WSDL can be found here:


API version 15.23 (release date 16/12/15)

The WSDL can be found here:

  • SOAPProofStageObject
    This object is being extended to include active parameter to indicate if stage is active or not

API version 15.22 (release date 02/12/15)

The WSDL can be found here:


API version 15.21 (release date 18/11/15)

The WSDL can be found here:


API version 15.20 (release date 04/11/15)

The WSDL can be found here:

  • requestPDFPrintSummary()
    This method is being extended to include the allVersions parameter which allow you to request a PDF summary of all the versions for the given proof

API version 15.18 (release date 08/10/15)

The WSDL can be found here:

  • SOAPUserObject
    This object is being extended to include the api_token parameter which will store the API token for this user

API version 15.17 (release date 23/09/15)

The WSDL can be found here:

  • SOAPFileObject
    This object is being extended to include the sourcename parameter which will store the original file name of the proof even if the proof name is changed
  • getGroups()deleteGroup(), addGroupToProof()
    These methods will allow you to manage Groups using the API e.g. getting all groups, deleting, adding group to the proof

API version 15.16 (release date 09/09/15)

The WSDL can be found here:

API version 15.15 (release date 26/08/15)

The WSDL can be found here:


API version 15.9 (release date 27/05/15)

The WSDL can be found here:

  • requestPDFPrintSummary()
    We are extending the callback to include a "status" indicating if the summary was successfully generated or not

API version 15.6 (release date 15/04/15)

The WSDL can be found here:


API version 15.1 (release date 21/1/15)

The WSDL can be found here:


API version 14.25 (release date 7/1/15)

The WSDL can be found here:


API version 14.19 (release date 15/10/14)

The WSDL can be found here:

  • Callbacks  are extended to include a callback whenever a proof is archived / unarchived
  • Additionally the deleting or trashing proof Callbacks  are extended to include the parent_file_id

API version 14.17 (release date 17/09/14)

The WSDL can be found here:


API version 14.10 (release date 11/06/14)

The WSDL can be found here:

  • getProofCustomData()
    This method will allow you to obtain all the custom field data for a particular proof
  • Callbacks are being extended to include the folder_id and folder_name on comment and reply callbacks

API version 14.9 (release date 28/05/14)

The WSDL can be found here:

  • Callbacks  are being extended to include callback whenever a proof is deleted (trashed or permanent)

API version 14.8 (release date 14/05/14)

The WSDL can be found here:

  • getProofReviewerOneTimeURL()
    This method will allow you to generate a single use obfuscated proofing url that becomes inactive after it was opened or after 24h

API version 14.7 (release date 28/04/14)

The WSDL can be found here:

  • moveWorkspace()
    This method will allow you to move a workspace from one location to another location within the folder tree, allowing integrators to self organise their workspaces
  • createWorkflowTemplateProof()
    This method will allow you to create a proof from a workflow template
  • createWorkflowTemplateProofVersion()
    This method will allow you to create a proof version from a workflow template. Note: If an empty WorkflowTemplateID is provided then use the same template as the previous version
  • SOAPFileObject
    This object is being extended to include the last_decision_change_date parameter

API version 14.6 (release date 15/04/14)

The WSDL can be found here:

  • updateBillingPlan()
    This method is being updated so that it's possible to change plans within your current plan edition only (Standard, Enterprise or Unlimited)

API version 14.5 (release date 01/04/14)

The WSDL can be found here:


API version 14.4 (release date 18/03/14)

The WSDL can be found here:


API version 14.3 (release date 03/03/14)

The WSDL can be found here:

  • getProofJobNumber()
    This method will allow you to obtain Job Number if its active on your account
  • SOAPProofStageObject
    This object is being extended to include the decison, stage_start_date and last_status_change_date for a stage

API version 13.17 (release date 14/01/2014)

The WSDL can be found here:

  • createProof()
    This method is being extended to include a parameter allowing you to create the proof for either the Classic ProofHQ Viewer or using the New ProofHQ Viewer
  • getProofStage() / getProofStages()
    These methods will allow you to obtain the stages on a proof (basic and advanced)
  • SOAPProgressObject
    This object will provide you with the progress information on a proof
  • SOAPProofStageObject
    This object will provide you with the stage information on a proof (basic and advanced)
  • SOAPRecipientObject
    This object is being extended to include the progress and stage objects for a proof
  • SOAPFileObject
    This object is being extended to include stage, workflow and progress information

API version 13.16 (release date 16/12/2013)

The WSDL can be found here:

  • Callbacks are being extended to include the Folder ID and Folder Name
  • shareWorkspace()
    This method is being extended to include the "Role" parameter which determines if the people shared with can create, edit or delete content within the folder

API version 13.15 (release date 02/12/2013)


The WSDL can be found here:


    API version 13.14 (release date 12/11/2013)

    The WSDL can be found here:

    • Pass-through parameter has been added to the "New proof" and "New version" pages
      See Callbacks for more information

    API version 13.11 (release date 02/09/2013)

    The WSDL can be found here:


    API version 13.10 (release date 12/08/2013)

    The WSDL can be found here:


    API version 13.8 (release date 01/07/2013)

    The WSDL can be found here:


    API version 13.7 (release date 10/06/2013)

    The WSDL can be found here:

    • updateProof()
      This method is being extended to include the optional "SuppressNewOwnerNotification", allowing you to suppress the assignment email when re-assigning proof ownership
    • SOAPRecipientObject
      This object is being extended to include the "file_id" parameter

    API version 13.6 (release date 13/05/2013)

    The WSDL can be found here:

    API version 13.5 (release date 22/04/2013)

    The WSDL can be found here:



    API version 13.4 (release date 01/04/2013)

    The WSDL can be found here:

    • createProofVersion()
      this method is being extended to allow the creation of a new proof from multiple source files. (currently only mutiple web sources are available when creating a new version)
    • addProofReviewers()
      this method is being extended with a new parameter "
      SuppressNewProofNotification" which will allow you to suppress new proof notifications when adding reviewers
    • timezone validation
      we now validate the timezones that are provided with the createAccount(), createSatelliteAccount(), addUser() and updateUser() methods. you can find a list of the supported timezones by viewing the details for any of these methods

    API version 13.3 (release date 12/03/2013)

    The WSDL can be found here:

    • setAccountDomain()
      this method will allow you to set the domain or subdomain for an account
    • createDropzoneProof()
      this method will allow you to create a dropzone submitted proof using the api
    • deleteProof()
      this method is being extended to include an optional "permanent" parameter that allows you to permanently delete a proof i.e. remove from trash. currently deleting a proof automatically places it in the trash

    API version 13.2 (release date 18/02/2013)

    The WSDL can be found here:

    • requestPDFPrintSummary()
      method that will allow a user to request a PDF print summary that is returned by calling and passing XML to a given callback URL
    • createProof() / createProofVersion()
      these methods are being extended to allow the creation of web proofs
    • createProofVersion()
      this method is being extended to allow multiple web proofs to be combined into a single proof when creating a new version
       - only available to enterprise customers 
    • createProofs()
      method that allows you to create a single combined proof from multiple sources (files / web proofs etc.) - only available to enterprise customers 


    API version 12.7

    The WSDL can be found here:


    API version 12.5

    The WSDL can be found here:

    API version 12.4

    The WSDL can be found here:


    API version 12.3

    The WSDL can be found here:

    • createProof() / createProofVersion() / updateProof()
      these methods are being extended to include the parameters "ShowCloseIcon",  "ShowPublishToTheWeb",  "ShowPrintComments" and "ShowEmailAlertSettings" which will allow you to hide proof viewer functions

    API version 12.2

    The WSDL can be found here:


    API version 12.1

    The WSDL can be found here:

    • SOAPLoginObject
      this object is being extended to include the "domain" parameter for the user's account
    • updateBillingPlan()
      this method will allow you to upgrade or downgrade an account or satellite account
    • getBillingPlans()
      this method will allow you to obtain all the active plans in the system
    • SOAPCommentObject
      the SOAPCommentObject is being extended to include the "location" parameter for the comment
    • getProofThumbnail()
      this method is being extended to include the optional "type" parameter allowing you to obtain either the large or small thumbnail 
    • addUser() / updateUser()
      these methods will be extended to include an optional "ProductMarketingEmails" parameter that allows the user to opt out from being contacted. additionally, we will introduce an option "APIOnly" parameter that will allow the user to only login via the API
    • SOAPUserObject
      this object is being extended to include the "product_marketing_emails" parameter that indicates if the user opted out from being contacted. additionally, we will introduce an option "api_only" parameter that determines if the user can only login via the API



    Comments