For the complete documentation index, see llms.txt. This page is also available as Markdown.

Mail Merge

Generate documents from templates and submissions

List mail-merge templates

get

Returns the mail-merge templates available for a form (structure) or a submission (submission). Provide one or the other parameter.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Query parameters
structureintegerOptional

Form identifier whose templates to retrieve

submissionstring · uuidOptional

Submission identifier (UUID) whose templates to retrieve

Responses
200

Available mail-merge templates

application/json
total_countintegerOptional
total_pagesintegerOptional
server_timeinteger · int64Optional
get/{app_short}/report_templates
200

Available mail-merge templates

List mail merges for a submission

get

Returns all mail merges generated for a given submission.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Query parameters
submissionstring · uuidRequired

Submission identifier (UUID)

per_pageintegerOptional

Number of mail merges per page (default 10, max 1000)

pageintegerOptional

Number of the requested page

updated_sinceinteger · int64Optional

Filter mail merges updated after this date (timestamp)

Responses
200

Paginated list of mail merges

application/json
total_countintegerOptional
next_pageintegerOptional
server_timeinteger · int64Optional
get/{app_short}/reports
200

Paginated list of mail merges

Start a mail merge

post

Starts mail-merge generation for a submission from a template. The api_callback URL is called (PUT method) once generation completes; {publipostage_id} is replaced by the identifier of the created mail merge.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Body

Body for starting a mail merge

template_idintegerRequired

Template identifier (mandatory)

submission_idstring · uuidRequired

Submission identifier (mandatory)

api_callbackstringRequired

URL called (PUT) when generation completes; {publipostage_id} is substituted (mandatory)

header_namestringOptional

HTTP header name to send during the callback (optional)

header_valuestringOptional

HTTP header value to send during the callback (optional)

join_formatstring · enumOptional

Output format: original, pdf, or original,pdf (two reports generated)

Possible values:
Responses
200

Mail merge created

application/json
report_idintegerOptional

Identifier of the created mail merge

post/{app_short}/reports
200

Mail merge created

Get mail merge information

get

Returns the status and generated files of a mail merge by its identifier.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

report_idintegerRequired

Mail merge identifier

Responses
200

Mail merge information

application/json

Generated mail merge

idintegerOptional

Mail merge identifier

statusstringOptional

Mail merge status (e.g. finished, error)

errorMessagestringOptional

Error message, if any

get/{app_short}/reports/{report_id}
200

Mail merge information

Download a generated mail-merge file

get

Returns the binary file generated by a mail merge from its UUID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

report_idintegerRequired

Mail merge identifier

file_uuidstring · uuidRequired

UUID of the generated file

Responses
200

Binary content of the generated file

application/octet-stream
string · binaryOptional
get/{app_short}/reports/{report_id}/results/{file_uuid}
200

Binary content of the generated file

Last updated

Was this helpful?