SOAP API method ProcessedFaxMailing_destination
Description
A single destination of the mailing.
Parameters
Name | Type | Description |
---|---|---|
id * | int | Unique identifier (id) of the object ProcessedFaxMailing. The method only applies to the processedfaxmailing with this id. |
profile | Structure of type 'profile' | |
subprofile | Structure of type 'subprofile' | |
login | Structure of type 'login' | Optional login data (soon deprecated) |
access_token | string | Optional api access token |
* required parameters |
Return values
Name | Type | Description |
---|---|---|
emailingdestination | Structure of type 'emailingdestination' | |
smsmailingdestination | Structure of type 'smsmailingdestination' | |
faxmailingdestination | Structure of type 'faxmailingdestination' |
Structure 'profile'
Name | Type | Description |
---|---|---|
id | int | The ID of the profile. |
code | string | The code of the profile. |
extra | string | The extra data of the profile. |
created | timestamp | The timestamp when the profile was created. |
modified | timestamp | The timestamp when the profile was last modified. |
lastexport | timestamp | The last timestamp when the profile was exported. |
fields | Map | Map of all fields of the profile, this property is only returned when the parameter 'allproperties' is set to true |
interests | Map | Map of all interests of the profile, this property is only returned when the parameter 'allproperties' is set to true |
Structure 'subprofile'
Name | Type | Description |
---|---|---|
id | int | The ID of the subprofile. |
code | string | The code of the subprofile. |
created | timestamp | The timestamp when the subprofile was created. |
modified | timestamp | The timestamp when the subprofile was last modified. |
lastexport | timestamp | The last timestamp when the subprofile was exported. |
fields | Map | Map of all fields of the subprofile, this property is only returned when the parameter 'allproperties' is set to true |
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 'emailingdestination'
Name | Type | Description |
---|---|---|
emailclient | string | Get the last registered email client for this destination |
id | string | The ID of the destination. |
timestamp | timestamp | The timestamp of the sent mailing. |
result | string | The result for this destination. |
Structure 'smsmailingdestination'
Name | Type | Description |
---|---|---|
id | string | The ID of the destination. |
timestamp | timestamp | The timestamp of the sent mailing. |
result | string | The result for this destination. |
Structure 'faxmailingdestination'
Name | Type | Description |
---|---|---|
id | string | The ID of the destination. |
timestamp | timestamp | The timestamp of the sent mailing. |
result | string | The result for this destination. |