TEtectonic
Documents

Create a document

Changed on

Creates a document.

post/document

Request

Headers

Accept'application/vnd.Creative Force.v2.3+json' | 'application/vnd.Creative Force.v2.3+xml' required

Defines the response type.

x-api-languagestring[]

Defines the languages included in the response. If non are provided, the account default language is returned.

Value all overrides any other values present.

You can request multiple languages using a comma-separated string of languages.

The selected language must be supported by your account or a 400 error is returned.

Request body

templatestring required

Slug of the document template to generate the document from.

fileType'PDF' | 'Word' | 'accessible-pdf' required

File format to generate the document in.

Use accessible-pdf to generate a tagged, accessible PDF.

sharedboolean required

Specifies whether the generated document is shared with the entrant.

resource'user' | 'entry' | 'allocation' | 'grant-report' required

Type of resource to attach the generated documents to.

selectedstring[] required

Slugs of the resources, of the type given by resource, to attach the generated documents to.

notificationstring nullable

Slug of the notification to send when the document is created.

Omit or set to null to send no notification.

Response

Document creation accepted.

Changes