Send an Email

post/clicmanager.sendemail

Sends an email with attached document (e.g., a Quote) to the specified recipients using the Publishing Template. You can retrieve available publishing templates calling the configurationmanager.fetchtemplates/{TypeCode} endpoint.

Email Sending Rate Limits and Restrictions

To prevent misuse, such as email flooding or spam, the following rate limits and restrictions are applied:

Rate Limiting on clicmanager.sendemail Endpoint:

  • Each user account is restricted to calling this endpoint no more than 5 times (default) within a 5-minute period (default).
  • This limit is counted per partition.

Recipient Limitation in Payload:

  • The payload for the clicmanager.sendemail endpoint, which specifies recipients limits the number of recipients.
  • A default limit of 20 recipients.

To change these limits, adjust values for the following options in Advanced Configuration Options:

  • sendEmailMaxRecipients
  • sendEmailMinutesCountForThrottling
  • sendEmailMaxCountInLastMinutes
Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
required
object
typedId
required
string

typedId of the Quote you want to send as an email attachament.

templateName
required
string

A name of the existing template. See the Publishing Templates documentation.

attachmentType
required
string

Select the type of the attachment template.

Possible values: "WORD" "PDF" "EXCEL"
subject
required
string
emailText
string
attachedFiles
string

typedId of the attachment you want to send together with the Quote. This must be an existing attachment. You can upload a file on the Attachments tab of the document.

required
Array of objects
Array
email
required
string
name
string
Responses
200

A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null.

Response Schema: application/json
object
node
string
data
object or null
status
integer
startRow
integer
endRow
integer
Request samples
application/json
{
  • "data": {
    • "typedId": "2147491329.Q",
    • "templateName": "word",
    • "attachmentType": "WORD",
    • "subject": "Quote P-2147491329",
    • "emailText": "You can call me at…",
    • "attachedFiles": "1147.BD",
    • "recipients": [
      • {
        • "name": "admin",
        • "email": "ondrej.tesar@pricefx.com"
        }
      ]
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": null,
    • "status": 0,
    • "startRow": 0,
    • "endRow": 0
    }
}