Creates a GeneralCorrespondenceDocument resource.
Through the general_correspondence_documents endpoint, General Correspondence PDF files can be sent to customers. The PDF documents must be converted to a base64 string and placed in the files field. One or more PDF files can be provided, POM will merge the PDFs in the order they are provided. The API validates whether the provided base64 strings represent valid PDF files.
### Sequence
POM will try to deliver the document to the customer in the order specified in the sequence field. If a message could not be delivered, POM will try delivering the message to the next channel in the sequence. The sequence object contains the channel the message should be sent to.
Depending on the channel, additional fields are required:
- letter: street_name, house_number, city, zip_code, country_code, is_registered
- email: email_address, subject, and email_template (optional if a default general correspondence email template is configured)
### Rate limit
Each request costs 40 points, regardless of the number of files attached. See the *Rate limiting* section at the top of this documentation for how the shared limit works.
### Additional Notes
- The file_name must end with .pdf.
- The description field represents the subject of the document. It is also the display name in MijnDossier. Therefore, we recommend making the description unique. Example: *'Invoice 12345'*
- An email sequence can optionally have primary_text and secondary_text fields. These fields allow you to customize the email body. If these fields are not provided, the default texts from the email template will be used.
- A letter sequence can optionally have an is_registered field. This field indicates whether the letter should be sent as a registered letter (with a signature upon receipt) or as a regular letter.
- A letter sequence can optionally have an envelope_profile_id field. This field specifies the envelope profile to use for the letter. The envelope must belong to the authenticated client or be a system envelope. The envelope profile ID can be retrieved from the POM Collect portal.
- The gender field in additional_data can have the values 0 (female), 1 (male) or omitted (unspecified).
curl -X POST "/v3/general_correspondence_documents" \
-H "Authorization: Bearer $POM_API_DOCUMENTATION_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"customer_number": "123456",
"file_name": "1234567890.pdf",
"description": "Updated Terms and Conditions",
"status_check_after_days": 3,
"files": [
"<base64-encoded-pdf-file-content>",
"<base64-encoded-pdf-file-content>"
],
"sequence": [
{
"channel": "email",
"email_address": "[email protected]",
"subject": "Your Document",
"email_template": 123,
"primary_text": "Dear Customer,\n\nPlease find your document attached in the button below.",
"secondary_text": "If you have any questions, feel free to contact us."
},
{
"channel": "letter",
"street_name": "Van Coulsterweg",
"house_number": "2A",
"zip_code": "2952CB",
"city": "Alblasserdam",
"country_code": "NL",
"is_registered": true,
"envelope_profile_id": 123
}
],
"variables": {
"variable1": "qwerty",
"variable500": "asdfg"
}
}'Authorization
AuthorizationstringheaderrequiredOAuth 2.0 client credentials Grant
Body
The new GeneralCorrespondenceDocument resource
customer_numberstringrequiredfile_namestringrequireddescriptionstring | nullstatus_check_after_daysinteger | nullfilesstring[]requiredsequenceobject[]requiredvariablesmap of stringadditional_dataAdditionalData-general_correspondence.write | null
Response
GeneralCorrespondenceDocument resource created
correspondence_idintegercustomer_numberstringfile_namestringdescriptionstring | nullclient_request_idstring | nullcreated_atstring<date-time>
{
"correspondence_id": 0,
"customer_number": "string",
"file_name": "string",
"description": "string",
"client_request_id": "string",
"created_at": "2026-01-15T09:30:00Z"
}