{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"allow_source_download": {
"type": "boolean",
"description": "Allow Source Download"
},
"archived": {
"type": "boolean",
"description": "The archived value"
},
"brief": {
"type": "object",
"description": "The brief value",
"properties": {
"text": {
"type": "string",
"description": "Text that will be displayed in Brief section. Available on Standard, Pro and Enterprise editions only."
}
}
},
"combine": {
"type": "boolean",
"description": "If true, the input sources are combined into one multi-asset proof in the order passed through. Joining different asset types is allowed only on Enterprise edition. On Standard and Pro it's allowed to combine only static files. The Free editions is forced to false"
},
"custom_properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Property Group ID"
},
"name": {
"type": "string",
"description": "Property Group name"
},
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"description": "Property name"
},
"value": {
"type": "string",
"description": "Field used to set value for single-line, multi-line, number and date property types. Date is accepted only in format yyyy-MM-dd. Double numbers must be separated with dot ex. 35.20"
},
"value_user": {
"type": "object"
},
"value_enum": {
"type": "array"
}
}
},
"description": "List of properties in the group"
}
}
},
"description": "Available only on Enterprise edition. Values and IDs can be obtained from GET/v1/custom-properties/proofs/groups request."
},
"email_branding": {
"type": "object",
"description": "Available on Pro and Enterprise editions only",
"properties": {
"custom_button": {
"type": "object",
"description": "Definition of custom button"
},
"hide_open_proof_button": {
"type": "boolean",
"description": "Hide standard 'Open proof' button in proof's emails"
},
"replace_all_proof_urls": {
"type": "string",
"description": "Provide URL that will replace all links pointing to Ziflow Viewer"
}
}
},
"folder_id": {
"type": "string",
"description": "Folder ID may be required if set in Account proof settings - available only for admins on Standard, Pro and Enterprise editions."
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "URL to proof file, can be parametrized. <a href=\"https://help.ziflow.com/hc/en-us/articles/30725353774740-Supported-File-Media-Formats\" target=\"_blank\" rel=\"noopener noreferrer\">Supported file types</a> ."
},
"type": {
"type": "string",
"enum": [
"file",
"web-static",
"web-interactive"
],
"description": "The type value"
},
"nickname": {
"type": "string",
"description": "Value matching Nickname from AWS Credentials, that should be used to access given file. Credentials should be set in API Account Settings. For more information please see our <a href=\"https://help.ziflow.com/hc/en-us/articles/30725029040148-S3-Credentials\" target=\"_blank\" rel=\"noopener noreferrer\">help section</a>. If you want to use credentials to access your file, please provide URL in format: s3://{bucket-name}/{folder-name}/{file-name}"
},
"subtitles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "URL to subtitles file, can be parametrized. Currently supported file types are *.srt and *.vtt"
},
"nickname": {
"type": "string",
"description": "Optional field. Nickname must be set in Account Settings along with AWS Credentials(Amazon S3 storage) to use when accessing given file. For more information please see our <a href=\"https://help.ziflow.com/hc/en-us/articles/30725029040148-S3-Credentials\" target=\"_blank\" rel=\"noopener noreferrer\">help section</a>. If you want to use credentials to access your file, please provide URL in format: s3://{bucket-name}/{folder-name}/{file-name}"
}
}
},
"description": "Allows to define the source of subtitle file for video proofs( *.vtt or *.srt). Currently only one subtitle file can be submitted."
}
},
"required": [
"source",
"type"
]
},
"description": "The input value"
},
"lock_on_decisions": {
"type": "boolean",
"description": "Lock On Decisions"
},
"locked": {
"type": "boolean",
"description": "The locked value"
},
"merge_files": {
"type": "string",
"description": "Available only on Enterprise edition. When \"combine\" is set to true and input contains files of different types, this field defines, whether files should be merged into one asset. Field \"merge_files\" overrides \"merge_static_files\" if both provided",
"enum": [
"all",
"static_only",
"none"
]
},
"merge_static_files": {
"type": "boolean",
"description": "Use \"merge_files\" field."
},
"minor_version": {
"type": "boolean",
"description": "Available on Pro and Enterprise editions only. If true, \"version\" fields will be returned as X.y where X is last major version and y is number of minor version, i.e. 0.1, 2.3, 1.1"
},
"name": {
"type": "string",
"description": "The name value"
},
"owner_email": {
"type": "string",
"description": "You can provide an email of a user who you want to be the proof owner"
},
"pass_through_value": {
"type": "string",
"description": "Field allowing to attach a value to a proof that is passed back on the proof and webhook events to easily identify the proof in your own system. Field accepts max of 1024 characters."
},
"proof_security": {
"type": "string",
"description": "Field describes proof access control settings. If not provided settings are pulled from account settings(on Standard, Pro and Enterprise editions). Value 'users_and_guests_authentication_required' is available only on Enterprise edition. Field overrides 'secure_proofing' and 'require_sign_in' fields.",
"enum": [
"users_and_guests_no_authentication",
"users_and_guests_authentication_required",
"users_only_no_authentication",
"users_authentication_required"
]
},
"require_electronic_signature": {
"type": "boolean",
"description": "Available on Enterprise edition only. Enable this setting to request all reviewers to electronically sign their decisions on proof."
},
"require_sign_in": {
"type": "boolean",
"description": "Use \"proof_security\" field."
},
"secure_proofing": {
"type": "boolean",
"description": "Use \"proof_security\" field."
},
"stages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"final_status_calculation": {
"type": "object",
"description": "Defines how stage decision status is calculated. \"all_decisions\" - all decisions must be made to calculate the stage status. \"only_one_decision\" - any single decision is enough to calculate the stage status. \"primary_decision_maker\" - selected reviewer's decision will calculate the stage status. \"reviewer_id\" or \"reviewer_email\" must be provided for the \"primary_decision_maker\" option."
},
"deadline": {
"type": "string",
"description": "Date and time in YYYY-MM-DDTHH:mm:ss.SSSZ format i.e.2019-12-15T08:30:00.000Z. Only used if the stage trigger is \"immediately\" or if the stage has started. If the stage is triggered manually or based on another stage, use the \"stage_trigger\" deadline field."
},
"only_one_decision": {
"type": "boolean",
"description": "Only One Decision"
},
"status": {
"type": "object",
"description": "The status value"
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"view": {
"type": "boolean",
"description": "Always true"
},
"comment": {
"type": "boolean"
},
"decision": {
"type": "boolean"
},
"manage": {
"type": "boolean"
},
"share": {
"type": "boolean",
"description": "Allows to give guest reviewers permissions to share the proof. Available only on Enterprise edition"
},
"notification": {
"type": "string",
"description": "Default notification \"hourly_digest\" applies only to new users/guests. Other contacts retain their notification settings as default, unless defined otherwise. Default notification can be changed by Admin in account settings."
}
}
},
"description": "The members value"
},
"custom_email_subject": {
"type": "string",
"description": "Not allowed on plans below Enterprise."
},
"send_new_proof_email": {
"type": "boolean",
"description": "Send new proof/new version email to reviewers on Stage"
},
"custom_email_message": {
"type": "string",
"description": "Not allowed on plans below Enterprise."
},
"lock": {
"type": "object",
"description": "Available only on Enterprise edition."
},
"skip": {
"type": "string",
"enum": [
"never",
"on_approved_or_approvedwithchanges",
"on_approved",
"on_completion"
],
"description": "Skip condition. Available for proof from Enterprise edition only"
},
"checklists": {
"type": "array",
"items": {
"type": "object",
"properties": {
"checklist_template_id": {
"type": "string",
"description": "ID of the checklist template to generate a checklist from."
}
}
},
"description": "List of checklist templates to be used for creating checklists in the current stage"
},
"stage_trigger": {
"type": "object",
"description": "Available only on Enterprise edition"
},
"allow_private_comments": {
"type": "boolean",
"description": "Available only on Enterprise edition."
},
"allow_public_comments": {
"type": "boolean",
"description": "Default value forced for all editions except Enterprise."
},
"stage_previous_id": {
"type": "string",
"description": "When creating a new proof version and stage should be skipped, this field should contain ID of a stage from previous version which indicates the skip. Enterprise edition only."
}
},
"required": [
"members"
]
},
"description": "The stages value"
},
"subscription": {
"type": "object",
"description": "Available on Standard, Pro and Enterprise editions.",
"properties": {
"enabled": {
"type": "boolean",
"description": "The enabled value"
},
"permissions": {
"type": "string",
"description": "The permissions value",
"enum": [
"comment",
"comment_decisions"
]
},
"added_to_stage": {
"type": "string",
"description": "Stage to which new subscribers will be added, \"new_proof_subscribers\" value available only on Enterprise edition",
"enum": [
"first_stage",
"last_stage",
"new_proof_subscribers"
]
},
"stage_name": {
"type": "string",
"description": "Stage name for \"new_proof_subscribers\" value"
}
}
},
"suppress_all_emails": {
"type": "boolean",
"description": "If true, Ziflow will not send any emails regarding this proof. The only emails that can be triggered are the emails that are sent when using the 'remind' function within the web application."
},
"suppress_creation_email": {
"type": "boolean",
"description": "If true, \"New proof created\" email will not be sent to proof owner."
},
"version_previous_id": {
"type": "string",
"description": "If provided, it will make this proof a new version of the provided proof with given ID. This does require edit/manage permissions on the proof"
},
"workflow_template": {
"type": "object",
"description": "Available on proofs from Enterprise edition only",
"properties": {
"id": {
"type": "string",
"description": "Available only on Enterprise edition. ID of an active workflow template that should be used to create the proof"
}
}
}
},
"required": [
"PCID",
"input",
"stages"
]
}
