/ziflow-collaboration | Type: Application | PCID required: Yes
Tools
ziflow_collaboration_delete_comment_labels_label_id
Delete label Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
label_id | string | Yes | — | Label ID to delete |
ziflow_collaboration_delete_decision_reasons_options_option_id
Delete option Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
option_id | string | Yes | — | Option ID to delete |
ziflow_collaboration_get_comment_labels
Get labelsziflow_collaboration_get_comment_labels_label_id
Get label by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
label_id | string | Yes | — | Label ID |
ziflow_collaboration_get_decision_reasons
Get reasonsziflow_collaboration_get_decision_reasons_options_option_id
Get option Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
option_id | string | Yes | — | 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 |
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. |
ziflow_collaboration_post_comment_labels
Add label Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
active | boolean | No | — | active |
label | string | Yes | — | Label name |
order | integer | No | — | The order in which the label is displayed. |
ziflow_collaboration_post_decision_reasons_options
Add reasons option Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
label | string | No | — | label |
order | integer | No | — | order |
text_field_available | boolean | No | — | text_field_available |
ziflow_collaboration_post_proofs_id_comments
Add comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Proof ID |
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 | any[] | 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 | any[] | No | — | markers |
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 | — | reviewer |
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 | — | like |
reviewer_id | string | No | — | Reviewer ID obtained from proof.stages[].members[].id field |
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 | — | active |
id | string | No | — | id |
label | string | No | — | label |
order | integer | No | — | order |
ziflow_collaboration_put_decision_reasons
Update reasons settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
display_text | string | No | — | display_text |
mandatory | boolean | No | — | mandatory |
multiple_selection | boolean | No | — | multiple_selection |
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 | — | label |
order | integer | No | — | order |
text_field_available | boolean | No | — | text_field_available |
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 | any[] | Yes | — | ids |
reviewer_id | string | No | — | Reviewer ID obtained from proof.stages[].members[].id field |
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 | — | status |
type | string | Yes | — | 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 | — | type |

