Preview a receivable's email message

POST

/receivables/:receivable_id/preview

receivable_idstringRequired

Auth

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

This endpoint expects an object.

body_textstringRequired=1 character

Body text of the content

subject_textstringRequired=1 character

Subject text of the content

languageenumOptional

Language code for localization purposes

typeenumOptional

Allowed values: receivablediscount_reminderfinal_reminder

The type of the preview document.

Successful Response

body_previewstring

subject_previewstring

1	curl -X POST https://api.sandbox.monite.com/v1/receivables/receivable_id/preview \
2	-H "x-monite-version: 2024-01-31" \
3	-H "x-monite-entity-id: x-monite-entity-id" \
4	-H "Authorization: Bearer <token>" \
5	-H "Content-Type: application/json" \
6	-d '{
7	"body_text": "body_text",
8	"subject_text": "subject_text"
9	}'

1	{
2	"body_preview": "body_preview",
3	"subject_preview": "subject_preview"
4	}