Skip to main content
POST
/
documents
/
{identifier}
Update a document
curl --request POST \
  --url https://api-joy.joyfill.io/v1/documents/{identifier} \
  --header 'Content-Type: application/json' \
  --data '
{
  "files": "<array>",
  "fields": "<array>",
  "type": "document",
  "name": "<string>",
  "group": "<string>",
  "stage": "published"
}
'
"{\n  \"type\": \"String\",\n  \"identifer\": \"String\",\n  \"name\": \"String\",\n  \"group\": \"String\",\n  \"stage\": \"String\",\n  \"files\": \"Array\",\n  \"fields\": \"Array\"\n   \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

Body

application/json
​
files
array
required

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

​
fields
array
required

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

​
type
enum<string>
default:document
Available options:
document,
template
​
name
string
​
group
string

The group identifier of the group that you would like to add the document to

​
stage
enum<string>
default:published
Available options:
draft,
published

Response

200 - application/json

200

​
type
string
Example:

"String"

​
identifer
string
Example:

"String"

​
name
string
Example:

"String"

​
group
string
Example:

"String"

​
stage
string
Example:

"String"

​
files
string
Example:

"Array"

​
fields
string
Example:

"Array"