documents/{id}/contents/push/preview

Owned by Stephan Böhmig
Last updated: Feb 16, 2022
1 min read

Preview the push of content to a flex document. The method is almost identical to a regular push with the exception that it does NOT update any data in the target Flex document.

The method comes in handy in this rather common scenario: The caller needs to see the cost of a payload prior to proceeding with an actual push. Use the includeCost parameter for this purpose.

URL

(POST) /api/apps/wbflex/documents/{id}/contents/push/preview

PARAMETERS

All parameters are identical to documents/{id}/contents/push

RESULTS

The returned results is identical to documents/{id}/contents/push

The target Flex document will not be updated, no invoices are created, no jobs are started, no user is notified.

Note: An entry will be added to the log file in the project (next to the Flex document). This record is flagged as being a preview request.



Copyright Wordbee - Buzzin' Outside the Box since 2008