Transfers

Create

Endpoint

POST https://birbshare.com/transfer/create_api

Parameters	Details	Description
uploaded_files	Required Array Integer	Array containing UUID's for all the uploaded files to be attached to this transfer.
type	Required String	Allowed values: `link` , `email`
email_to	Optional String	Available when: type = email
name	Required String	-
description	Optional String	-
url	Optional String	-
domain_id	Optional Integer	-
project_id	Optional Integer	-
pixels_ids	Optional Array Integer	-
download_notification_handlers_ids	Optional Array Integer	-
expiration_datetime	Optional String	`Y-m-d H:i:s`
downloads_limit	Optional Integer	-
password	Optional String	-
file_encryption_is_enabled	Optional Boolean	-
is_removed_branding	Optional Boolean	-
custom_css	Optional String	-
custom_js	Optional String	-

Example

curl --request POST \
--url 'https://birbshare.com/transfer/create_api' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'uploaded_files[]=de09be56-639f-4213-863b-5ea1aa065970' \
--form 'name=Example name' \
--form 'description=Example description' \

Response example

{ "data": { "id": 1, "download_url": https://birbshare.com/transfer-redirect/1, "view_url": https://birbshare.com/transfer/1, } }