Update a job.

Update the job information.

Function

• updateJob()

Url

• POST: /PuresendService/v1/updateJob

Parameters

• jobInfo: Job
  • Job object.

Return

• statusCode: int
  • 1: success
  • 0: failed

Exception

• Exception

Documentation

• Update a newly created job. use the function:updateJob().
• Can update the job as long as it is in the draft status.
• Cannot update the job once it has started.
• Job data that can be updated using the Job object is as follows, use at most:
  • list ids,
  • suppression ids,
  • cluster names,
  • rule set,
  • message id,
  • friendly from,
  • from,
  • subject,
  • scheduled date,
  • Friendly Reply-To,
  • Reply-To,
  • From format,
  • search criteria ID,
  • Skip the first,
• Premium Job settings:
  • type : The type of Premium Job, which can be one of the following:
    • sparkpost
    • mailgun
    • smtp
  • domains: The domains associated with the Premium Job.
  • ipPools: The IP pools used for the Premium Job.
  • username: the username for the Premium Job
  • personalName: the personal name for the Premium Job

Examples

{
    "jobId" : 45902,
    "jobName" : "test job name",
    "listIds" : [9340,9344],
    "suppressionIds" : [],
    "clusterNames" : ["psmessagecom"], 
    "rulesetId" : 1,
    "messageId" : 17924,
    "friendlyFrom" : "test frindly from",
    "from" : "test@from.com",
    "subject" : "test subject",
    "friendlyReplyTo" : "test frindly reply to",
    "replyTo" : "test@reply.to",
    "scheduledDate" : "2023/03/06 13:50:11",
    "emailFromFormat" : 1,
    "searchCriteriaId" : 0,
    "skipFirst" : 0,
    "useOnly" : 0,
    "status" : 0,
    "premium": {
        "type" : "sparkpost",
        "domains": ["choicesidehustle.com"],
        "ipPools": ["kb1"],
        "cluster": "psend_dev_com_shared_dev2",
        "username": "testUsename",
        "personalName": "testPersonal"
    },    
    "notes" : "test note",
    "tags" : "testTag",
    "jobLimit" : 40,
    "jobTime" : 5,
    "ipLimit" : 40,
    "ipTime" : 5
}

{
    "statusCode" : 1
}