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

BearerAuth

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

HTTPcURLJavaScriptPython

GET /{app_short}/report_templates HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Available mail-merge templates

{
  "templates": [
    {
      "id": 1,
      "name": "text",
      "listingMode": true,
      "templateEngine": "text"
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "server_time": 1
}

List mail merges for a submission

get

Returns all mail merges generated for a given submission.

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

GET /{app_short}/reports?submission=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Paginated list of mail merges

{
  "reports": [
    {
      "id": 1,
      "status": "text",
      "original_document": {
        "file_uuid": "text",
        "file_name": "text"
      },
      "pdf_document": {
        "file_uuid": "text",
        "file_name": "text"
      },
      "errorMessage": "text"
    }
  ],
  "total_count": 1,
  "next_page": 1,
  "server_time": 1
}

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

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

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

Body

application/json

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

HTTPcURLJavaScriptPython

POST /{app_short}/reports HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "template_id": 1,
  "submission_id": "123e4567-e89b-12d3-a456-426614174000",
  "api_callback": "text",
  "header_name": "text",
  "header_value": "text",
  "join_format": "original"
}

200

Mail merge created

{
  "report_id": 1
}

Get mail merge information

get

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

Authorizations

BearerAuth

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}

HTTPcURLJavaScriptPython

GET /{app_short}/reports/{report_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Mail merge information

{
  "id": 1,
  "status": "text",
  "original_document": {
    "file_uuid": "text",
    "file_name": "text"
  },
  "pdf_document": {
    "file_uuid": "text",
    "file_name": "text"
  },
  "errorMessage": "text"
}

Download a generated mail-merge file

get

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

Authorizations

BearerAuth

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}

HTTPcURLJavaScriptPython

GET /{app_short}/reports/{report_id}/results/{file_uuid} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Binary content of the generated file

binary