{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/campaigns/send_personalized_campaign","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\"status\": \"queued\"}","language":"json","status":200}]},"params":[{"name":"campaign_id","type":"string","default":"","desc":"Campaign slug from edit campaign page","required":true,"in":"body","ref":"","_id":"6115563203a994001cf6ac13"},{"name":"to","type":"string","default":"","desc":"The number of the customer to send the campaign to","required":true,"in":"body","ref":"","_id":"610aad2f0f83dd030e21fcb2"},{"name":"first_name","type":"string","default":"","desc":"The customer's first name","required":false,"in":"body","ref":"","_id":"610aad2f0f83dd030e21fcb3"},{"name":"last_name","type":"string","default":"","desc":"The customer's last name","required":false,"in":"body","ref":"","_id":"610aad2f0f83dd030e21fcb4"},{"name":"timezone","type":"string","default":"","desc":"The customer's time zone","required":false,"in":"body","ref":"","_id":"610aad2f0f83dd030e21fcb5"},{"name":"zipcode","type":"string","default":"","desc":"The customer's zipcode","required":false,"in":"body","ref":"","_id":"610aad2f0f83dd030e21fcb6"},{"name":"customer_properties","type":"object","default":"","desc":"Custom properties to add to the customer. Can be used in the campaign message","required":false,"in":"body","ref":"","_id":"610aad2f0f83dd030e21fcb7"}],"examples":{"codes":[{"code":"curl 'https://www.sendsonar.com/api/v1/campaigns/send_personalized_campaign' \\\n  -X POST \\\n  -H 'X-Token:XXXXXXXXXXXXXXXXXXXXXXXX' \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"campaign_id\": \"MyCampaign_123abc\", \"to\": \"+13105551234\", \"first_name\": \"John\", \"last_name\": \"Wayne\", \"customer_properties\": {\"preferred_greeting\": \"Howdy!\"}'","language":"curl"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Send Personalized Campaign","type":"endpoint","slug":"personalized-campaign","excerpt":"","body":"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.","updates":[],"order":11,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"610aad2f0f83dd030e21fcb0","createdAt":"2021-08-04T15:07:27.436Z","user":"5b4fb2cbfd2ffc0003f01f5e","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},"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"},"project":"55208137623ff50d009b2bec","__v":7,"parentDoc":null}

postSend Personalized Campaign


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

campaign_id:
required
string
Campaign slug from edit campaign page
to:
required
string
The number of the customer to send the campaign to
first_name:
string
The customer's first name
last_name:
string
The customer's last name
timezone:
string
The customer's time zone
zipcode:
string
The customer's zipcode
customer_properties:
object
Custom properties to add to the customer. Can be used in the campaign message

Examples


Result Format


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.