Update an SMS Campaign

PUT

/sms-campaigns/{sms_campaign_id}

SMS Campaigns

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://rest.clicksend.com/v3/sms-campaigns/1' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body": "his is an awesome message.",
    "from": "+61353787447",
    "list_id": 428,
    "name": "Awesome campaign.",
    "schedule": 1444821615
}'

Response Example

{
    "data": {
        "body": "This is an awesome message.",
        "custom_string": null,
        "date_added": "1444962803",
        "from": "+61353787447",
        "ip_address": "192.168.10.1",
        "list_id": 428,
        "name": "Awesome campaign.",
        "schedule": "1444821615",
        "sms_campaign_id": 1,
        "source": null,
        "status": "Queued",
        "subaccount_id": 1,
        "user_id": 1
    },
    "http_code": 200,
    "response_code": "SUCCESS",
    "response_msg": "Your SMS Campaign has been updated."
}

Request

Path Params

sms_campaign_id

number

required

Your SMS Campaign id.

Example:

Body Params application/json

body

string

required

Your campaign message.

from

string

optional

Your sender id - more info.

list_id

number

required

Your list id.

name

string

required

Your campaign name.

schedule

number

optional

Leave blank for immediate delivery. Will replace existing schedule (even if left blank). Your schedule time as a unix timestamp.

Examples

Responses

🟢200OK

application/json

Body

object {0}

Get SMS Campaign

Cancel an SMS Campaign