Send it
curl --request POST \
--url https://yungle.co/api/v1/transfers/{id}/finalize \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipients": [
"jsmith@example.com"
],
"message": "<string>",
"password": "<string>",
"title": "<string>",
"e2eeMeta": "<string>"
}
'import requests
url = "https://yungle.co/api/v1/transfers/{id}/finalize"
payload = {
"recipients": ["jsmith@example.com"],
"message": "<string>",
"password": "<string>",
"title": "<string>",
"e2eeMeta": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recipients: ['jsmith@example.com'],
message: '<string>',
password: '<string>',
title: '<string>',
e2eeMeta: '<string>'
})
};
fetch('https://yungle.co/api/v1/transfers/{id}/finalize', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://yungle.co/api/v1/transfers/{id}/finalize",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'recipients' => [
'jsmith@example.com'
],
'message' => '<string>',
'password' => '<string>',
'title' => '<string>',
'e2eeMeta' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://yungle.co/api/v1/transfers/{id}/finalize"
payload := strings.NewReader("{\n \"recipients\": [\n \"jsmith@example.com\"\n ],\n \"message\": \"<string>\",\n \"password\": \"<string>\",\n \"title\": \"<string>\",\n \"e2eeMeta\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://yungle.co/api/v1/transfers/{id}/finalize")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recipients\": [\n \"jsmith@example.com\"\n ],\n \"message\": \"<string>\",\n \"password\": \"<string>\",\n \"title\": \"<string>\",\n \"e2eeMeta\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://yungle.co/api/v1/transfers/{id}/finalize")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"recipients\": [\n \"jsmith@example.com\"\n ],\n \"message\": \"<string>\",\n \"password\": \"<string>\",\n \"title\": \"<string>\",\n \"e2eeMeta\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"transfer": {
"id": "<string>",
"slug": "<string>",
"url": "<string>",
"title": "<string>",
"status": "<string>",
"sizeBytes": 1,
"recipients": [
"<string>"
],
"hasPassword": true,
"e2ee": true,
"downloadCount": 1,
"maxDownloads": 1,
"finalizedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"fileCount": 1
},
"notified": [
"<string>"
]
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}Transfers
Send it
Makes the link live and emails any recipients. Safe to retry — finalizing twice does not re-send. Omit recipients for a link-only transfer you share yourself.
POST
/
transfers
/
{id}
/
finalize
Send it
curl --request POST \
--url https://yungle.co/api/v1/transfers/{id}/finalize \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipients": [
"jsmith@example.com"
],
"message": "<string>",
"password": "<string>",
"title": "<string>",
"e2eeMeta": "<string>"
}
'import requests
url = "https://yungle.co/api/v1/transfers/{id}/finalize"
payload = {
"recipients": ["jsmith@example.com"],
"message": "<string>",
"password": "<string>",
"title": "<string>",
"e2eeMeta": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recipients: ['jsmith@example.com'],
message: '<string>',
password: '<string>',
title: '<string>',
e2eeMeta: '<string>'
})
};
fetch('https://yungle.co/api/v1/transfers/{id}/finalize', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://yungle.co/api/v1/transfers/{id}/finalize",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'recipients' => [
'jsmith@example.com'
],
'message' => '<string>',
'password' => '<string>',
'title' => '<string>',
'e2eeMeta' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://yungle.co/api/v1/transfers/{id}/finalize"
payload := strings.NewReader("{\n \"recipients\": [\n \"jsmith@example.com\"\n ],\n \"message\": \"<string>\",\n \"password\": \"<string>\",\n \"title\": \"<string>\",\n \"e2eeMeta\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://yungle.co/api/v1/transfers/{id}/finalize")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recipients\": [\n \"jsmith@example.com\"\n ],\n \"message\": \"<string>\",\n \"password\": \"<string>\",\n \"title\": \"<string>\",\n \"e2eeMeta\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://yungle.co/api/v1/transfers/{id}/finalize")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"recipients\": [\n \"jsmith@example.com\"\n ],\n \"message\": \"<string>\",\n \"password\": \"<string>\",\n \"title\": \"<string>\",\n \"e2eeMeta\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"transfer": {
"id": "<string>",
"slug": "<string>",
"url": "<string>",
"title": "<string>",
"status": "<string>",
"sizeBytes": 1,
"recipients": [
"<string>"
],
"hasPassword": true,
"e2ee": true,
"downloadCount": 1,
"maxDownloads": 1,
"finalizedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"fileCount": 1
},
"notified": [
"<string>"
]
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {},
"docs": "<string>"
}
}Authorizations
An API key from Settings → API keys, sent as Authorization: Bearer yk_live_…. Scopes: transfers:read, transfers:write, collections:read, collections:write, contacts:read, contacts:write, webhooks:read, webhooks:write. A write scope implies read of the same resource.
Path Parameters
Transfer id. Never the share slug, which is a capability.
Body
application/json
Omit to get a link only. Each address here is emailed on your behalf.
Maximum array length:
10Maximum string length:
2000Recipients must enter this to open the transfer.
Required string length:
1 - 256Maximum string length:
200End-to-end encrypted transfers only: the sealed { message }, bound to the transfer’s slug.
Maximum string length:
8192