Documents API: Create document

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/documents/create_document
Handler	OperatelyWeb.Api.Wrappers.DocsAndFiles.CreateDocument

Authentication#

• Requires a valid API token.
• Requires a write-enabled token.
• Read-only tokens return 403.

Inputs#

Field	Type	Required	Nullable	Default
space_id	id primitive (encoded as string)	No	Yes	-
project_id	id primitive (encoded as string)	No	Yes	-
folder_id	id primitive (encoded as string)	No	Yes	-
name	string	Yes	No	-
content	json primitive (encoded as string)	Yes	No	-
post_as_draft	boolean	No	Yes	false
send_notifications_to_everyone	boolean	No	No	true
subscriber_ids	array of id primitive (encoded as string)	No	No	[]
copied_document_id	id primitive (encoded as string)	No	Yes	-

Outputs#

Field	Type	Required	Nullable
document	document	Yes	No

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/documents/create_document" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"content":"value", "copied_document_id":"value", "folder_id":"value", "name":"value", "post_as_draft":true, "project_id":"value", "send_notifications_to_everyone":true, "space_id":"value", "subscriber_ids":["value"]}'

Response Example#

{
  "document": "<document>"
}