Create a document pdf export using Raw JSON Payload

curl --request POST \
  --url https://api-joy.joyfill.io/v1/documents/exports/pdf \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": {
    "identifier": "<string>",
    "name": "<string>",
    "files": "<array>",
    "fields": "<array>",
    "template": "<string>",
    "group": "<string>",
    "stage": "published"
  },
  "timezone": "UTC"
}
'

"{\n  \"download_url\": \"String\",\n  \"preview_url\": \"String\"\n}"

POST

documents

exports

pdf

Create a document pdf export using Raw JSON Payload

curl --request POST \
  --url https://api-joy.joyfill.io/v1/documents/exports/pdf \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": {
    "identifier": "<string>",
    "name": "<string>",
    "files": "<array>",
    "fields": "<array>",
    "template": "<string>",
    "group": "<string>",
    "stage": "published"
  },
  "timezone": "UTC"
}
'

"{\n  \"download_url\": \"String\",\n  \"preview_url\": \"String\"\n}"

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

Authorization

string

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

Body

application/json

document

object

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

Show child attributes

document.identifier

string

Specifies a document's unique ID. Maximum length is 80 characters. Identifier cannot be changed after creation. Leave the identifier param empty to have Joyfill auto generate an identifier.

document.name

string

Specifies the visual display name. When the template param is used in this creation event and this name is left blank the document will automatically be given the same name as the original template.

document.files

array

Array of JoyDoc file objects. See the JoyDoc data structure under the guides section to learn more.

document.fields

array

Array of JoyDoc field objects. See the JoyDoc data structure under the guides section to learn more.

document.template

string

The template identifier to use as the source of the document.

document.group

string

The group identifier of the group that you would like to create the document for.

document.stage

enum<string>

default:published

Available options:

draft,

published

timezone

string

default:UTC

Response

200 - application/json

200

download_url

string

Example:

"String"

preview_url

string

Example:

"String"

Create a document pdf export Overview

⌘I

Getting Started

Documents

Templates

Groups

Users

Utilities

Create a document pdf export using Raw JSON Payload

Authorizations

Headers

Body

Response