Edit Schedule

Application must have a scheduled SMS campaign to further modify it and also must save a Group ID of an SMS campaign to be rescheduled. In order to edit a scheduled slot, there should a minimum gap of 5mins before its execution. API for editing an SMS slot will be in the following format:

curl -X GET \
'<BASE_URL>&method=sms.schedule&groupid=22xxxxxxxx&time=dd%2Fmm%2Fyyyy%20hh%3Amm%20PM&&task=modify'

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Parameter Description Expected Values
URL URL of your SMS Service URL
method Predefined method sms.schedule
groupid group id whose schedule needs to be edited group id that has to be edited
task Specifies that the scheduled time should be modified to the one mentioned within time parameter modify
time Time to which the slot needs to be re-scheuled EX Format: YYYY-MM-DD HH:MM:SS OR YYYY-MM-DD HH:MM AM/PM

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Parameter Description Expected Values
format Output format should be as specified by this variable XML/PHP/JSON/JSONP. Default response will be in JSON

Example Responses

JSON

{
  "status": "OK",
  "data": "",
  "message": "Campaign updated successfully"
}

Error Response

{
    "status":"A431",
    "message":"Invalid Group ID"
}

Response Data

Field Description
status It indicates the success or failure of your request.
message It indicates the success or failure message.

Expected API Error Codes:

Code Message
A431 Invalid Group ID
A434 Campaign within next 5 minutes cannot be modified/cancelled.