Skip to main content
Server path: /ziflow-collaboration | Type: Application | PCID required: Yes

Tools

ToolDescription
ziflow_collaboration_delete_checklist_templateDelete checklist by ID
ziflow_collaboration_delete_comment_labels_label_idDelete label
ziflow_collaboration_delete_decision_reasons_options_option_idDelete option
ziflow_collaboration_get_checklist_templateGet Checklist by ID
ziflow_collaboration_get_checklist_templates_listGet Checklist templates
ziflow_collaboration_get_comment_labelsGet labels
ziflow_collaboration_get_comment_labels_label_idGet label by ID
ziflow_collaboration_get_decision_reasonsGet reasons
ziflow_collaboration_get_decision_reasons_options_option_idGet option
ziflow_collaboration_get_proofs_id_commentsGet comments
ziflow_collaboration_get_proofs_id_comments_comment_idGet comment by ID
ziflow_collaboration_post_checklist_templateCreate new checklist template
ziflow_collaboration_post_comment_labelsAdd label
ziflow_collaboration_post_decision_reasons_optionsAdd reasons option
ziflow_collaboration_post_proofs_id_commentsAdd comment
ziflow_collaboration_post_proofs_id_comments_comment_id_likeLike comment
ziflow_collaboration_put_comment_labels_label_idUpdate an existing label
ziflow_collaboration_put_decision_reasonsUpdate reasons settings
ziflow_collaboration_put_decision_reasons_options_option_idUpdate an existing option
ziflow_collaboration_put_proofs_id_comments_comment_id_labelsLabel comment
ziflow_collaboration_put_proofs_id_comments_comment_id_reactionsAdd comment reactions
ziflow_collaboration_put_proofs_id_comments_comment_id_resolveResolve comment
ziflow-collaboration_put_checklist_templateUpdate checklist by ID

ziflow_collaboration_delete_checklist_template

Delete checklist by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesChecklist template ID to delete

ziflow_collaboration_delete_comment_labels_label_id

Delete label Parameters:
ParameterTypeRequiredDefaultDescription
label_idstringYesLabel ID to delete

ziflow_collaboration_delete_decision_reasons_options_option_id

Delete option Parameters:
ParameterTypeRequiredDefaultDescription
option_idstringYesOption ID to delete

ziflow_collaboration_get_checklist_template

Get Checklist by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesChecklist Template ID

ziflow_collaboration_get_checklist_templates_list

Get Checklist templates Parameters:
ParameterTypeRequiredDefaultDescription
countintegerNoSpecifies number of records to return with max=100
pageintegerNoUsed for pagination, starting at 1

ziflow_collaboration_get_comment_labels

Get labels

ziflow_collaboration_get_comment_labels_label_id

Get label by ID Parameters:
ParameterTypeRequiredDefaultDescription
label_idstringYesLabel ID

ziflow_collaboration_get_decision_reasons

Get reasons

ziflow_collaboration_get_decision_reasons_options_option_id

Get option Parameters:
ParameterTypeRequiredDefaultDescription
option_idstringYesOption ID

ziflow_collaboration_get_proofs_id_comments

Get comments Parameters:
ParameterTypeRequiredDefaultDescription
formatstringNoParam defining comment text formatting.
idstringYesProof ID

ziflow_collaboration_get_proofs_id_comments_comment_id

Get comment by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesProof ID
comment_idstringYesComment ID
formatstringNoParam defining comment text formatting.

ziflow_collaboration_post_checklist_template

Create new checklist template Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesChecklist template object

ziflow_collaboration_post_comment_labels

Add label Parameters:
ParameterTypeRequiredDefaultDescription
activebooleanNoThe active value
labelstringYesLabel name
orderintegerNoThe order in which the label is displayed.

ziflow_collaboration_post_decision_reasons_options

Add reasons option Parameters:
ParameterTypeRequiredDefaultDescription
labelstringNoThe label value
orderintegerNoThe order value
text_field_availablebooleanNoText Field Available

ziflow_collaboration_post_proofs_id_comments

Add comment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesProof ID
checklist_itemsobject[]Nochecklist item to be linked with comment
commentstringYesA Reviewer on the proof can be mentioned in the comment using ${reviewer:reviewer_id}. Field accepts max of 10000 characters.
labelsstring[]NoIDs of labels
locationobjectYesFor static, rich media and live website proof provide page number, for audio and video - start time
markersobject[]NoThe markers value
parent_comment_idstringNoParent Comment Id
privatebooleanNoAvailable only on Enterprise edition
proof_idstringNoProof Id
resolvedbooleanNoIf true, the comment is added and immediately resolved and locked. Available on the Pro and Enterprise editions.
reviewerobjectNoThe reviewer value

ziflow_collaboration_post_proofs_id_comments_comment_id_like

Like comment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesProof ID
comment_idstringYesComment ID
likebooleanYesThe like value
reviewer_idstringNoReviewer ID obtained from proof.stages[].members[].id field

ziflow_collaboration_put_comment_labels_label_id

Update an existing label Parameters:
ParameterTypeRequiredDefaultDescription
label_idstringYesLabel ID
activebooleanNoThe active value
idstringNoThe id value
labelstringNoThe label value
orderintegerNoThe order value

ziflow_collaboration_put_decision_reasons

Update reasons settings Parameters:
ParameterTypeRequiredDefaultDescription
display_textstringNoDisplay Text
mandatorybooleanNoThe mandatory value
multiple_selectionbooleanNoMultiple Selection

ziflow_collaboration_put_decision_reasons_options_option_id

Update an existing option Parameters:
ParameterTypeRequiredDefaultDescription
option_idstringYesOption ID
labelstringNoThe label value
orderintegerNoThe order value
text_field_availablebooleanNoText Field Available

ziflow_collaboration_put_proofs_id_comments_comment_id_labels

Label comment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesProof ID
comment_idstringYesComment ID
idsstring[]YesThe ids value
reviewer_idstringNoReviewer ID obtained from proof.stages[].members[].id field

ziflow_collaboration_put_proofs_id_comments_comment_id_reactions

Add comment reactions Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesProof ID
comment_idstringYesComment ID
reviewer_idstringNoReviewer ID obtained from proof.stages[].members[].id field
statusbooleanNoThe status value
typestringYesThe type value

ziflow_collaboration_put_proofs_id_comments_comment_id_resolve

Resolve comment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesProof ID
comment_idstringYesComment ID
reviewer_idstringNoReviewer ID obtained from proof.stages[].members[].id field
typestringYesThe type value

ziflow-collaboration_put_checklist_template

Update checklist by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesChecklist template ID to update
bodyobjectYesChecklist template object