> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # ziflow-proofs > Ziflow Proofs - create, search, update, and manage proofs; control review stages and reviewers; export summaries and comments to PDF **Server path:** `/ziflow-proofs` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | | [`ziflow_proofs_delete_id`](#ziflow_proofs_delete_id) | Delete Proof | | [`ziflow_proofs_delete_id_all_versions`](#ziflow_proofs_delete_id_all_versions) | Delete All Proof Versions | | [`ziflow_proofs_delete_proof_id_stages_stage_id_reviewers_reviewer_identifier`](#ziflow_proofs_delete_proof_id_stages_stage_id_reviewers_reviewer_identifier) | Delete Reviewer by ID or email | | [`ziflow_proofs_get_id`](#ziflow_proofs_get_id) | Get Proof by ID | | [`ziflow_proofs_get_id_comments_pdf`](#ziflow_proofs_get_id_comments_pdf) | Export comments to PDF (Webhook Method) | | [`ziflow_proofs_get_id_comments_pdf_request_id`](#ziflow_proofs_get_id_comments_pdf_request_id) | Get status for export comments to PDF | | [`ziflow_proofs_get_id_emails`](#ziflow_proofs_get_id_emails) | Get Emails | | [`ziflow_proofs_get_id_proof_url`](#ziflow_proofs_get_id_proof_url) | Get a Reviewer's Proof URL | | [`ziflow_proofs_get_id_summary_pdf`](#ziflow_proofs_get_id_summary_pdf) | Export summary to PDF (Webhook Method) | | [`ziflow_proofs_get_id_summary_pdf_request_id`](#ziflow_proofs_get_id_summary_pdf_request_id) | Get status for export summary to PDF | | [`ziflow_proofs_get_proof_id_stages_stage_id_reviewers_reviewer_identifier`](#ziflow_proofs_get_proof_id_stages_stage_id_reviewers_reviewer_identifier) | Get Reviewer by ID or email | | [`ziflow_proofs_get_proofs`](#ziflow_proofs_get_proofs) | Get Proofs | | [`ziflow_proofs_get_proofs_by_id_activities`](#ziflow_proofs_get_proofs_by_id_activities) | Get Proof Activities | | [`ziflow_proofs_get_stage_checklist`](#ziflow_proofs_get_stage_checklist) | Get Stage Checklist by ID | | [`ziflow_proofs_mark_checklist_item`](#ziflow_proofs_mark_checklist_item) | Mark Checklist Item | | [`ziflow_proofs_post_id_comments_pdf`](#ziflow_proofs_post_id_comments_pdf) | Export comments to PDF (Endpoint Method) | | [`ziflow_proofs_post_id_integration_properties`](#ziflow_proofs_post_id_integration_properties) | Add Integration Properties | | [`ziflow_proofs_post_id_reviewers_status`](#ziflow_proofs_post_id_reviewers_status) | Make Decision/Complete Review | | [`ziflow_proofs_post_id_summary_pdf`](#ziflow_proofs_post_id_summary_pdf) | Export summary to PDF (Endpoint Method) | | [`ziflow_proofs_post_proof_id_stages_stage_id_reviewers`](#ziflow_proofs_post_proof_id_stages_stage_id_reviewers) | Add Reviewer | | [`ziflow_proofs_post_proofs`](#ziflow_proofs_post_proofs) | Create New Proof | | [`ziflow_proofs_post_proofs_search_activity`](#ziflow_proofs_post_proofs_search_activity) | Search Proofs Activity | | [`ziflow_proofs_post_search`](#ziflow_proofs_post_search) | Search Proofs | | [`ziflow_proofs_post_stage_checklist`](#ziflow_proofs_post_stage_checklist) | Add Checklists to Stage | | [`ziflow_proofs_proof_disconnect_version`](#ziflow_proofs_proof_disconnect_version) | Disconnect proof version | | [`ziflow_proofs_put_id`](#ziflow_proofs_put_id) | Update an Existing Proof | | [`ziflow_proofs_put_id_integration_properties`](#ziflow_proofs_put_id_integration_properties) | Update Integration Properties | | [`ziflow_proofs_put_proof_id_stages_stage_id`](#ziflow_proofs_put_proof_id_stages_stage_id) | Update Stage | | [`ziflow_proofs_put_proof_id_stages_stage_id_final_status_calculation`](#ziflow_proofs_put_proof_id_stages_stage_id_final_status_calculation) | Set Final Status Calculation | | [`ziflow_proofs_put_proof_id_stages_stage_id_reviewers_reviewer_identifier`](#ziflow_proofs_put_proof_id_stages_stage_id_reviewers_reviewer_identifier) | Update Reviewer by ID or email | | [`ziflow_proofs_put_proof_id_stages_stage_id_start`](#ziflow_proofs_put_proof_id_stages_stage_id_start) | Start Stage | *** ## ziflow\_proofs\_delete\_id Delete Proof **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------ | | `id` | string | Yes | — | Proof ID to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Proof ID to delete" } }, "required": [ "PCID", "id" ] } ``` *** ## ziflow\_proofs\_delete\_id\_all\_versions Delete All Proof Versions **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------ | | `id` | string | Yes | — | Proof ID to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Proof ID to delete" } }, "required": [ "PCID", "id" ] } ``` *** ## ziflow\_proofs\_delete\_proof\_id\_stages\_stage\_id\_reviewers\_reviewer\_identifier Delete Reviewer by ID or email **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ------------------------------------------------ | | `proof_id` | string | Yes | — | Proof ID | | `stage_id` | string | Yes | — | Stage ID | | `reviewer_identifier` | string | Yes | — | ID or email of a reviewer on the specified stage | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "proof_id": { "type": "string", "description": "Proof ID" }, "stage_id": { "type": "string", "description": "Stage ID" }, "reviewer_identifier": { "type": "string", "description": "ID or email of a reviewer on the specified stage" } }, "required": [ "PCID", "proof_id", "stage_id", "reviewer_identifier" ] } ``` *** ## ziflow\_proofs\_get\_id Get Proof by ID **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `id` | string | Yes | — | Proof ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Proof ID" } }, "required": [ "PCID", "id" ] } ``` *** ## ziflow\_proofs\_get\_id\_comments\_pdf Export comments to PDF (Webhook Method) **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `id` | string | Yes | — | Proof ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Proof ID" } }, "required": [ "PCID", "id" ] } ``` *** ## ziflow\_proofs\_get\_id\_comments\_pdf\_request\_id Get status for export comments to PDF **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ----------------------------------------------- | | `id` | string | Yes | — | Proof ID | | `request_id` | string | Yes | — | Request ID returned from the PDF export request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Proof ID" }, "request_id": { "type": "string", "description": "Request ID returned from the PDF export request" } }, "required": [ "PCID", "id", "request_id" ] } ``` *** ## ziflow\_proofs\_get\_id\_emails Get Emails **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | -------------------------------------------------- | | `id` | string | Yes | — | Proof ID | | `count` | integer | No | — | Specifies number of records to return with max=100 | | `page` | integer | No | — | Used for pagination, starting at 1 | | `startDate` | string | No | — | The start date for filtering results, inclusive | | `endDate` | string | No | — | The end date for filtering results, inclusive | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Proof ID" }, "count": { "type": "integer", "description": "Specifies number of records to return with max=100" }, "page": { "type": "integer", "description": "Used for pagination, starting at 1" }, "startDate": { "type": "string", "description": "The start date for filtering results, inclusive" }, "endDate": { "type": "string", "description": "The end date for filtering results, inclusive" } }, "required": [ "PCID", "id" ] } ``` *** ## ziflow\_proofs\_get\_id\_proof\_url Get a Reviewer's Proof URL **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | Yes | — | Proof ID | | `oneTimeUrl` | boolean | No | — | If true, a unique URL will be created which can be restricted to either one-time use or time expiration restrictions. | | `expireAfterFirstUse` | boolean | No | — | If true, URL will expire after first use. Overwrites urlExpiration value. | | `urlExpiration` | integer | No | — | URL expiration time in hours. Proper range of values: 1 - 336. | | `email` | string | No | — | Optionally provide the reviewer's email in a \URL encoded\ format, i.e. name%40domain.com. If not provided, the proof URL for the API user is returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Proof ID" }, "oneTimeUrl": { "type": "boolean", "description": "If true, a unique URL will be created which can be restricted to either one-time use or time expiration restrictions." }, "expireAfterFirstUse": { "type": "boolean", "description": "If true, URL will expire after first use. Overwrites urlExpiration value." }, "urlExpiration": { "type": "integer", "description": "URL expiration time in hours. Proper range of values: 1 - 336." }, "email": { "type": "string", "description": "Optionally provide the reviewer's email in a URL encoded format, i.e. name%40domain.com. If not provided, the proof URL for the API user is returned." } }, "required": [ "PCID", "id" ] } ``` *** ## ziflow\_proofs\_get\_id\_summary\_pdf Export summary to PDF (Webhook Method) **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------- | | `id` | string | Yes | — | Proof ID | | `allVersions` | boolean | No | — | Define if you want to export all proof versions or just the specified one | | `markupsThumbnail` | string | No | — | Specifies comment's markups layout in the export | | `stageSummary` | string | No | — | Specifies presence and details of proof workflow on PDF export. "none" removes workflow section from the export. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Proof ID" }, "allVersions": { "type": "boolean", "description": "Define if you want to export all proof versions or just the specified one" }, "markupsThumbnail": { "type": "string", "description": "Specifies comment's markups layout in the export", "enum": [ "small_markup_area", "small_full_page", "big_full_page" ] }, "stageSummary": { "type": "string", "description": "Specifies presence and details of proof workflow on PDF export. \"none\" removes workflow section from the export.", "enum": [ "all", "none" ] } }, "required": [ "PCID", "id" ] } ``` *** ## ziflow\_proofs\_get\_id\_summary\_pdf\_request\_id Get status for export summary to PDF **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ----------------------------------------------- | | `id` | string | Yes | — | Proof ID | | `request_id` | string | Yes | — | Request ID returned from the PDF export request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Proof ID" }, "request_id": { "type": "string", "description": "Request ID returned from the PDF export request" } }, "required": [ "PCID", "id", "request_id" ] } ``` *** ## ziflow\_proofs\_get\_proof\_id\_stages\_stage\_id\_reviewers\_reviewer\_identifier Get Reviewer by ID or email **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ------------------------------------------------ | | `proof_id` | string | Yes | — | Proof ID | | `stage_id` | string | Yes | — | Stage ID | | `reviewer_identifier` | string | Yes | — | ID or email of a reviewer on the specified stage | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "proof_id": { "type": "string", "description": "Proof ID" }, "stage_id": { "type": "string", "description": "Stage ID" }, "reviewer_identifier": { "type": "string", "description": "ID or email of a reviewer on the specified stage" } }, "required": [ "PCID", "proof_id", "stage_id", "reviewer_identifier" ] } ``` *** ## ziflow\_proofs\_get\_proofs Get Proofs **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------------------------------------- | | `count` | integer | No | — | Specifies number of records to return with max=100 | | `page` | integer | No | — | Used for pagination, starting at 1 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "count": { "type": "integer", "description": "Specifies number of records to return with max=100" }, "page": { "type": "integer", "description": "Used for pagination, starting at 1" } }, "required": [ "PCID" ] } ``` *** ## ziflow\_proofs\_get\_proofs\_by\_id\_activities Get Proof Activities **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | -------------------------------------------------- | | `id` | string | Yes | — | Proof ID | | `count` | integer | No | — | Specifies number of records to return with max=100 | | `page` | integer | No | — | Used for pagination, starting at 1 | | `startDate` | string | No | — | The start date for filtering results, inclusive | | `endDate` | string | No | — | The end date for filtering results, inclusive | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Proof ID" }, "count": { "type": "integer", "description": "Specifies number of records to return with max=100" }, "page": { "type": "integer", "description": "Used for pagination, starting at 1" }, "startDate": { "type": "string", "description": "The start date for filtering results, inclusive" }, "endDate": { "type": "string", "description": "The end date for filtering results, inclusive" } }, "required": [ "PCID", "id" ] } ``` *** ## ziflow\_proofs\_get\_stage\_checklist Get Stage Checklist by ID **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ------------ | | `proof_id` | string | Yes | — | Proof ID | | `stage_id` | string | Yes | — | Stage ID | | `checklist_id` | string | Yes | — | Checklist ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "proof_id": { "type": "string", "description": "Proof ID" }, "stage_id": { "type": "string", "description": "Stage ID" }, "checklist_id": { "type": "string", "description": "Checklist ID" } }, "required": [ "PCID", "proof_id", "stage_id", "checklist_id" ] } ``` *** ## ziflow\_proofs\_mark\_checklist\_item Mark Checklist Item **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------ | | `proof_id` | string | Yes | — | Proof ID | | `stage_id` | string | Yes | — | Stage ID | | `checklist_id` | string | Yes | — | ID of the checklist containing the item to be updated | | `item_id` | string | Yes | — | ID of the specific checklist item to be marked/updated | | `value` | string | No | — | Use 'pass' or 'fail' for pass/fail items, 'checked' for simple checkboxes, or null to clear the value. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "proof_id": { "type": "string", "description": "Proof ID" }, "stage_id": { "type": "string", "description": "Stage ID" }, "checklist_id": { "type": "string", "description": "ID of the checklist containing the item to be updated" }, "item_id": { "type": "string", "description": "ID of the specific checklist item to be marked/updated" }, "value": { "type": "string", "description": "Use 'pass' or 'fail' for pass/fail items, 'checked' for simple checkboxes, or null to clear the value.", "enum": [ "pass", "fail", "checked" ] } }, "required": [ "PCID", "proof_id", "stage_id", "checklist_id", "item_id" ] } ``` *** ## ziflow\_proofs\_post\_id\_comments\_pdf Export comments to PDF (Endpoint Method) **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ------------ | | `id` | string | Yes | — | Proof ID | | `response_url` | string | No | — | Response Url | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Proof ID" }, "response_url": { "type": "string", "description": "Response Url" } }, "required": [ "PCID", "id" ] } ``` *** ## ziflow\_proofs\_post\_id\_integration\_properties Add Integration Properties **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ---------------------- | | `id` | string | Yes | — | Proof ID | | `body` | object\[] | Yes | — | Integration Properties | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Proof ID" }, "body": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key value" }, "property_values": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Value can be obtained from [Get app properties](#tag/INTEGRATIONS/paths/~1integrations~1{application}~1property-groups~1{key}~1properties/get)" }, "value": { "type": "string" } } }, "description": "Property Values" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "Secondary Item id" } } }, "description": "Integration Properties" } }, "required": [ "PCID", "id", "body" ] } ``` *** ## ziflow\_proofs\_post\_id\_reviewers\_status Make Decision/Complete Review **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------------------------------------- | | `id` | string | Yes | — | Proof ID | | `completed` | boolean | Yes | — | The completed value | | `decision` | string | Yes | — | The decision value | | `decision_checklist` | object | No | — | Decision Checklist | | `reviewer_id` | string | No | — | Reviewer ID obtained from proof.stages\[].members\[].id field | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Proof ID" }, "completed": { "type": "boolean", "description": "The completed value" }, "decision": { "type": "string", "description": "The decision value", "enum": [ "pending", "changes_required", "approved_with_changes", "approved", "not_relevant" ] }, "decision_checklist": { "type": "object", "description": "Decision Checklist", "properties": { "options": { "type": "array", "items": { "type": "object" }, "description": "The options value" } } }, "reviewer_id": { "type": "string", "description": "Reviewer ID obtained from proof.stages[].members[].id field" } }, "required": [ "PCID", "id", "completed", "decision" ] } ``` *** ## ziflow\_proofs\_post\_id\_summary\_pdf Export summary to PDF (Endpoint Method) **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------- | | `id` | string | Yes | — | Proof ID | | `all_versions` | string | No | — | Export all proof versions | | `markups_thumbnail` | string | No | — | Specifies comment's markups layout in the export | | `response_url` | string | No | — | Response Url | | `stage_summary` | string | No | — | Specifies presence and details of proof workflow on PDF export. "none" removes workflow section from the export. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Proof ID" }, "all_versions": { "type": "string", "description": "Export all proof versions" }, "markups_thumbnail": { "type": "string", "description": "Specifies comment's markups layout in the export", "enum": [ "small_markup_area", "small_full_page", "big_full_page" ] }, "response_url": { "type": "string", "description": "Response Url" }, "stage_summary": { "type": "string", "description": "Specifies presence and details of proof workflow on PDF export. \"none\" removes workflow section from the export.", "enum": [ "all", "none" ] } }, "required": [ "PCID", "id" ] } ``` *** ## ziflow\_proofs\_post\_proof\_id\_stages\_stage\_id\_reviewers Add Reviewer **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `proof_id` | string | Yes | — | Proof ID | | `stage_id` | string | Yes | — | ID of stage in proof to which you want to add reviewer | | `moveReviewers` | boolean | No | — | If true, reviewer will be deleted from previous stage and added to the one specified by stage\_id. If permissions are not defined in request's body, default permissions will be applied | | `body` | object\[] | Yes | — | Member object | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "proof_id": { "type": "string", "description": "Proof ID" }, "stage_id": { "type": "string", "description": "ID of stage in proof to which you want to add reviewer" }, "moveReviewers": { "type": "boolean", "description": "If true, reviewer will be deleted from previous stage and added to the one specified by stage_id. If permissions are not defined in request's body, default permissions will be applied" }, "body": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "The email value" }, "view": { "type": "boolean", "description": "Always true" }, "comment": { "type": "boolean", "description": "The comment value" }, "decision": { "type": "boolean", "description": "The decision value" }, "manage": { "type": "boolean", "description": "The manage value" }, "share": { "type": "boolean", "description": "Allows to give guest reviewers permissions to share the proof. Available only on Enterprise edition" }, "notification": { "type": "string", "enum": [ "all_activity", "replies_to_my_comments", "decisions", "final_decision", "hourly_digest", "daily_digest", "disabled" ], "description": "Default notification \"hourly_digest\" applies only to new users/guests. Other contacts retain their notification settings as default, unless defined otherwise. Default notification can be changed by Admin in account settings." } }, "required": [ "email" ] }, "description": "Member object" } }, "required": [ "PCID", "proof_id", "stage_id", "body" ] } ``` *** ## ziflow\_proofs\_post\_proofs Create New Proof **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------------ | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allow_source_download` | boolean | No | — | Allow Source Download | | `archived` | boolean | No | — | The archived value | | `brief` | object | No | — | The brief value | | `combine` | boolean | No | — | If true, the input sources are combined into one multi-asset proof in the order passed through. Joining different asset types is allowed only on Enterprise edition. On Standard and Pro it's allowed to combine only static files. The Free editions is forced to false | | `custom_properties` | object\[] | No | — | Available only on Enterprise edition. Values and IDs can be obtained from GET/v1/custom-properties/proofs/groups request. | | `email_branding` | object | No | — | Available on Pro and Enterprise editions only | | `folder_id` | string | No | — | Folder ID may be required if set in Account proof settings - available only for admins on Standard, Pro and Enterprise editions. | | `input` | object\[] | Yes | — | The input value | | `lock_on_decisions` | boolean | No | — | Lock On Decisions | | `locked` | boolean | No | — | The locked value | | `merge_files` | string | No | — | Available only on Enterprise edition. When "combine" is set to true and input contains files of different types, this field defines, whether files should be merged into one asset. Field "merge\_files" overrides "merge\_static\_files" if both provided | | `merge_static_files` | boolean | No | — | Use "merge\_files" field. | | `minor_version` | boolean | No | — | Available on Pro and Enterprise editions only. If true, "version" fields will be returned as X.y where X is last major version and y is number of minor version, i.e. 0.1, 2.3, 1.1 | | `name` | string | No | — | The name value | | `owner_email` | string | No | — | You can provide an email of a user who you want to be the proof owner | | `pass_through_value` | string | No | — | Field allowing to attach a value to a proof that is passed back on the proof and webhook events to easily identify the proof in your own system. Field accepts max of 1024 characters. | | `proof_security` | string | No | — | Field describes proof access control settings. If not provided settings are pulled from account settings(on Standard, Pro and Enterprise editions). Value 'users\_and\_guests\_authentication\_required' is available only on Enterprise edition. Field overrides 'secure\_proofing' and 'require\_sign\_in' fields. | | `require_electronic_signature` | boolean | No | — | Available on Enterprise edition only. Enable this setting to request all reviewers to electronically sign their decisions on proof. | | `require_sign_in` | boolean | No | — | Use "proof\_security" field. | | `secure_proofing` | boolean | No | — | Use "proof\_security" field. | | `stages` | object\[] | Yes | — | The stages value | | `subscription` | object | No | — | Available on Standard, Pro and Enterprise editions. | | `suppress_all_emails` | boolean | No | — | If true, Ziflow will not send any emails regarding this proof. The only emails that can be triggered are the emails that are sent when using the 'remind' function within the web application. | | `suppress_creation_email` | boolean | No | — | If true, "New proof created" email will not be sent to proof owner. | | `version_previous_id` | string | No | — | If provided, it will make this proof a new version of the provided proof with given ID. This does require edit/manage permissions on the proof | | `workflow_template` | object | No | — | Available on proofs from Enterprise edition only | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "allow_source_download": { "type": "boolean", "description": "Allow Source Download" }, "archived": { "type": "boolean", "description": "The archived value" }, "brief": { "type": "object", "description": "The brief value", "properties": { "text": { "type": "string", "description": "Text that will be displayed in Brief section. Available on Standard, Pro and Enterprise editions only." } } }, "combine": { "type": "boolean", "description": "If true, the input sources are combined into one multi-asset proof in the order passed through. Joining different asset types is allowed only on Enterprise edition. On Standard and Pro it's allowed to combine only static files. The Free editions is forced to false" }, "custom_properties": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Property Group ID" }, "name": { "type": "string", "description": "Property Group name" }, "properties": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "Property name" }, "value": { "type": "string", "description": "Field used to set value for single-line, multi-line, number and date property types. Date is accepted only in format yyyy-MM-dd. Double numbers must be separated with dot ex. 35.20" }, "value_user": { "type": "object" }, "value_enum": { "type": "array" } } }, "description": "List of properties in the group" } } }, "description": "Available only on Enterprise edition. Values and IDs can be obtained from GET/v1/custom-properties/proofs/groups request." }, "email_branding": { "type": "object", "description": "Available on Pro and Enterprise editions only", "properties": { "custom_button": { "type": "object", "description": "Definition of custom button" }, "hide_open_proof_button": { "type": "boolean", "description": "Hide standard 'Open proof' button in proof's emails" }, "replace_all_proof_urls": { "type": "string", "description": "Provide URL that will replace all links pointing to Ziflow Viewer" } } }, "folder_id": { "type": "string", "description": "Folder ID may be required if set in Account proof settings - available only for admins on Standard, Pro and Enterprise editions." }, "input": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "description": "URL to proof file, can be parametrized. Supported file types ." }, "type": { "type": "string", "enum": [ "file", "web-static", "web-interactive" ], "description": "The type value" }, "nickname": { "type": "string", "description": "Value matching Nickname from AWS Credentials, that should be used to access given file. Credentials should be set in API Account Settings. For more information please see our help section. If you want to use credentials to access your file, please provide URL in format: s3://{bucket-name}/{folder-name}/{file-name}" }, "subtitles": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "description": "URL to subtitles file, can be parametrized. Currently supported file types are *.srt and *.vtt" }, "nickname": { "type": "string", "description": "Optional field. Nickname must be set in Account Settings along with AWS Credentials(Amazon S3 storage) to use when accessing given file. For more information please see our help section. If you want to use credentials to access your file, please provide URL in format: s3://{bucket-name}/{folder-name}/{file-name}" } } }, "description": "Allows to define the source of subtitle file for video proofs( *.vtt or *.srt). Currently only one subtitle file can be submitted." } }, "required": [ "source", "type" ] }, "description": "The input value" }, "lock_on_decisions": { "type": "boolean", "description": "Lock On Decisions" }, "locked": { "type": "boolean", "description": "The locked value" }, "merge_files": { "type": "string", "description": "Available only on Enterprise edition. When \"combine\" is set to true and input contains files of different types, this field defines, whether files should be merged into one asset. Field \"merge_files\" overrides \"merge_static_files\" if both provided", "enum": [ "all", "static_only", "none" ] }, "merge_static_files": { "type": "boolean", "description": "Use \"merge_files\" field." }, "minor_version": { "type": "boolean", "description": "Available on Pro and Enterprise editions only. If true, \"version\" fields will be returned as X.y where X is last major version and y is number of minor version, i.e. 0.1, 2.3, 1.1" }, "name": { "type": "string", "description": "The name value" }, "owner_email": { "type": "string", "description": "You can provide an email of a user who you want to be the proof owner" }, "pass_through_value": { "type": "string", "description": "Field allowing to attach a value to a proof that is passed back on the proof and webhook events to easily identify the proof in your own system. Field accepts max of 1024 characters." }, "proof_security": { "type": "string", "description": "Field describes proof access control settings. If not provided settings are pulled from account settings(on Standard, Pro and Enterprise editions). Value 'users_and_guests_authentication_required' is available only on Enterprise edition. Field overrides 'secure_proofing' and 'require_sign_in' fields.", "enum": [ "users_and_guests_no_authentication", "users_and_guests_authentication_required", "users_only_no_authentication", "users_authentication_required" ] }, "require_electronic_signature": { "type": "boolean", "description": "Available on Enterprise edition only. Enable this setting to request all reviewers to electronically sign their decisions on proof." }, "require_sign_in": { "type": "boolean", "description": "Use \"proof_security\" field." }, "secure_proofing": { "type": "boolean", "description": "Use \"proof_security\" field." }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "final_status_calculation": { "type": "object", "description": "Defines how stage decision status is calculated. \"all_decisions\" - all decisions must be made to calculate the stage status. \"only_one_decision\" - any single decision is enough to calculate the stage status. \"primary_decision_maker\" - selected reviewer's decision will calculate the stage status. \"reviewer_id\" or \"reviewer_email\" must be provided for the \"primary_decision_maker\" option." }, "deadline": { "type": "string", "description": "Date and time in YYYY-MM-DDTHH:mm:ss.SSSZ format i.e.2019-12-15T08:30:00.000Z. Only used if the stage trigger is \"immediately\" or if the stage has started. If the stage is triggered manually or based on another stage, use the \"stage_trigger\" deadline field." }, "only_one_decision": { "type": "boolean", "description": "Only One Decision" }, "status": { "type": "object", "description": "The status value" }, "members": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "view": { "type": "boolean", "description": "Always true" }, "comment": { "type": "boolean" }, "decision": { "type": "boolean" }, "manage": { "type": "boolean" }, "share": { "type": "boolean", "description": "Allows to give guest reviewers permissions to share the proof. Available only on Enterprise edition" }, "notification": { "type": "string", "description": "Default notification \"hourly_digest\" applies only to new users/guests. Other contacts retain their notification settings as default, unless defined otherwise. Default notification can be changed by Admin in account settings." } } }, "description": "The members value" }, "custom_email_subject": { "type": "string", "description": "Not allowed on plans below Enterprise." }, "send_new_proof_email": { "type": "boolean", "description": "Send new proof/new version email to reviewers on Stage" }, "custom_email_message": { "type": "string", "description": "Not allowed on plans below Enterprise." }, "lock": { "type": "object", "description": "Available only on Enterprise edition." }, "skip": { "type": "string", "enum": [ "never", "on_approved_or_approvedwithchanges", "on_approved", "on_completion" ], "description": "Skip condition. Available for proof from Enterprise edition only" }, "checklists": { "type": "array", "items": { "type": "object", "properties": { "checklist_template_id": { "type": "string", "description": "ID of the checklist template to generate a checklist from." } } }, "description": "List of checklist templates to be used for creating checklists in the current stage" }, "stage_trigger": { "type": "object", "description": "Available only on Enterprise edition" }, "allow_private_comments": { "type": "boolean", "description": "Available only on Enterprise edition." }, "allow_public_comments": { "type": "boolean", "description": "Default value forced for all editions except Enterprise." }, "stage_previous_id": { "type": "string", "description": "When creating a new proof version and stage should be skipped, this field should contain ID of a stage from previous version which indicates the skip. Enterprise edition only." } }, "required": [ "members" ] }, "description": "The stages value" }, "subscription": { "type": "object", "description": "Available on Standard, Pro and Enterprise editions.", "properties": { "enabled": { "type": "boolean", "description": "The enabled value" }, "permissions": { "type": "string", "description": "The permissions value", "enum": [ "comment", "comment_decisions" ] }, "added_to_stage": { "type": "string", "description": "Stage to which new subscribers will be added, \"new_proof_subscribers\" value available only on Enterprise edition", "enum": [ "first_stage", "last_stage", "new_proof_subscribers" ] }, "stage_name": { "type": "string", "description": "Stage name for \"new_proof_subscribers\" value" } } }, "suppress_all_emails": { "type": "boolean", "description": "If true, Ziflow will not send any emails regarding this proof. The only emails that can be triggered are the emails that are sent when using the 'remind' function within the web application." }, "suppress_creation_email": { "type": "boolean", "description": "If true, \"New proof created\" email will not be sent to proof owner." }, "version_previous_id": { "type": "string", "description": "If provided, it will make this proof a new version of the provided proof with given ID. This does require edit/manage permissions on the proof" }, "workflow_template": { "type": "object", "description": "Available on proofs from Enterprise edition only", "properties": { "id": { "type": "string", "description": "Available only on Enterprise edition. ID of an active workflow template that should be used to create the proof" } } } }, "required": [ "PCID", "input", "stages" ] } ``` *** ## ziflow\_proofs\_post\_proofs\_search\_activity Search Proofs Activity **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ----------------------------------------------------------- | | `count` | integer | No | — | Specifies number of records to return with max=100 | | `page` | integer | No | — | Used for pagination, starting at 1 | | `end_date` | string | No | — | DateTime in format YYYY-MM-DDTHH:mm:ss.SSSZ in UTC timezone | | `start_date` | string | No | — | DateTime in format YYYY-MM-DDTHH:mm:ss.SSSZ in UTC timezone | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "count": { "type": "integer", "description": "Specifies number of records to return with max=100" }, "page": { "type": "integer", "description": "Used for pagination, starting at 1" }, "end_date": { "type": "string", "description": "DateTime in format YYYY-MM-DDTHH:mm:ss.SSSZ in UTC timezone" }, "start_date": { "type": "string", "description": "DateTime in format YYYY-MM-DDTHH:mm:ss.SSSZ in UTC timezone" } }, "required": [ "PCID" ] } ``` *** ## ziflow\_proofs\_post\_search Search Proofs **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ---------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `count` | integer | No | — | Specifies number of records to return with max=100 | | `page` | integer | No | — | Used for pagination, starting at 1 | | `archived` | boolean\[] | No | — | The archived value | | `custom_properties` | object\[] | No | — | Custom Properties | | `fields` | string | No | — | Optional field - if provided, search response body will contain only specified fields in proof objects matching provided search conditions, so that you can filter proofs and only get specific fields from them. For example, "folder.\*", will return whole folder object; "stages.name" will return stages' names. | | `folder` | object\[] | No | — | Providing null in folder ID field will search for proofs that are not in any folder. | | `integration_properties` | object\[] | No | — | Integration Properties | | `locked` | boolean\[] | No | — | The locked value | | `name` | string\[] | No | — | The name value | | `next_deadline` | string\[] | No | — | Next Deadline | | `owner` | object\[] | No | — | The owner value | | `pass_through_value` | string\[] | No | — | Searching for null, "" or " " will return the same results containing all those values. | | `proof_id` | string\[] | No | — | An array that can be used to search for multiple proofs by their IDs. Limit proof IDs in array = 100. | | `proof_status` | string\[] | No | — | Proof Status | | `reviewer` | object\[] | No | — | The reviewer value | | `stages` | object\[] | No | — | The stages value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "count": { "type": "integer", "description": "Specifies number of records to return with max=100" }, "page": { "type": "integer", "description": "Used for pagination, starting at 1" }, "archived": { "type": "array", "items": { "type": "boolean" }, "description": "The archived value" }, "custom_properties": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Property ID" }, "value": { "type": "string", "description": "Value for single-line, multiline, number, and date property types" }, "value_user": { "type": "object", "description": "User email" }, "value_enum": { "type": "string", "description": "Option ID" } } }, "description": "Custom Properties" }, "fields": { "type": "string", "description": "Optional field - if provided, search response body will contain only specified fields in proof objects matching provided search conditions, so that you can filter proofs and only get specific fields from them. For example, \"folder.*\", will return whole folder object; \"stages.name\" will return stages' names." }, "folder": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Folder ID" }, "include_subfolders": { "type": "boolean", "description": "Optional field. If true, subfolders will be included in search operation." } } }, "description": "Providing null in folder ID field will search for proofs that are not in any folder." }, "integration_properties": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "application item ID" }, "value": { "type": "string", "description": "some text value" } } }, "description": "Integration Properties" }, "locked": { "type": "array", "items": { "type": "boolean" }, "description": "The locked value" }, "name": { "type": "array", "items": { "type": "string" }, "description": "The name value" }, "next_deadline": { "type": "array", "items": { "type": "string" }, "description": "Next Deadline" }, "owner": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "User ID" }, "email": { "type": "string", "description": "User's email" } } }, "description": "The owner value" }, "pass_through_value": { "type": "array", "items": { "type": "string" }, "description": "Searching for null, \"\" or \" \" will return the same results containing all those values." }, "proof_id": { "type": "array", "items": { "type": "string" }, "description": "An array that can be used to search for multiple proofs by their IDs. Limit proof IDs in array = 100." }, "proof_status": { "type": "array", "items": { "type": "string", "enum": [ "in_progress", "any_decision", "late", "failed", "changes_required", "approved", "approved_with_changes", "not_relevant" ] }, "description": "Proof Status" }, "reviewer": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "User ID" }, "email": { "type": "string", "description": "User's email" } } }, "description": "The reviewer value" }, "stages": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "changes_required", "approved_with_changes", "approved", "not_relevant", "in_progress", "completed" ], "description": "Search by stage status." }, "reviewers": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "Reviewer email" }, "decision_status": { "type": "string", "description": "Search by stage reviewer decision status." } } }, "description": "Search by reviewer and his decision status" } } }, "description": "The stages value" } }, "required": [ "PCID" ] } ``` *** ## ziflow\_proofs\_post\_stage\_checklist Add Checklists to Stage **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | --------------------------------------------------- | | `proof_id` | string | Yes | — | Proof ID | | `stage_id` | string | Yes | — | Stage ID | | `body` | object\[] | Yes | — | Array of checklist template IDs to add to the stage | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "proof_id": { "type": "string", "description": "Proof ID" }, "stage_id": { "type": "string", "description": "Stage ID" }, "body": { "type": "array", "items": { "type": "object", "properties": { "checklist_template_id": { "type": "string", "description": "ID of the checklist template to generate a checklist from." } } }, "description": "Array of checklist template IDs to add to the stage" } }, "required": [ "PCID", "proof_id", "stage_id", "body" ] } ``` *** ## ziflow\_proofs\_proof\_disconnect\_version Disconnect proof version **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- | | `id` | string | Yes | — | ID of a proof that will be disconnected or split the proof set. Cannot be the first version of the proof. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "ID of a proof that will be disconnected or split the proof set. Cannot be the first version of the proof." } }, "required": [ "PCID", "id" ] } ``` *** ## ziflow\_proofs\_put\_id Update an Existing Proof **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------------ | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | Yes | — | Proof ID | | `allow_source_download` | boolean | No | — | Allow Source Download | | `archived` | boolean | No | — | The archived value | | `brief` | object | No | — | The brief value | | `custom_properties` | object\[] | No | — | Available only on Enterprise edition. Values and IDs can be obtained from GET/v1/custom-properties/proofs/groups request. | | `email_branding` | object | No | — | Available on Pro and Enterprise editions only | | `folder_id` | string | No | — | Folder ID may be required if set in Account proof settings - available only for admins on Standard, Pro and Enterprise editions. | | `lock_on_decisions` | boolean | No | — | Lock On Decisions | | `locked` | boolean | No | — | The locked value | | `minor_version` | boolean | No | — | Available on Pro and Enterprise editions only. If true, "version" fields will be returned as X.y where X is last major version and y is number of minor version, i.e. 0.1, 2.3, 1.1 | | `name` | string | No | — | The name value | | `owner_email` | string | No | — | You can provide an email of a user who you want to be the proof owner | | `pass_through_value` | string | No | — | Field allowing to attach a value to a proof that is passed back on the proof and webhook events to easily identify the proof in your own system. Field accepts max of 1024 characters. | | `proof_security` | string | No | — | Field describes proof access control settings. If not provided settings are pulled from account settings(on Standard, Pro and Enterprise editions). Value 'users\_and\_guests\_authentication\_required' is available only on Enterprise edition. Field overrides 'secure\_proofing' and 'require\_sign\_in' fields. | | `require_electronic_signature` | boolean | No | — | Available on Enterprise edition only. Enable this setting to request all reviewers to electronically sign their decisions on proof. | | `require_sign_in` | boolean | No | — | Use "proof\_security" field. | | `secure_proofing` | boolean | No | — | Use "proof\_security" field. | | `stages` | object\[] | No | — | The stages value | | `subscription` | object | No | — | Available on Standard, Pro and Enterprise editions. | | `suppress_all_emails` | boolean | No | — | If true, Ziflow will not send any emails regarding this proof. The only emails that can be triggered are the emails that are sent when using the 'remind' function within the web application. | | `suppress_creation_email` | boolean | No | — | If true, "New proof created" email will not be sent to proof owner. | | `version_previous_id` | string | No | — | If provided, it will make this proof a new version of the provided proof with given ID. This does require edit/manage permissions on the proof | | `workflow_template` | object | No | — | Workflow Template | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Proof ID" }, "allow_source_download": { "type": "boolean", "description": "Allow Source Download" }, "archived": { "type": "boolean", "description": "The archived value" }, "brief": { "type": "object", "description": "The brief value", "properties": { "text": { "type": "string", "description": "Text that will be displayed in Brief section. Available on Standard, Pro and Enterprise editions only." } } }, "custom_properties": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Property Group ID" }, "name": { "type": "string", "description": "Property Group name" }, "properties": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "Property name" }, "value": { "type": "string", "description": "Field used to set value for single-line, multi-line, number and date property types. Date is accepted only in format yyyy-MM-dd. Double numbers must be separated with dot ex. 35.20" }, "value_user": { "type": "object" }, "value_enum": { "type": "array" } } }, "description": "List of properties in the group" } } }, "description": "Available only on Enterprise edition. Values and IDs can be obtained from GET/v1/custom-properties/proofs/groups request." }, "email_branding": { "type": "object", "description": "Available on Pro and Enterprise editions only", "properties": { "custom_button": { "type": "object", "description": "Definition of custom button" }, "hide_open_proof_button": { "type": "boolean", "description": "Hide standard 'Open proof' button in proof's emails" }, "replace_all_proof_urls": { "type": "string", "description": "Provide URL that will replace all links pointing to Ziflow Viewer" } } }, "folder_id": { "type": "string", "description": "Folder ID may be required if set in Account proof settings - available only for admins on Standard, Pro and Enterprise editions." }, "lock_on_decisions": { "type": "boolean", "description": "Lock On Decisions" }, "locked": { "type": "boolean", "description": "The locked value" }, "minor_version": { "type": "boolean", "description": "Available on Pro and Enterprise editions only. If true, \"version\" fields will be returned as X.y where X is last major version and y is number of minor version, i.e. 0.1, 2.3, 1.1" }, "name": { "type": "string", "description": "The name value" }, "owner_email": { "type": "string", "description": "You can provide an email of a user who you want to be the proof owner" }, "pass_through_value": { "type": "string", "description": "Field allowing to attach a value to a proof that is passed back on the proof and webhook events to easily identify the proof in your own system. Field accepts max of 1024 characters." }, "proof_security": { "type": "string", "description": "Field describes proof access control settings. If not provided settings are pulled from account settings(on Standard, Pro and Enterprise editions). Value 'users_and_guests_authentication_required' is available only on Enterprise edition. Field overrides 'secure_proofing' and 'require_sign_in' fields.", "enum": [ "users_and_guests_no_authentication", "users_and_guests_authentication_required", "users_only_no_authentication", "users_authentication_required" ] }, "require_electronic_signature": { "type": "boolean", "description": "Available on Enterprise edition only. Enable this setting to request all reviewers to electronically sign their decisions on proof." }, "require_sign_in": { "type": "boolean", "description": "Use \"proof_security\" field." }, "secure_proofing": { "type": "boolean", "description": "Use \"proof_security\" field." }, "stages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Provide ID of every stage you wish to change or leave unchanged - missing stage ID will be deleted." }, "name": { "type": "string", "description": "The name value" }, "deadline": { "type": "string", "description": "Date and time. Only used if the stage trigger is \"immediately\" or if the stage has started. If the stage is triggered manually or based on another stage, use the \"stage_trigger\" deadline field." }, "final_status_calculation": { "type": "object", "description": "Defines how stage decision status is calculated. \"all_decisions\" - all decisions must be made to calculate the stage status. \"only_one_decision\" - any single decision is enough to calculate the stage status. \"primary_decision_maker\" - selected reviewer's decision will calculate the stage status. \"reviewer_id\" or \"reviewer_email\" must be provided for the \"primary_decision_maker\" option." }, "only_one_decision": { "type": "boolean", "description": "Functionality moved to \"final_status_calculation\" field" }, "status": { "type": "object", "description": "The status value" }, "members": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Provide ID of every member you wish to change or leave unchanged - missing stage ID will be deleted." }, "email": { "type": "string" }, "comment": { "type": "boolean" }, "decision": { "type": "boolean" }, "manage": { "type": "boolean" }, "share": { "type": "boolean", "description": "Allows to give guest reviewers permissions to share the proof. Available only on Enterprise edition" }, "notification": { "type": "string", "description": "Default notification \"hourly_digest\" applies only to new users/guests. Other contacts retain their notification settings as default, unless defined otherwise. Default notification can be changed by Admin in account settings." } } }, "description": "The members value" }, "custom_email_subject": { "type": "string", "description": "Not allowed on plans below Enterprise." }, "send_new_proof_email": { "type": "boolean", "description": "Send new proof/new version email to reviewers on Stage" }, "custom_email_message": { "type": "string", "description": "Not allowed on plans below Enterprise." }, "lock": { "type": "object", "description": "The lock value" }, "skip": { "type": "string", "enum": [ "never", "on_approved_or_approvedwithchanges", "on_approved", "on_completion" ], "description": "Skip stage in next version condition. Available for proofs created on Enterprise edition only" }, "checklists": { "type": "array", "items": { "type": "object", "properties": { "checklist_template_id": { "type": "string", "description": "ID of the checklist template to generate a checklist from." } } }, "description": "List of checklist templates to be used for updating checklists in the current stage" }, "stage_trigger": { "type": "object", "description": "Stage Trigger" }, "allow_private_comments": { "type": "boolean", "description": "Available only on Enterprise edition." }, "allow_public_comments": { "type": "boolean", "description": "Default value forced for all editions except Enterprise." } }, "required": [ "id", "members" ] }, "description": "The stages value" }, "subscription": { "type": "object", "description": "Available on Standard, Pro and Enterprise editions.", "properties": { "enabled": { "type": "boolean", "description": "The enabled value" }, "permissions": { "type": "string", "description": "The permissions value", "enum": [ "comment", "comment_decisions" ] }, "added_to_stage": { "type": "string", "description": "Stage to which new subscribers will be added, \"new_proof_subscribers\" value available only on Enterprise edition", "enum": [ "first_stage", "last_stage", "new_proof_subscribers" ] }, "stage_name": { "type": "string", "description": "Stage name for \"new_proof_subscribers\" value" } } }, "suppress_all_emails": { "type": "boolean", "description": "If true, Ziflow will not send any emails regarding this proof. The only emails that can be triggered are the emails that are sent when using the 'remind' function within the web application." }, "suppress_creation_email": { "type": "boolean", "description": "If true, \"New proof created\" email will not be sent to proof owner." }, "version_previous_id": { "type": "string", "description": "If provided, it will make this proof a new version of the provided proof with given ID. This does require edit/manage permissions on the proof" }, "workflow_template": { "description": "Workflow Template" } }, "required": [ "PCID", "id" ] } ``` *** ## ziflow\_proofs\_put\_id\_integration\_properties Update Integration Properties **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------ | | `id` | string | Yes | — | Proof ID | | `body` | any\[] | Yes | — | List of Integration Properties | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Proof ID" }, "body": { "type": "array", "description": "List of Integration Properties" } }, "required": [ "PCID", "id", "body" ] } ``` *** ## ziflow\_proofs\_put\_proof\_id\_stages\_stage\_id Update Stage **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `proof_id` | string | Yes | — | Proof ID | | `stage_id` | string | Yes | — | Stage ID | | `allow_private_comments` | boolean | No | — | Available only on Enterprise edition. | | `allow_public_comments` | boolean | No | — | Default value forced for all editions except Enterprise. | | `checklists` | object\[] | No | — | List of checklist templates to be used for updating checklists in the current stage | | `custom_email_message` | string | No | — | Not allowed on plans below Enterprise. | | `custom_email_subject` | string | No | — | Not allowed on plans below Enterprise. | | `deadline` | string | No | — | Date and time. Only used if the stage trigger is "immediately" or if the stage has started. If the stage is triggered manually or based on another stage, use the "stage\_trigger" deadline field. | | `final_status_calculation` | object | No | — | Defines how stage decision status is calculated. "all\_decisions" - all decisions must be made to calculate the stage status. "only\_one\_decision" - any single decision is enough to calculate the stage status. "primary\_decision\_maker" - selected reviewer's decision will calculate the stage status. "reviewer\_id" or "reviewer\_email" must be provided for the "primary\_decision\_maker" option. | | `id` | string | Yes | — | Provide ID of every stage you wish to change or leave unchanged - missing stage ID will be deleted. | | `lock` | object | No | — | The lock value | | `members` | object\[] | Yes | — | The members value | | `name` | string | No | — | The name value | | `only_one_decision` | boolean | No | — | Functionality moved to "final\_status\_calculation" field | | `send_new_proof_email` | boolean | No | — | Send new proof/new version email to reviewers on Stage | | `skip` | string | No | — | Skip stage in next version condition. Available for proofs created on Enterprise edition only | | `stage_trigger` | object | No | — | Stage Trigger | | `status` | object | No | — | The status value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "proof_id": { "type": "string", "description": "Proof ID" }, "stage_id": { "type": "string", "description": "Stage ID" }, "allow_private_comments": { "type": "boolean", "description": "Available only on Enterprise edition." }, "allow_public_comments": { "type": "boolean", "description": "Default value forced for all editions except Enterprise." }, "checklists": { "type": "array", "items": { "type": "object", "properties": { "checklist_template_id": { "type": "string", "description": "ID of the checklist template to generate a checklist from." } } }, "description": "List of checklist templates to be used for updating checklists in the current stage" }, "custom_email_message": { "type": "string", "description": "Not allowed on plans below Enterprise." }, "custom_email_subject": { "type": "string", "description": "Not allowed on plans below Enterprise." }, "deadline": { "type": "string", "description": "Date and time. Only used if the stage trigger is \"immediately\" or if the stage has started. If the stage is triggered manually or based on another stage, use the \"stage_trigger\" deadline field." }, "final_status_calculation": { "type": "object", "description": "Defines how stage decision status is calculated. \"all_decisions\" - all decisions must be made to calculate the stage status. \"only_one_decision\" - any single decision is enough to calculate the stage status. \"primary_decision_maker\" - selected reviewer's decision will calculate the stage status. \"reviewer_id\" or \"reviewer_email\" must be provided for the \"primary_decision_maker\" option.", "properties": { "reviewer_id": { "type": "string", "description": "Reviewer ID obtained from proof.stages[].members[].id field" }, "reviewer_email": { "type": "string", "description": "If type \"primary_decision_maker\" defines the reviewer, who's decision will decide on stage status" }, "type": { "type": "string", "description": "\"primary_decision_maker\" option is available on Enterprise edition only", "enum": [ "all_decisions", "only_one_decision", "primary_decision_maker" ] } } }, "id": { "type": "string", "description": "Provide ID of every stage you wish to change or leave unchanged - missing stage ID will be deleted." }, "lock": { "type": "object", "description": "The lock value", "properties": { "type": { "type": "string", "description": "When null, then it's set to \"Never\"", "enum": [ "manual", "on_completion", "all_dependent_stages_started", "next_stage_starts", "on_deadline" ] }, "next_stage_name": { "type": "string", "description": "Next Stage Name" }, "next_stage_id": { "type": "string", "description": "Next Stage Id" } } }, "members": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Provide ID of every member you wish to change or leave unchanged - missing stage ID will be deleted." }, "email": { "type": "string", "description": "The email value" }, "comment": { "type": "boolean", "description": "The comment value" }, "decision": { "type": "boolean", "description": "The decision value" }, "manage": { "type": "boolean", "description": "The manage value" }, "share": { "type": "boolean", "description": "Allows to give guest reviewers permissions to share the proof. Available only on Enterprise edition" }, "notification": { "type": "string", "enum": [ "all_activity", "replies_to_my_comments", "decisions", "final_decision", "hourly_digest", "daily_digest", "disabled" ], "description": "Default notification \"hourly_digest\" applies only to new users/guests. Other contacts retain their notification settings as default, unless defined otherwise. Default notification can be changed by Admin in account settings." } } }, "description": "The members value" }, "name": { "type": "string", "description": "The name value" }, "only_one_decision": { "type": "boolean", "description": "Functionality moved to \"final_status_calculation\" field" }, "send_new_proof_email": { "type": "boolean", "description": "Send new proof/new version email to reviewers on Stage" }, "skip": { "type": "string", "description": "Skip stage in next version condition. Available for proofs created on Enterprise edition only", "enum": [ "never", "on_approved_or_approvedwithchanges", "on_approved", "on_completion" ] }, "stage_trigger": { "type": "object", "description": "Stage Trigger", "properties": { "trigger_id": { "type": "string", "description": "Trigger Id" }, "trigger": { "type": "object", "description": "The trigger value" }, "deadline": { "type": "object", "description": "Available on Enterprise edition only. Object can be successfully set during POST/proofs or PUT/proofs requests only for stages which are \"not_started\" (\"stage_trigger\" type is different than \"immediately\"). On stage start, deadline will be calculated and set in \"deadline\" field where it can be later modified if needed. Updating this object on \"in_progress\" or \"completed\" stage will be ignored." } } }, "status": { "type": "object", "description": "The status value", "properties": { "locked": { "type": "boolean", "description": "Stage lock can be set on Enterprise edition only." } } } }, "required": [ "PCID", "proof_id", "stage_id", "id", "members" ] } ``` *** ## ziflow\_proofs\_put\_proof\_id\_stages\_stage\_id\_final\_status\_calculation Set Final Status Calculation **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------- | | `proof_id` | string | Yes | — | Proof ID | | `stage_id` | string | Yes | — | Stage ID | | `reviewer_email` | string | No | — | If type "primary\_decision\_maker" defines the reviewer, who's decision will decide on stage status | | `reviewer_id` | string | No | — | Reviewer ID obtained from proof.stages\[].members\[].id field | | `type` | string | No | — | "primary\_decision\_maker" option is available on Enterprise edition only | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "proof_id": { "type": "string", "description": "Proof ID" }, "stage_id": { "type": "string", "description": "Stage ID" }, "reviewer_email": { "type": "string", "description": "If type \"primary_decision_maker\" defines the reviewer, who's decision will decide on stage status" }, "reviewer_id": { "type": "string", "description": "Reviewer ID obtained from proof.stages[].members[].id field" }, "type": { "type": "string", "description": "\"primary_decision_maker\" option is available on Enterprise edition only", "enum": [ "all_decisions", "only_one_decision", "primary_decision_maker" ] } }, "required": [ "PCID", "proof_id", "stage_id" ] } ``` *** ## ziflow\_proofs\_put\_proof\_id\_stages\_stage\_id\_reviewers\_reviewer\_identifier Update Reviewer by ID or email **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `proof_id` | string | Yes | — | Proof ID | | `stage_id` | string | Yes | — | Stage ID | | `reviewer_identifier` | string | Yes | — | ID or email of a reviewer on the specified stage | | `comment` | boolean | No | — | Comment permission is updated only on the stage defined by stage\_id provided in the request url path parameter. | | `decision` | boolean | No | — | Decision permission is updated only on the stage defined by stage\_id provided in the request url path parameter. | | `manage` | boolean | No | — | Manage permission is updated on all stages reviewer is on. | | `notification` | string | No | — | Default notification "hourly\_digest" applies only to new users/guests. Other contacts retain their notification settings as default, unless defined otherwise. Default notification can be changed by Admin in account settings. | | `share` | boolean | No | — | Share permission is updated on all stages reviewer is on. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "proof_id": { "type": "string", "description": "Proof ID" }, "stage_id": { "type": "string", "description": "Stage ID" }, "reviewer_identifier": { "type": "string", "description": "ID or email of a reviewer on the specified stage" }, "comment": { "type": "boolean", "description": "Comment permission is updated only on the stage defined by stage_id provided in the request url path parameter." }, "decision": { "type": "boolean", "description": "Decision permission is updated only on the stage defined by stage_id provided in the request url path parameter." }, "manage": { "type": "boolean", "description": "Manage permission is updated on all stages reviewer is on." }, "notification": { "type": "string", "description": "Default notification \"hourly_digest\" applies only to new users/guests. Other contacts retain their notification settings as default, unless defined otherwise. Default notification can be changed by Admin in account settings.", "enum": [ "all_activity", "replies_to_my_comments", "decisions", "final_decision", "hourly_digest", "daily_digest", "disabled" ] }, "share": { "type": "boolean", "description": "Share permission is updated on all stages reviewer is on." } }, "required": [ "PCID", "proof_id", "stage_id", "reviewer_identifier" ] } ``` *** ## ziflow\_proofs\_put\_proof\_id\_stages\_stage\_id\_start Start Stage **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------- | | `proof_id` | string | Yes | — | Proof ID | | `stage_id` | string | Yes | — | Stage ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "proof_id": { "type": "string", "description": "Proof ID" }, "stage_id": { "type": "string", "description": "Stage ID" } }, "required": [ "PCID", "proof_id", "stage_id" ] } ```