Mailing

Email mailing operations with document attachments and DocuSign integration

Create and send mailing

post

https://api.example.com/v1https://staging-api.example.com/v1

/mailing/create

Create a mailing with document attachments and send emails using DocuSign integration

Body

multipart/form-data

namestringRequired

Recipient's name

Example: John Doe

emailstring · emailRequired

Recipient's email address

Example: [email protected]

policyHolderIdstringOptional

Policy holder ID

Example: PH123456

passwordstringOptional

Password for the mailing

Example: securePassword123

policyNamestringOptional

Name of the policy

Example: Premium Health Policy

isNotCardholderbooleanOptional

Whether the recipient is not a cardholder

Example: false

envelopeIdstringRequired

DocuSign envelope ID

Example: envelope-123456

attachmentsstring · binary[]Optional

PDF attachments (up to 5 files, 5MB each)

Responses

200

Emails sent successfully

application/json

400

Missing required fields

application/json

413

File too large

application/json

415

Unsupported file type

application/json

500

Internal server error

application/json

post

/mailing/create

HTTPcURLJavaScriptPython

POST /v1/mailing/create HTTP/1.1
Host: api.example.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 226

{
  "name": "John Doe",
  "email": "[email protected]",
  "policyHolderId": "PH123456",
  "password": "securePassword123",
  "policyName": "Premium Health Policy",
  "isNotCardholder": false,
  "envelopeId": "envelope-123456",
  "attachments": [
    "binary"
  ]
}

{
  "status": "success",
  "message": "Emails sent successfully"
}