{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/campaigns","auth":"required","method":"post","params":[{"name":"campaign_id","type":"string","default":"test_campaign_CxkoWx","desc":"The campaign_id or \"slug\" can be found in the <a href=\"http://docs.sendsonar.com/docs/campaigns#define\" target=\"_blank\">Define</a> tab of the specific campaign you're trying to send.","required":true,"in":"body","ref":"","_id":"573a21f742978932007137c4"},{"name":"to","type":"string","default":"+13105551234","desc":"The phone number of the person to whom you want to send the Campaign.","required":true,"in":"body","ref":"","_id":"573a21f742978932007137c3"},{"name":"send_at","type":"string","default":"","desc":"Timestamp in the format: ISO-8601 to schedule a campaign to go out in the future.","required":false,"in":"body","ref":"","_id":"5f9a2cb82eb806005f0ee1d1"}],"results":{"codes":[{"name":"","code":"{\n  \"to\":\"+13105551234\",\n  \"text\":\"sent\",\n  \"status\":\"queued\"\n}","language":"json","status":202},{"code":"{\n  \"to\":\"+13105551234\",\n  \"text\":\"sent\",\n  \"status\": \"unsubscribed\"\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"curl 'https://www.sendsonar.com/api/v1/campaigns' \\\n\t-X POST \\\n  -H 'X-Token:XXXXXXXXXXXXXXXXXXXXXXXX' \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"campaign_id\": \"XXXXXXXX_XXXX_XXXX\", \"to\": \"+13105551234\"}'","language":"curl"}]}},"next":{"description":"","pages":[]},"title":"Send Campaign","type":"endpoint","slug":"send-campaign","excerpt":"","body":"## Documentation\nIn the response, \"status\" will either be \"queued\" or \"unsubscribed\". A \"queued\" status is a successful response and means that the message should be sent within seconds. An \"unsubscribed\" status means that the message will not be sent, as the customer has previously unsubscribed from messages from your business.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Country Code\",\n  \"body\": \"Please always include a country code (such as +1 for US) in all API calls to us.\"\n}\n[/block]","updates":[],"order":15,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"573a20b817422532001d33e0","createdAt":"2016-05-16T19:34:16.087Z","editedParams":true,"project":"55208137623ff50d009b2bec","category":{"sync":{"isSync":false,"url":""},"pages":["55494ad0ee219b0d001743bb","55494b05f452670d00ec0c29","55494b11ee219b0d001743bf","55494b20ee219b0d001743c1","55494b2bee219b0d001743c3","55494b4a6a82a10d00817af5","55494b686a82a10d00817af9","5549651ccd09b317005f8f50","55497273cd09b317005f8f86","554977f0c634cf2d001250a7","55b970eab42b610d00c9b2e3","5696f3688560a60d00e2c216","5696f91c59a6692d003fad50","5696f92c24490c3700170a2d","5696f9700b09a41900b24422"],"title":"Public API","slug":"public-api","order":3,"from_sync":false,"reference":true,"_id":"55494a226a82a10d00817ae5","createdAt":"2015-05-05T22:54:26.925Z","project":"55208137623ff50d009b2bec","version":"55208137623ff50d009b2bef","__v":15},"githubsync":"","user":"554966ffcd09b317005f8f61","__v":7,"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["55208138623ff50d009b2bf0","55494a226a82a10d00817ae5","55494ba7ee219b0d001743c8","55494bc1ee219b0d001743cc","56ead8c1df765617008bccaf","573a2073dd007d1700cf288f","579695b1f64c9f0e007cd76c","57969e3dfa1ff60e006a1274","579a4592fd9f3c0e008e4f4a","57ab9afe54fa780e006c5430","57b784f5b7ebd60e009cb4a6","58f686818193090f008cec76","59e79fbd4cf31900341d50c6","5b2436973fd93f0003dcf99d","5d824fb2ce98a801366098a2","61096ffb8de715001695ae54"],"_id":"55208137623ff50d009b2bef","createdAt":"2015-04-05T00:26:31.564Z","releaseDate":"2015-04-05T00:26:31.563Z","__v":16,"project":"55208137623ff50d009b2bec"},"parentDoc":null,"editedParams2":true}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

campaign_id:
required
stringtest_campaign_CxkoWx
The campaign_id or "slug" can be found in the <a href="http://docs.sendsonar.com/docs/campaigns#define" target="_blank">Define</a> tab of the specific campaign you're trying to send.
to:
required
string+13105551234
The phone number of the person to whom you want to send the Campaign.
send_at:
string
Timestamp in the format: ISO-8601 to schedule a campaign to go out in the future.

Examples


Result Format


Documentation

## Documentation In the response, "status" will either be "queued" or "unsubscribed". A "queued" status is a successful response and means that the message should be sent within seconds. An "unsubscribed" status means that the message will not be sent, as the customer has previously unsubscribed from messages from your business. [block:callout] { "type": "info", "title": "Country Code", "body": "Please always include a country code (such as +1 for US) in all API calls to us." } [/block]