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

Tools

ToolDescription
ziflow_management_delete_custom_properties_proofs_groups_group_idDelete Property Group
ziflow_management_delete_folders_idDelete folder
ziflow_management_delete_guests_idDelete guest
ziflow_management_delete_users_identifierDelete user
ziflow_management_delete_webhooks_subscription_idDelete webhook subscription
ziflow_management_delete_workflowtemplates_template_idDelete a template
ziflow_management_get_contactsGet all contacts
ziflow_management_get_contacts_identifierGet Contact by ID or email
ziflow_management_get_custom_properties_proofs_groupsGet Properties Groups
ziflow_management_get_custom_properties_proofs_groups_group_idGet Property Group by ID
ziflow_management_get_custom_properties_proofs_groups_group_id_properties_property_id_optionsGet Property’s options list
ziflow_management_get_custom_properties_proofs_groups_group_id_properties_property_id_options_option_idGet Property’s option
ziflow_management_get_foldersGet root folders
ziflow_management_get_folders_idGet folders
ziflow_management_get_folders_id_folder_urlGenerate folder URL (PREVIEW)
ziflow_management_get_folders_id_shareGet folder sharing settings
ziflow_management_get_intake_formsGet list of intake forms
ziflow_management_get_integrationsGet integration apps
ziflow_management_get_integrations_application_key_connectionsGet list of app connections
ziflow_management_get_integrations_application_key_property_groupsGet app groups
ziflow_management_get_integrations_application_key_property_groups_key_propertiesGet app group properties
ziflow_management_get_usersGet users
ziflow_management_get_users_identifierGet User by ID or email
ziflow_management_get_webhooksGet webhook subscriptions
ziflow_management_get_workflowtemplatesGet workflow templates
ziflow_management_get_workflowtemplates_template_idGet workflow template by ID
ziflow_management_post_custom_properties_proofs_groupsCreate Property Group
ziflow_management_post_custom_properties_proofs_groups_group_id_properties_property_id_optionsAdd option to property
ziflow_management_post_foldersCreate new folder
ziflow_management_post_guestsAdd guest
ziflow_management_post_usersAdd user
ziflow_management_post_webhooksCreate webhook subscription
ziflow_management_post_workflowtemplatesCreate new workflow template
ziflow_management_put_custom_properties_proofs_groups_group_idUpdate Property Group
ziflow_management_put_custom_properties_proofs_groups_group_id_properties_property_id_options_option_idUpdate Property option
ziflow_management_put_folders_idUpdate an existing folder
ziflow_management_put_folders_id_shareUpdate folder sharing settings
ziflow_management_put_guests_idUpdate an existing guest
ziflow_management_put_users_identifierUpdate an existing user
ziflow_management_put_workflowtemplates_template_idUpdate an existing template

ziflow_management_delete_custom_properties_proofs_groups_group_id

Delete Property Group Parameters:
ParameterTypeRequiredDefaultDescription
group_idstringYesCustom Property Group ID to delete

ziflow_management_delete_folders_id

Delete folder Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesFolder ID
delete_proofsbooleanNo* 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:
ParameterTypeRequiredDefaultDescription
idstringYesGuest ID

ziflow_management_delete_users_identifier

Delete user Parameters:
ParameterTypeRequiredDefaultDescription
identifierstringYesUser ID
newOwnerstringNoOptional 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:
ParameterTypeRequiredDefaultDescription
subscription_idstringYesSubscription ID

ziflow_management_delete_workflowtemplates_template_id

Delete a template Parameters:
ParameterTypeRequiredDefaultDescription
template_idstringYesTemplate ID to delete

ziflow_management_get_contacts

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

ziflow_management_get_contacts_identifier

Get Contact by ID or email Parameters:
ParameterTypeRequiredDefaultDescription
identifierstringYesContact ID or email address

ziflow_management_get_custom_properties_proofs_groups

Get Properties Groups

ziflow_management_get_custom_properties_proofs_groups_group_id

Get Property Group by ID Parameters:
ParameterTypeRequiredDefaultDescription
group_idstringYesCustom Property Group ID

ziflow_management_get_custom_properties_proofs_groups_group_id_properties_property_id_options

Get Property’s options list Parameters:
ParameterTypeRequiredDefaultDescription
group_idstringYesProperty group ID
property_idstringYesProperty ID

ziflow_management_get_custom_properties_proofs_groups_group_id_properties_property_id_options_option_id

Get Property’s option Parameters:
ParameterTypeRequiredDefaultDescription
group_idstringYesProperty group ID
property_idstringYesProperty ID
option_idstringYesOption ID

ziflow_management_get_folders

Get root folders

ziflow_management_get_folders_id

Get folders Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesFolder ID
includestringNoParam 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:
ParameterTypeRequiredDefaultDescription
idstringYesFolder ID
expireAfterFirstUsebooleanNoIf true, URL will expire after first use. Overwrites urlExpiration value.
urlExpirationintegerNoURL expiration time in hours. Proper range of values: 1 - 336.
emailstringNoOptionally 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:
ParameterTypeRequiredDefaultDescription
idstringYesFolder ID

ziflow_management_get_intake_forms

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

ziflow_management_get_integrations

Get integration apps Parameters:
ParameterTypeRequiredDefaultDescription
integration_properties_enabledbooleanNoSpecifies visibility of integration properties on proofs

ziflow_management_get_integrations_application_key_connections

Get list of app connections Parameters:
ParameterTypeRequiredDefaultDescription
application_keystringYesSpecifies 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:
ParameterTypeRequiredDefaultDescription
application_keystringYesSpecifies 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:
ParameterTypeRequiredDefaultDescription
application_keystringYesSpecifies integration application e.g. MONDAY or ASANA. Value can be obtained from GET /integrations response “application_key” field. Must be upper-case
keystringYesSpecifies 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:
ParameterTypeRequiredDefaultDescription
countintegerNoSpecifies number of records to return with max=100
pageintegerNoUsed for pagination, starting at 1

ziflow_management_get_users_identifier

Get User by ID or email Parameters:
ParameterTypeRequiredDefaultDescription
identifierstringYesUser ID or email address

ziflow_management_get_webhooks

Get webhook subscriptions

ziflow_management_get_workflowtemplates

Get workflow templates

ziflow_management_get_workflowtemplates_template_id

Get workflow template by ID Parameters:
ParameterTypeRequiredDefaultDescription
template_idstringYesWorkflow template ID

ziflow_management_post_custom_properties_proofs_groups

Create Property Group Parameters:
ParameterTypeRequiredDefaultDescription
activebooleanNoactive
display_orderintegerNoOrder of the group. If not provided, by default group will be added as last on the list
namestringYesProperty group name

ziflow_management_post_custom_properties_proofs_groups_group_id_properties_property_id_options

Add option to property Parameters:
ParameterTypeRequiredDefaultDescription
group_idstringYesProperty group ID
property_idstringYesProperty ID
colorstringNoPossible to set only for multi select list options. Default is null or “default_color” from Property’s “field_type” object
display_orderintegerNoDefault is last available number on the list
valuestringYesvalue
visiblebooleanNovisible

ziflow_management_post_folders

Create new folder Parameters:
ParameterTypeRequiredDefaultDescription
archivedbooleanNoField defines if folder will be archived or not. Setting “false” on subfolder will unarchive all subfolders and parent folders.
namestringNoname
parent_folder_idstringNoparent_folder_id
privatebooleanNoprivate

ziflow_management_post_guests

Add guest Parameters:
ParameterTypeRequiredDefaultDescription
companystringNocompany
emailstringYesemail
first_namestringNofirst_name
groupany[]Nogroup
languagestringNoDefault value is pulled from account settings
last_namestringNolast_name
phonestringNophone
proofing_defaultsobjectNoproofing_defaults
timezonestringNoValid time zone identifiers from IANA Time Zone Database

ziflow_management_post_users

Add user Parameters:
ParameterTypeRequiredDefaultDescription
companystringNocompany
emailstringYesemail
first_namestringNofirst_name
groupany[]Nogroup
languagestringNoCan be changed to: en, zh_cn, de, fr, ja, pt_br, es
last_namestringNolast_name
passwordstringNoMust 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.
phonestringNophone
proofing_defaultsobjectNoproofing_defaults
rolesany[]Noroles
timezonestringNoValid time zone identifiers from IANA Time Zone Database
verifiedbooleanNoIf true, “password” field is required and API key will be generated automatically (visible only to Admins).

ziflow_management_post_webhooks

Create webhook subscription Parameters:
ParameterTypeRequiredDefaultDescription
activebooleanNoactive
generate_signature_keybooleanNoDefines 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.
namestringYesname
subscription_typesobjectYessubscription_types
targetstringYestarget
webhook_signature_keystringNoKey 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:
ParameterTypeRequiredDefaultDescription
activebooleanNoactive
namestringNoname
owner_emailstringNoOptional field to define template owner different than request’s author. Only user with admin permissions can be a template owner.
permissionsobjectNopermissions
stagesany[]Yesstages

ziflow_management_put_custom_properties_proofs_groups_group_id

Update Property Group Parameters:
ParameterTypeRequiredDefaultDescription
group_idstringYesCustom Property Group ID
activebooleanNoactive
display_orderintegerNoOrder of the group.
namestringNoProperty group name

ziflow_management_put_custom_properties_proofs_groups_group_id_properties_property_id_options_option_id

Update Property option Parameters:
ParameterTypeRequiredDefaultDescription
group_idstringYesProperty group ID
property_idstringYesProperty ID
option_idstringYesOption ID
colorstringNoPossible to update only for multi select list options
display_orderintegerNodisplay_order
valuestringNovalue
visiblebooleanNovisible

ziflow_management_put_folders_id

Update an existing folder Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesFolder ID
archivedbooleanNoField defines if folder will be archived or not. Setting “false” on subfolder will unarchive all subfolders and parent folders.
namestringNoname
parent_folder_idstringNoparent_folder_id
privatebooleanNoprivate

ziflow_management_put_folders_id_share

Update folder sharing settings Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesFolder ID
typestringNoSpecifies folder’s type

ziflow_management_put_guests_id

Update an existing guest Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesGuest ID
companystringNocompany
first_namestringNofirst_name
groupany[]Nogroup
languagestringNoCan be changed to: en, zh_cn, de, fr, ja, pt_br, es
last_namestringNolast_name
phonestringNophone
proofing_defaultsobjectNoproofing_defaults
timezonestringNoValid time zone identifiers from IANA Time Zone Database

ziflow_management_put_users_identifier

Update an existing user Parameters:
ParameterTypeRequiredDefaultDescription
identifierstringYesUser ID
activebooleanNoactive
companystringNocompany
first_namestringNofirst_name
groupany[]Nogroup
languagestringNoCan be changed to: en, zh_cn, de, fr, ja, pt_br, es
last_namestringNolast_name
passwordstringNoMust 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.
phonestringNophone
proofing_defaultsobjectNoproofing_defaults
rolesany[]Noroles
timezonestringNoValid time zone identifiers from IANA Time Zone Database
verifiedbooleanNoCan only be changed from false to true

ziflow_management_put_workflowtemplates_template_id

Update an existing template Parameters:
ParameterTypeRequiredDefaultDescription
template_idstringYesTemplate ID
activebooleanNoactive
idstringNoid
namestringNoname
owner_emailstringNoowner_email
permissionsobjectNopermissions
stagesany[]Nostages