CAMPAGNE / Campaign.Update
Creazione e gestione delle campagne email
Aggiorna le informazioni e le caratteristiche di una campagna. Per avviare una nuova campagna รจ necessario prima creare la campagna con il comando Create quindi impostarne le caratteristiche utilizzando il comando Update
Esempio:
SessionID=yourSessionID &Command=Campaign.Update &ResponseFormat=JSON &CampaignName=yourValue
PARAMETRI RICHIESTA
| Parametro | Tipo di dato | Richiesto | Definizione |
|---|---|---|---|
| SessionID | string | Session ID which is needed to authenticate the access. It's optional and required for desktop applications only | |
| Command | string | The API Command sended to the console | |
| ResponseFormat | JSON | XML | Response format | |
| JSONPCallBack | bool | Send this parameter for cross-domain. More info about JSONP can be found here: http: //en.wikipedia.org/wiki/JSON#JSONP | |
| CampaignID | integer | Campaign ID to update | |
| CampaignStatus | string | {Draft | Ready | Sending | Paused | Pending Approval | Sent | Failed} - Set the cmapaign status | |
| CampaignName | string | Name of the campaign | |
| RelEmailID | integer | The email content of campaign (email ID) | |
| ScheduleType | string | {Not Scheduled | Immediate | Future | Recursive} - Type of the schedule | |
| SendDate | string | {YYYY-MM-DD} - Date to send campaign | |
| SendTime | string | {HH: MM: SS} - Time to send campaign | |
| SendTimeZone | string | Time zone of the schedule date | |
| ScheduleRecDaysOfWeek | string | {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7} - (Recursive scheduling) separate values with comma (,). Enter 0 for every day | |
| ScheduleRecDaysOfMonth | string | {0 | 1 | 2 | 3 | 4 | 5 | ... | 31} - (Recursive scheduling) separate with comma (,). Enter 0 for every day | |
| ScheduleRecMonths | string | {0 | 1 | 2 | ... | 12} - (Recursive scheduling) separate with comma (,). Enter 0 for every month | |
| ScheduleRecHours | string | {0 | 1 | 2 | ... | 23} - (Recursive scheduling) separate with comma (,) | |
| ScheduleRecMinutes | string | {0 | 1 | 2 | ... | 59} - (Recursive scheduling) separate with comma (,) | |
| ScheduleRecSendMaxInstance | integer | (Recursive scheduling) number of times to repeat campaign sending (enter 0 for unlimited) | |
| ApprovalUserExplanation | string | User explanation for the campaign if campaign is pending for approval | |
| GoogleAnalyticsDomains | string | Domains to track with Google Analytics (seperate domains with line break (\n)) | |
| RecipientListsAndSegments | string | Target subscriber lists and segments. Each segment and list is seperated by comma. Format: ListID: SegmentID,ListID: SegmentID Ex: 3: 0,3: 2 | |
| RelSmsID | interger | Attach sms to campaign trough SmsID |
PARAMETRI DI RISPOSTA
| Parametro | Tipo di dato | Definizione |
|---|---|---|
| Success | bool | States if an error has been generated during last command execution or not |
| ErrorCode | integer | The ErrorCode number, if an error has occurred. ErrorCode = 0 means no error has occurred. |
CODICI DI ERRORE
| Codice | Definizione |
|---|---|
| 1 | Missing campaign ID |
| 2 | Invalid campaign ID |
| 3 | Invalid campaign status value |
| 4 | Invalid email ID or sms ID |
| 5 | Invalid campaign schedule type value |
| 6 | Missing send date |
| 7 | Missing send time |
| 8 | Day of month or day of week must be provided for recursive scheduling |
| 9 | Months must be provided for recursive scheduling |
| 10 | Hours must be provided for recursive scheduling |
| 11 | Minutes must be provided for recursive scheduling |
| 12 | Number of times to repeat must be provided for recursive scheduling |
| 13 | Time zone for scheduling is missing |
| 99998 | Authentication failure or session expired |
| 99999 | Not enough privileges |