ziflow-collaboration

Ziflow Collaboration - manage proof comments, comment labels, decision checklists, and decision reasons for the review process

Server path: /ziflow-collaboration | Type: Application | PCID required: Yes

Tools

Tool	Description
ziflow_collaboration_delete_checklist_template	Delete checklist by ID
ziflow_collaboration_delete_comment_labels_label_id	Delete label
ziflow_collaboration_delete_decision_reasons_options_option_id	Delete option
ziflow_collaboration_get_checklist_template	Get Checklist by ID
ziflow_collaboration_get_checklist_templates_list	Get Checklist templates
ziflow_collaboration_get_comment_labels	Get labels
ziflow_collaboration_get_comment_labels_label_id	Get label by ID
ziflow_collaboration_get_decision_reasons	Get reasons
ziflow_collaboration_get_decision_reasons_options_option_id	Get option
ziflow_collaboration_get_proofs_id_comments	Get comments
ziflow_collaboration_get_proofs_id_comments_comment_id	Get comment by ID
ziflow_collaboration_post_checklist_template	Create new checklist template
ziflow_collaboration_post_comment_labels	Add label
ziflow_collaboration_post_decision_reasons_options	Add reasons option
ziflow_collaboration_post_proofs_id_comments	Add comment
ziflow_collaboration_post_proofs_id_comments_comment_id_like	Like comment
ziflow_collaboration_put_comment_labels_label_id	Update an existing label
ziflow_collaboration_put_decision_reasons	Update reasons settings
ziflow_collaboration_put_decision_reasons_options_option_id	Update an existing option
ziflow_collaboration_put_proofs_id_comments_comment_id_labels	Label comment
ziflow_collaboration_put_proofs_id_comments_comment_id_reactions	Add comment reactions
ziflow_collaboration_put_proofs_id_comments_comment_id_resolve	Resolve comment
ziflow-collaboration_put_checklist_template	Update checklist by ID

---

ziflow_collaboration_delete_checklist_template

Delete checklist by ID

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Checklist template ID to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Checklist template ID to delete"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ziflow_collaboration_delete_comment_labels_label_id

Delete label

Parameters:

Parameter	Type	Required	Default	Description
label_id	string	Yes	—	Label ID to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "label_id": {
      "type": "string",
      "description": "Label ID to delete"
    }
  },
  "required": [
    "PCID",
    "label_id"
  ]
}

---

ziflow_collaboration_delete_decision_reasons_options_option_id

Delete option

Parameters:

Parameter	Type	Required	Default	Description
option_id	string	Yes	—	Option ID to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "option_id": {
      "type": "string",
      "description": "Option ID to delete"
    }
  },
  "required": [
    "PCID",
    "option_id"
  ]
}

---

ziflow_collaboration_get_checklist_template

Get Checklist by ID

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Checklist Template ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Checklist Template ID"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ziflow_collaboration_get_checklist_templates_list

Get Checklist templates

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

Show inputSchema

{
  "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_collaboration_get_comment_labels

Get labels

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

ziflow_collaboration_get_comment_labels_label_id

Get label by ID

Parameters:

Parameter	Type	Required	Default	Description
label_id	string	Yes	—	Label ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "label_id": {
      "type": "string",
      "description": "Label ID"
    }
  },
  "required": [
    "PCID",
    "label_id"
  ]
}

---

ziflow_collaboration_get_decision_reasons

Get reasons

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

ziflow_collaboration_get_decision_reasons_options_option_id

Get option

Parameters:

Parameter	Type	Required	Default	Description
option_id	string	Yes	—	Option ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "option_id": {
      "type": "string",
      "description": "Option ID"
    }
  },
  "required": [
    "PCID",
    "option_id"
  ]
}

---

ziflow_collaboration_get_proofs_id_comments

Get comments

Parameters:

Parameter	Type	Required	Default	Description
format	string	No	—	Param defining comment text formatting.
id	string	Yes	—	Proof ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "format": {
      "type": "string",
      "description": "Param defining comment text formatting.",
      "enum": [
        "ziflow",
        "simple"
      ]
    },
    "id": {
      "type": "string",
      "description": "Proof ID"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

ziflow_collaboration_get_proofs_id_comments_comment_id

Get comment by ID

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Proof ID
comment_id	string	Yes	—	Comment ID
format	string	No	—	Param defining comment text formatting.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Proof ID"
    },
    "comment_id": {
      "type": "string",
      "description": "Comment ID"
    },
    "format": {
      "type": "string",
      "description": "Param defining comment text formatting.",
      "enum": [
        "ziflow",
        "simple"
      ]
    }
  },
  "required": [
    "PCID",
    "id",
    "comment_id"
  ]
}

---

ziflow_collaboration_post_checklist_template

Create new checklist template

Parameters:

Parameter	Type	Required	Default	Description
body	object	Yes	—	Checklist template object

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "body": {
      "description": "Checklist template object"
    }
  },
  "required": [
    "PCID",
    "body"
  ]
}

---

ziflow_collaboration_post_comment_labels

Add label

Parameters:

Parameter	Type	Required	Default	Description
active	boolean	No	—	The active value
label	string	Yes	—	Label name
order	integer	No	—	The order in which the label is displayed.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "active": {
      "type": "boolean",
      "description": "The active value"
    },
    "label": {
      "type": "string",
      "description": "Label name"
    },
    "order": {
      "type": "integer",
      "description": "The order in which the label is displayed."
    }
  },
  "required": [
    "PCID",
    "label"
  ]
}

---

ziflow_collaboration_post_decision_reasons_options

Add reasons option

Parameters:

Parameter	Type	Required	Default	Description
label	string	No	—	The label value
order	integer	No	—	The order value
text_field_available	boolean	No	—	Text Field Available

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "label": {
      "type": "string",
      "description": "The label value"
    },
    "order": {
      "type": "integer",
      "description": "The order value"
    },
    "text_field_available": {
      "type": "boolean",
      "description": "Text Field Available"
    }
  },
  "required": [
    "PCID"
  ]
}

---

ziflow_collaboration_post_proofs_id_comments

Add comment

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Proof ID
checklist_items	object[]	No	—	checklist item to be linked with comment
comment	string	Yes	—	A Reviewer on the proof can be mentioned in the comment using ${reviewer:reviewer_id}. Field accepts max of 10000 characters.
labels	string[]	No	—	IDs of labels
location	object	Yes	—	For static, rich media and live website proof provide page number, for audio and video - start time
markers	object[]	No	—	The markers value
parent_comment_id	string	No	—	Parent Comment Id
private	boolean	No	—	Available only on Enterprise edition
proof_id	string	No	—	Proof Id
resolved	boolean	No	—	If true, the comment is added and immediately resolved and locked. Available on the Pro and Enterprise editions.
reviewer	object	No	—	The reviewer value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Proof ID"
    },
    "checklist_items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "checklist_id": {
            "type": "string",
            "description": "ID of the checklist containing the item to be linked with comment"
          },
          "checklist_item_id": {
            "type": "string",
            "description": "ID of the checklist item to be linked with comment"
          }
        }
      },
      "description": "checklist item to be linked with comment"
    },
    "comment": {
      "type": "string",
      "description": "A Reviewer on the proof can be mentioned in the comment using ${reviewer:reviewer_id}. Field accepts max of 10000 characters."
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "IDs of labels"
    },
    "location": {
      "type": "object",
      "description": "For static, rich media and live website proof provide page number, for audio and video - start time",
      "properties": {
        "page": {
          "type": "integer",
          "description": "Page number for pagination"
        },
        "start_time": {
          "type": "string",
          "description": "Time in format HH:mm:ss.SSS"
        },
        "end_time": {
          "type": "string",
          "description": "Time in format HH:mm:ss.SSS"
        },
        "asset_id": {
          "type": "string",
          "description": "Asset Id"
        }
      }
    },
    "markers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "rectangle",
              "ellipse",
              "line",
              "arrow"
            ],
            "description": "The type value"
          },
          "color": {
            "type": "string",
            "description": "Color in HEX format"
          },
          "start_point": {
            "type": "object",
            "description": "Start Point"
          },
          "end_point": {
            "type": "object",
            "description": "End Point"
          }
        }
      },
      "description": "The markers value"
    },
    "parent_comment_id": {
      "type": "string",
      "description": "Parent Comment Id"
    },
    "private": {
      "type": "boolean",
      "description": "Available only on Enterprise edition"
    },
    "proof_id": {
      "type": "string",
      "description": "Proof Id"
    },
    "resolved": {
      "type": "boolean",
      "description": "If true, the comment is added and immediately resolved and locked. Available on the Pro and Enterprise editions."
    },
    "reviewer": {
      "type": "object",
      "description": "The reviewer value",
      "properties": {
        "reviewer_id": {
          "type": "string",
          "description": "Reviewer ID obtained from proof.stages[].members[].id field"
        },
        "email": {
          "type": "string",
          "description": "The email value"
        }
      }
    }
  },
  "required": [
    "PCID",
    "id",
    "comment",
    "location"
  ]
}

---

ziflow_collaboration_post_proofs_id_comments_comment_id_like

Like comment

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Proof ID
comment_id	string	Yes	—	Comment ID
like	boolean	Yes	—	The like value
reviewer_id	string	No	—	Reviewer ID obtained from proof.stages[].members[].id field

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Proof ID"
    },
    "comment_id": {
      "type": "string",
      "description": "Comment ID"
    },
    "like": {
      "type": "boolean",
      "description": "The like value"
    },
    "reviewer_id": {
      "type": "string",
      "description": "Reviewer ID obtained from proof.stages[].members[].id field"
    }
  },
  "required": [
    "PCID",
    "id",
    "comment_id",
    "like"
  ]
}

---

ziflow_collaboration_put_comment_labels_label_id

Update an existing label

Parameters:

Parameter	Type	Required	Default	Description
label_id	string	Yes	—	Label ID
active	boolean	No	—	The active value
id	string	No	—	The id value
label	string	No	—	The label value
order	integer	No	—	The order value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "label_id": {
      "type": "string",
      "description": "Label ID"
    },
    "active": {
      "type": "boolean",
      "description": "The active value"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "label": {
      "type": "string",
      "description": "The label value"
    },
    "order": {
      "type": "integer",
      "description": "The order value"
    }
  },
  "required": [
    "PCID",
    "label_id"
  ]
}

---

ziflow_collaboration_put_decision_reasons

Update reasons settings

Parameters:

Parameter	Type	Required	Default	Description
display_text	string	No	—	Display Text
mandatory	boolean	No	—	The mandatory value
multiple_selection	boolean	No	—	Multiple Selection

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "display_text": {
      "type": "string",
      "description": "Display Text"
    },
    "mandatory": {
      "type": "boolean",
      "description": "The mandatory value"
    },
    "multiple_selection": {
      "type": "boolean",
      "description": "Multiple Selection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

ziflow_collaboration_put_decision_reasons_options_option_id

Update an existing option

Parameters:

Parameter	Type	Required	Default	Description
option_id	string	Yes	—	Option ID
label	string	No	—	The label value
order	integer	No	—	The order value
text_field_available	boolean	No	—	Text Field Available

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "option_id": {
      "type": "string",
      "description": "Option ID"
    },
    "label": {
      "type": "string",
      "description": "The label value"
    },
    "order": {
      "type": "integer",
      "description": "The order value"
    },
    "text_field_available": {
      "type": "boolean",
      "description": "Text Field Available"
    }
  },
  "required": [
    "PCID",
    "option_id"
  ]
}

---

ziflow_collaboration_put_proofs_id_comments_comment_id_labels

Label comment

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Proof ID
comment_id	string	Yes	—	Comment ID
ids	string[]	Yes	—	The ids value
reviewer_id	string	No	—	Reviewer ID obtained from proof.stages[].members[].id field

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Proof ID"
    },
    "comment_id": {
      "type": "string",
      "description": "Comment ID"
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The ids value"
    },
    "reviewer_id": {
      "type": "string",
      "description": "Reviewer ID obtained from proof.stages[].members[].id field"
    }
  },
  "required": [
    "PCID",
    "id",
    "comment_id",
    "ids"
  ]
}

---

ziflow_collaboration_put_proofs_id_comments_comment_id_reactions

Add comment reactions

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Proof ID
comment_id	string	Yes	—	Comment ID
reviewer_id	string	No	—	Reviewer ID obtained from proof.stages[].members[].id field
status	boolean	No	—	The status value
type	string	Yes	—	The type value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Proof ID"
    },
    "comment_id": {
      "type": "string",
      "description": "Comment ID"
    },
    "reviewer_id": {
      "type": "string",
      "description": "Reviewer ID obtained from proof.stages[].members[].id field"
    },
    "status": {
      "type": "boolean",
      "description": "The status value"
    },
    "type": {
      "type": "string",
      "description": "The type value",
      "enum": [
        "like",
        "insightful",
        "verified",
        "rejected"
      ]
    }
  },
  "required": [
    "PCID",
    "id",
    "comment_id",
    "type"
  ]
}

---

ziflow_collaboration_put_proofs_id_comments_comment_id_resolve

Resolve comment

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Proof ID
comment_id	string	Yes	—	Comment ID
reviewer_id	string	No	—	Reviewer ID obtained from proof.stages[].members[].id field
type	string	Yes	—	The type value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Proof ID"
    },
    "comment_id": {
      "type": "string",
      "description": "Comment ID"
    },
    "reviewer_id": {
      "type": "string",
      "description": "Reviewer ID obtained from proof.stages[].members[].id field"
    },
    "type": {
      "type": "string",
      "description": "The type value",
      "enum": [
        "resolved",
        "unresolved"
      ]
    }
  },
  "required": [
    "PCID",
    "id",
    "comment_id",
    "type"
  ]
}

---

ziflow-collaboration_put_checklist_template

Update checklist by ID

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Checklist template ID to update
body	object	Yes	—	Checklist template object

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Checklist template ID to update"
    },
    "body": {
      "description": "Checklist template object"
    }
  },
  "required": [
    "PCID",
    "id",
    "body"
  ]
}