Back to API references

SOAP API method PdfDocument_createFaxMailing

Description

Create a fax mailing based on this pdfdocument.

Parameters

Name Type Description
id * int Unique identifier (id) of the object PdfDocument. The method only applies to the pdfdocument with this id.
personalize_profile int Profile ID for which the object should be personalized
personalize_subprofile int Subprofile ID for which the object should be personalized
personalize_timestamp string The timestamp for the personalization
profile int ID of the profile
subprofile int ID of the subprofile
database int ID of the database
view int ID of the view
collection int ID of the collection
miniview int ID of the miniview
faxmailingsettings * Structure of type 'faxmailingsettings' The settings of the mailing
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
processedfaxmailing Structure of type 'processedfaxmailing'
scheduledfaxmailing Structure of type 'scheduledfaxmailing'

Structure 'faxmailingsettings'

Name Type Description
registerstatus boolean Get if the status should be registered for the mailing?
starttime timestamp The starttime of the mailing.
dateinterval DateInterval The interval for the mailing.
iterations int The iterations of the settings.
description string The description of the mailing.
processedmissediterations boolean The processed missed iterations.
personalized boolean Should the mailing be personalized?.
test boolean Is this a test mailing?.
nodoubles boolean Should the double addresses be skipped?.
messagesperminute int The max number of messages that are sent withing one minute
isscheduled boolean Is the mailing a scheduled mailing?
extradocumentproperties Map Get the extra document properties of this mailing. This doen't contain the
priority int The priority settings of the mailing.

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt

Structure 'processedfaxmailing'

Name Type Description
registerstatus. boolean Will the status be registered?
destinationcount int The number of destinations of the faxmailing.
id int Get the ID of the mailing.
timestamp timestamp The timestamp when the mailing was sent.
description string The description of the mailing.
personalized boolean Was this mailing personalized?.
nodoubles boolean Should the mailing be send to double mailaddresses?.
individual boolean Was this mailing sent to an individual?.
test boolean Was this mailing a test?
type string The type of the mailing.
messagesperminute int The max number of messages that are sent withing one minute
archived boolean The mailing is archived.
priority int Priority of the mailing. Higher value indicates higher priority.

Structure 'scheduledfaxmailing'

Name Type Description
registerstatus boolean Will the status be registered?.
description string The description of the scheduled mailing
test boolean Was this a test mailing?.
personalized boolean Was this mailing personalized?.
nodoubles boolean Was the target contains doubles?.
messagesperminute int The max number of messages that are sent withing one minute
priority int Priority of the mailing. Higher value indicated higher priority.
nextstarttime timestamp The next time when this scheduled event will run.
schedulediterations int The number of iterations that are still remaining.
processediterations int The number of iterations that were already processed.
previousstarttime string The starttime of the last iteration.
processmissediterations boolean Will the missed iterations be processed anyway?.
id int The ID of the scheduledevent.