create_portal
Create a branded file collection portal for external users. Configure access codes, download passwords, file type restrictions, and more—with only a name and subdomain required.
Instructions
Create a new portal for collecting files from external users. Portals can be configured with access codes, download passwords, file type restrictions, custom branding, connected integrations, and more. Only 'name' and 'subdomain' are required - all other settings are optional.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Portal name | |
| active | No | Whether portal is active and accepting uploads | |
| expiry | No | Portal expiry date (ISO 8601 format). This parameter is required when expiry_enabled: true | |
| message | No | Welcome message displayed on portal | |
| logo_url | No | URL of logo image for portal | |
| subdomain | Yes | Portal subdomain (3-53 characters) | |
| file_types | No | Allowed/excluded file extensions prefixed with dots (e.g., ['.mp4', '.mov']) | |
| recipients | No | Email addresses that receive notifications for portal uploads | |
| access_code | No | Access code for portal (required if has_access_code is true) | |
| access_list | No | Array of membership IDs for users with direct access to private portal. Use get_team_members to retrieve membership IDs | |
| access_level | No | Portal access level: 'regular' for public access, 'private' for restricted access | |
| teamspace_id | No | ID of teamspace to associate portal with | |
| cc_recipients | No | Email addresses that receive carbon copy notifications without download link | |
| max_file_size | No | Maximum file size in bytes (0 for unlimited). Only works when package_size_restriction_enabled: true | |
| primary_color | No | Primary color for portal branding (hex color code) | |
| background_url | No | URL of background image for portal | |
| expiry_enabled | No | Whether portal expiry is enabled. If set to true, need to also provide expiry parameter, e.g. expiry: '2027-01-01' | |
| max_file_count | No | Maximum number of files per upload (0 for unlimited). Only works when package_size_restriction_enabled: true | |
| has_access_code | No | Whether portal requires an access code to upload (if true, you also need to specify access_code parameter) | |
| max_package_size | No | Maximum package size in bytes (0 for unlimited). Only works when package_size_restriction_enabled: true | |
| terms_of_service | No | Terms of service configuration (required when terms_of_service_enabled is true) | |
| download_password | No | Download password (required if has_download_password is true) | |
| custom_expiry_days | No | Custom expiry days for packages (-1 for unlimited) | |
| package_name_format | No | Custom package naming format configuration (required when package_name_format_enabled is true) | |
| has_download_password | No | Whether portal packages require password to download (if true, you also need to specify download_password parameter) | |
| disable_upload_receipt | No | Disable email receipt to uploader | |
| terms_of_service_enabled | No | Whether terms of service acceptance is required to upload to the portal | |
| package_name_format_enabled | No | Whether custom package naming format is enabled | |
| user_authentication_required | No | Whether to restrict Portal upload to only team users with proper access. Users must authenticate to upload | |
| file_type_restriction_enabled | No | Whether file type restrictions are enabled | |
| file_type_restriction_exclude | No | Whether to exclude (true) or include (false) specified file types | |
| package_size_restriction_enabled | No | Whether package size restrictions are enabled. Set to true in order to set max_file_count, max_file_size or max_package_size | |
| download_user_authentication_required | No | Whether users must authenticate to download |