Skip to main content
POST
/
documents
/
{identifier}
/
exports
/
pdf
Create a document pdf export
curl --request POST \
  --url https://api-joy.joyfill.io/v1/documents/{identifier}/exports/pdf \
  --header 'Content-Type: application/json' \
  --data '
{
  "fields": "<array>",
  "timezone": "UTC"
}
'
import requests

url = "https://api-joy.joyfill.io/v1/documents/{identifier}/exports/pdf"

payload = {
"fields": "<array>",
"timezone": "UTC"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({fields: '<array>', timezone: 'UTC'})
};

fetch('https://api-joy.joyfill.io/v1/documents/{identifier}/exports/pdf', 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://api-joy.joyfill.io/v1/documents/{identifier}/exports/pdf",
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([
'fields' => '<array>',
'timezone' => 'UTC'
]),
CURLOPT_HTTPHEADER => [
"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://api-joy.joyfill.io/v1/documents/{identifier}/exports/pdf"

payload := strings.NewReader("{\n \"fields\": \"<array>\",\n \"timezone\": \"UTC\"\n}")

req, _ := http.NewRequest("POST", url, payload)

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://api-joy.joyfill.io/v1/documents/{identifier}/exports/pdf")
.header("Content-Type", "application/json")
.body("{\n \"fields\": \"<array>\",\n \"timezone\": \"UTC\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-joy.joyfill.io/v1/documents/{identifier}/exports/pdf")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"fields\": \"<array>\",\n \"timezone\": \"UTC\"\n}"

response = http.request(request)
puts response.read_body
"{\n  \"download_url\": \"String\",\n  \"preview_url\": \"String\"\n}"

Headers

Authorization
string

Supports both API Key and User Access Token authorization. See https://joyfill.mintlify.app/api/authentication

Path Parameters

identifier
string
required

A document's unique identifier. Specifies that you want to use a saved Joyfill document to generate the PDF export.

Body

application/json
fields
array

Specifies a list of JoyDoc Fields that you would like to merge/overwrite inside the targeted document identifier.

timezone
string
default:UTC

Response

200 - application/json

200

download_url
string
Example:

"String"

preview_url
string
Example:

"String"