SOAP API method ProcessedFaxMailing_createAccessKey
Description
The parameter options can hold the following options: begintime -> start time of the mailings. endtime -> end time of the mailings.
Parameters
| Name | Type | Description |
|---|---|---|
| id * | int | Unique identifier (id) of the object ProcessedFaxMailing. The method only applies to the processedfaxmailing with this id. |
| options * | Collection of type 'options' | |
| date * | string | Time the shared object stays alive in the format YYYY-mm-dd hh:mm:ss |
| title | string | The title of the shared page, default empty |
| login | Structure of type 'login' | Optional login data (soon deprecated) |
| access_token | string | Optional api access token |
| * required parameters | ||
Return values
| Name | Type | Description |
|---|---|---|
| value | string | This is the hash key which can be used to share the stats of the mailing |
Structure 'pair'
| Name | Type | Description |
|---|---|---|
| key | string | |
| value | string |
Structure 'options'
| Name | Type | Description |
|---|---|---|
| pair | Structure of type 'pair' |
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 |