Attach a report

POST

/communication/template-text/template-texts/{id}/locales/{locale}/attachments/reports

Required scope: templatetext:update

Attaches a report to a language of an e-mail template. The report is generated as a PDF when the mail is sent. The url that Ramos reads (ramos://report/?report.report_id=&name=value...) is built here from the parameters, in the order they are given, then report.skuFormat.id and report.language.id (in that order) if they are set. Values are not URL-encoded, so a {placeholder} is replaced when the mail is sent; the file name and the url can then be longer than they are here, and Ramos allows 255 characters for the name and 512 for the url, so leave room. A language can have at most 20 attachments. The attachment is written to every active row of the language in notificationtemplateattachment (each country row and the row of all other countries), in the same all-or-nothing save as any other change of the template, and the history gets an entry with the unchanged body. Only e-mail templates can have attachments.

Parameters

Path parameters

locale string

Locale code (e.g. 'sv', 'en').

Request body

Response

The attachment that was added.

Error code	Description
`attachments-not-supported`	The template is an SMS or an invoicetext; only an e-mail can have attachments.
`duplicate-attachment-name`	The language already has an attachment with the file name, in any case.
`invalid-attachment-description`	The description is blank or longer than 2000 characters.
`invalid-attachment-name`	The file name is blank, longer than 255 characters, does not end with .pdf or has a character that a file name cannot have (/ : * ? " < > \| or a control character).
`invalid-report-parameter`	A parameter name or value is not allowed (names: letters, digits, dot, underscore, hyphen, and not report.report_id, report.language.id or report.skuFormat.id; values: empty, the same characters, or one {placeholder} of letters, digits and underscore), an id is negative, or the url would be longer than 512 characters.
`locale-not-found`	The template does not have the locale.
`report-not-found`	No active, visible report with the id exists in Ramos.
`template-changed`	Another request changed the template after it was read, so nothing was saved. Reload the template and try again.
`template-not-found`	No template with the given code exists for the current company.
`too-many-attachments`	The language already has 20 attachments.

Attach a report

Parameters ​

Path parameters

Request body ​

Response ​

Parameters

Request body

Response