/ziflow-management | Type: Application | PCID required: Yes
Tools
ziflow_management_delete_custom_properties_proofs_groups_group_id
Delete Property Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
group_id | string | Yes | — | Custom Property Group ID to delete |
ziflow_management_delete_folders_id
Delete folder Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Folder ID |
delete_proofs | boolean | No | — | * true - request will delete folder, its sub-folders and proofs inside. If user does not have permission to delete specific folder, it will be moved to the root folder. * false - request will delete only folder and its sub-folders. |
ziflow_management_delete_guests_id
Delete guest Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Guest ID |
ziflow_management_delete_users_identifier
Delete user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
identifier | string | Yes | — | User ID |
newOwner | string | No | — | Optional parameter, will transfer any proofs from this user to the nominated user. Parameter value should be an ID of a user, who should become a new owner of those proofs. |
ziflow_management_delete_webhooks_subscription_id
Delete webhook subscription Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
subscription_id | string | Yes | — | Subscription ID |
ziflow_management_delete_workflowtemplates_template_id
Delete a template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
template_id | string | Yes | — | Template ID to delete |
ziflow_management_get_contacts
Get all contacts 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 |
ziflow_management_get_contacts_identifier
Get Contact by ID or email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
identifier | string | Yes | — | Contact ID or email address |
ziflow_management_get_custom_properties_proofs_groups
Get Properties Groupsziflow_management_get_custom_properties_proofs_groups_group_id
Get Property Group by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
group_id | string | Yes | — | Custom Property Group ID |
ziflow_management_get_custom_properties_proofs_groups_group_id_properties_property_id_options
Get Property’s options list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
group_id | string | Yes | — | Property group ID |
property_id | string | Yes | — | Property ID |
ziflow_management_get_custom_properties_proofs_groups_group_id_properties_property_id_options_option_id
Get Property’s option Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
group_id | string | Yes | — | Property group ID |
property_id | string | Yes | — | Property ID |
option_id | string | Yes | — | Option ID |
ziflow_management_get_folders
Get root foldersziflow_management_get_folders_id
Get folders Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Folder ID |
include | string | No | — | Param receives information about the folder in the URL. “subfolders_only” - returns only subfolders, “folder_and_subfolders” - returns current folder and subfolders (current folder as the first on the list, then all subfolders), “this_folder” - returns only the current folder. |
ziflow_management_get_folders_id_folder_url
Generate folder URL (PREVIEW) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Folder ID |
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 folder URL for the API user is returned. |
ziflow_management_get_folders_id_share
Get folder sharing settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Folder ID |
ziflow_management_get_intake_forms
Get list of intake forms 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 |
ziflow_management_get_integrations
Get integration apps Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
integration_properties_enabled | boolean | No | — | Specifies visibility of integration properties on proofs |
ziflow_management_get_integrations_application_key_connections
Get list of app connections Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
application_key | string | Yes | — | Specifies application e.g. MONDAY or ASANA. Value can be obtained from GET /integrations response “application_key” field. |
ziflow_management_get_integrations_application_key_property_groups
Get app groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
application_key | string | Yes | — | Specifies integration application e.g. MONDAY or ASANA. Value can be obtained from GET /integrations response “application_key” field. Must be upper-case. |
ziflow_management_get_integrations_application_key_property_groups_key_properties
Get app group properties Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
application_key | string | Yes | — | Specifies integration application e.g. MONDAY or ASANA. Value can be obtained from GET /integrations response “application_key” field. Must be upper-case |
key | string | Yes | — | Specifies application integration group key. Value can be obtained from GET /integrations/{application_key}/property-groups response “key” field. Must be upper-case. |
ziflow_management_get_users
Get users 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 |
ziflow_management_get_users_identifier
Get User by ID or email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
identifier | string | Yes | — | User ID or email address |
ziflow_management_get_webhooks
Get webhook subscriptionsziflow_management_get_workflowtemplates
Get workflow templatesziflow_management_get_workflowtemplates_template_id
Get workflow template by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
template_id | string | Yes | — | Workflow template ID |
ziflow_management_post_custom_properties_proofs_groups
Create Property Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
active | boolean | No | — | active |
display_order | integer | No | — | Order of the group. If not provided, by default group will be added as last on the list |
name | string | Yes | — | Property group name |
ziflow_management_post_custom_properties_proofs_groups_group_id_properties_property_id_options
Add option to property Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
group_id | string | Yes | — | Property group ID |
property_id | string | Yes | — | Property ID |
color | string | No | — | Possible to set only for multi select list options. Default is null or “default_color” from Property’s “field_type” object |
display_order | integer | No | — | Default is last available number on the list |
value | string | Yes | — | value |
visible | boolean | No | — | visible |
ziflow_management_post_folders
Create new folder Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
archived | boolean | No | — | Field defines if folder will be archived or not. Setting “false” on subfolder will unarchive all subfolders and parent folders. |
name | string | No | — | name |
parent_folder_id | string | No | — | parent_folder_id |
private | boolean | No | — | private |
ziflow_management_post_guests
Add guest Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
company | string | No | — | company |
email | string | Yes | — | |
first_name | string | No | — | first_name |
group | any[] | No | — | group |
language | string | No | — | Default value is pulled from account settings |
last_name | string | No | — | last_name |
phone | string | No | — | phone |
proofing_defaults | object | No | — | proofing_defaults |
timezone | string | No | — | Valid time zone identifiers from IANA Time Zone Database |
ziflow_management_post_users
Add user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
company | string | No | — | company |
email | string | Yes | — | |
first_name | string | No | — | first_name |
group | any[] | No | — | group |
language | string | No | — | Can be changed to: en, zh_cn, de, fr, ja, pt_br, es |
last_name | string | No | — | last_name |
password | string | No | — | Must be provided if verified=true. Must be at least 8 characters, 1 number and 1 capital letter. Password change may be required from user dependent on Account Settings. |
phone | string | No | — | phone |
proofing_defaults | object | No | — | proofing_defaults |
roles | any[] | No | — | roles |
timezone | string | No | — | Valid time zone identifiers from IANA Time Zone Database |
verified | boolean | No | — | If true, “password” field is required and API key will be generated automatically (visible only to Admins). |
ziflow_management_post_webhooks
Create webhook subscription Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
active | boolean | No | — | active |
generate_signature_key | boolean | No | — | Defines if “webhook_signature_key” should be generated by Ziflow or not. When set to false and value is not provided, signature won’t be calculated and passed in request’s header. If true, Ziflow will generate the key which will be used to calculate signature. If you want to use your own key, this field should be set to false. If you set value to true and pass your own key, value will be ignored and generated by Ziflow. |
name | string | Yes | — | name |
subscription_types | object | Yes | — | subscription_types |
target | string | Yes | — | target |
webhook_signature_key | string | No | — | Key is used to calculate SHA-256 signature passed in webhook header “x-ziflow-signature” for each event. You can either use a key generated by Ziflow or provide your own. It should be max 255 chars, alphanumerical with ”-” and ” \ ”. Algorithm and example can be found on <a href=“https://help.ziflow.com/hc/en-us/articles/30725068740244-Webhooks” target=“_blank” rel=“noopener noreferrer”>Help Page</a> |
ziflow_management_post_workflowtemplates
Create new workflow template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
active | boolean | No | — | active |
name | string | No | — | name |
owner_email | string | No | — | Optional field to define template owner different than request’s author. Only user with admin permissions can be a template owner. |
permissions | object | No | — | permissions |
stages | any[] | Yes | — | stages |
ziflow_management_put_custom_properties_proofs_groups_group_id
Update Property Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
group_id | string | Yes | — | Custom Property Group ID |
active | boolean | No | — | active |
display_order | integer | No | — | Order of the group. |
name | string | No | — | Property group name |
ziflow_management_put_custom_properties_proofs_groups_group_id_properties_property_id_options_option_id
Update Property option Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
group_id | string | Yes | — | Property group ID |
property_id | string | Yes | — | Property ID |
option_id | string | Yes | — | Option ID |
color | string | No | — | Possible to update only for multi select list options |
display_order | integer | No | — | display_order |
value | string | No | — | value |
visible | boolean | No | — | visible |
ziflow_management_put_folders_id
Update an existing folder Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Folder ID |
archived | boolean | No | — | Field defines if folder will be archived or not. Setting “false” on subfolder will unarchive all subfolders and parent folders. |
name | string | No | — | name |
parent_folder_id | string | No | — | parent_folder_id |
private | boolean | No | — | private |
ziflow_management_put_folders_id_share
Update folder sharing settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Folder ID |
type | string | No | — | Specifies folder’s type |
ziflow_management_put_guests_id
Update an existing guest Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Guest ID |
company | string | No | — | company |
first_name | string | No | — | first_name |
group | any[] | No | — | group |
language | string | No | — | Can be changed to: en, zh_cn, de, fr, ja, pt_br, es |
last_name | string | No | — | last_name |
phone | string | No | — | phone |
proofing_defaults | object | No | — | proofing_defaults |
timezone | string | No | — | Valid time zone identifiers from IANA Time Zone Database |
ziflow_management_put_users_identifier
Update an existing user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
identifier | string | Yes | — | User ID |
active | boolean | No | — | active |
company | string | No | — | company |
first_name | string | No | — | first_name |
group | any[] | No | — | group |
language | string | No | — | Can be changed to: en, zh_cn, de, fr, ja, pt_br, es |
last_name | string | No | — | last_name |
password | string | No | — | Must be provided if “verified” changes to true. Must be at least 8 characters, 1 number and 1 capital letter. Password change may be required from user dependent on Account Settings. |
phone | string | No | — | phone |
proofing_defaults | object | No | — | proofing_defaults |
roles | any[] | No | — | roles |
timezone | string | No | — | Valid time zone identifiers from IANA Time Zone Database |
verified | boolean | No | — | Can only be changed from false to true |
ziflow_management_put_workflowtemplates_template_id
Update an existing template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
template_id | string | Yes | — | Template ID |
active | boolean | No | — | active |
id | string | No | — | id |
name | string | No | — | name |
owner_email | string | No | — | owner_email |
permissions | object | No | — | permissions |
stages | any[] | No | — | stages |

