Browse a specific survey's sendings: A collection of IDs for participants in the sending. For inquiries, this is a list of past participants to remind you of.<\/p>\n\n\n\n A collection of data to create new participants. Max 1000. These are converted and moved to participants during processing.<\/p>\n\n\n\n The phone number to use when sending on the SMS channel.<\/p>\n\n\n\n The email address to use when sending on the email channel.<\/p>\n\n\n\n A dictionary of additional properties that can be used when you template messages. Can also be used to categorize participants and template questions.<\/p>\n\n\n\n Which channels the broadcast should be sent on. Valid values \u200b\u200bare SMS and Email. More may be added in the future. At least one is required, and only participants who have applicable target properties will be sent on specific channels (e.g. phone number for SMS).<\/p>\n\n\n\n Like participant properties but default values \u200b\u200bused when a participant lacks the specific property.<\/p>\n\n\n\n If there is a need to schedule a shipment in the future, there is the option to do so with our delivery time windows.<\/p>\n\n\n\n You can have as many windows as you want. This allows you to send messages at specific times over several days, for example, every day between 10:00 and 10:05 on weekdays.<\/p>\n\n\n\n The request will be rejected if windows overlap.<\/p>\n\n\n\n If no windows are given, we will create a window that will apply the parsing rule above.<\/p>\n\n\n\n Channel-specific details for the SMS channel.<\/p>\n\n\n\n Channel-specific information for the email channel.<\/p>\n\n\n\n Sender name\/ID to use for either SMS or email.<\/p>\n\n\n\n Avs\u00e4ndarens e-postadress att anv\u00e4nda f\u00f6r e-postutskick.<\/p>\n\n\n\n SMS message text. Participant properties can be created as templates using brackets ({}). A special template {url} can be added to place the link to the survey at a specific location in the message. If {url} is not included, it will be added after two line breaks at the end of the message.<\/p>\n\n\n\n The email subject to use in all emails.<\/p>\n\n\n\n A message to participants that will be included in the emails along with the link to the survey.<\/p>\n\n\n\n Sending ID, used to refer to the sending<\/p>\n\n\n\n Survey ID of the survey to which the sending belongs.<\/p>\n\n\n\n The current status of the broadcast or a specific channel. Available statuses include the following.<\/p>\n\n\n\n SMS batch ID that refers to sent or scheduled messages on the SMS channel.<\/p>\n\n\n\n Email IDs that refer to sent or scheduled emails on the email channel.<\/p>\n\n\n\n ID of the channel participant whose message is waiting for delivery.<\/p>\n\n\n\n ID of channel participant whose message delivery has been confirmed or scheduled externally.<\/p>\n\n\n\n ID of channel participant whose message could not be delivered.<\/p>","protected":false},"excerpt":{"rendered":" Skicka enk\u00e4ter Endpoints Bl\u00e4ddra en specifik enk\u00e4ts utskick: GET surveys\/{surveyId}\/sendings L\u00e4sa en specifik enk\u00e4ts utskick: GET surveys\/{surveyId}\/sendings Skicka en specifik enk\u00e4t: POST surveys\/{surveyId}\/sendings Anropsdata-typ participants En samling ID:n f\u00f6r deltagare i s\u00e4ndningen. F\u00f6r f\u00f6rfr\u00e5gningar \u00e4r detta en lista \u00f6ver tidigare deltagare att p\u00e5minna om. newParticipants En samling data f\u00f6r att skapa nya deltagare. Max 1000. […]<\/p>","protected":false},"author":1,"featured_media":0,"parent":228,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"developer.php","meta":{"_import_markdown_pro_load_document_selector":0,"_import_markdown_pro_submit_text_textarea":"","footnotes":""},"class_list":["post-307","page","type-page","status-publish","hentry"],"yoast_head":"\nGET surveys\/{surveyId}\/sendings<\/code>
Read a specific survey's sendings: GET surveys\/{surveyId}\/sendings<\/code>
Send a specific survey POST surveys\/{surveyId}\/sendings<\/code><\/p>\n\n\n\nRequest Data Type<\/h2>\n\n\n
\n{\n "participants": [\n "5f806d30591746f32872e96e"\n ],\n "newParticipants": [\n {\n "phoneNumber": "46712345678",\n "emailAddress": "test@example.com",\n "properties": {\n "firstName": "John"\n }\n }\n ],\n "channels": [\n "Sms",\n "Email"\n ],\n "defaultProperties": {\n "firstName": ""\n },\n "deliveryWindows": [\n {\n "opens": "2021-11-12T11:57:12.2013982Z",\n "closes": "2021-11-19T11:57:12.2013982Z"\n }\n ],\n "sms": {\n "sender": "iP1",\n "body": "Survey time {firstName}"\n },\n "email": {\n "sender": "iP1",\n "senderAddress": "survey@ip1marketing.com",\n "subject": "Survey time",\n "message": "Here's the survey"\n }\n}\n\n<\/pre><\/div>\n\n\ndeltagare<\/h3>\n\n\n\n
newParticipants<\/h3>\n\n\n\n
phoneNumber<\/h3>\n\n\n\n
emailAddress<\/h3>\n\n\n\n
properties<\/h3>\n\n\n\n
channels<\/h3>\n\n\n\n
defaultProperties<\/h3>\n\n\n\n
deliveryWindows<\/h3>\n\n\n\n
Parsing<\/h4>\n\n\n\n
\n
null<\/code> in the field opened will be replaced with the current date and time.<\/li>\n\n\n\ncloses <\/code>is null <\/code>the field will be set to 7 days (168 hours) after the field is opened<\/li>\n<\/ul>\n\n\n\nsms<\/h3>\n\n\n\n
email<\/h3>\n\n\n\n
sender<\/h3>\n\n\n\n
senderAddress<\/h3>\n\n\n\n
body<\/h3>\n\n\n\n
subject<\/h3>\n\n\n\n
message<\/h3>\n\n\n\n
Response data type<\/h2>\n\n\n
\n{\n "id": "600ade98a11bf89ac18b5d76",\n "surveyId": "5f9028d2d60d0f12d4db4e67",\n "status": "Delivered",\n "participants": [\n "5f806d30591746f32872e96e",\n "5f903a70490f3c2d48fea8d3"\n ],\n "newParticipants": [],\n "channels": [\n "Sms",\n "Email"\n ],\n "defaultProperties": {},\n "deliveryWindows": [\n {\n "opens": "2021-11-12T11:57:12.2013982Z",\n "closes": "2021-11-19T11:57:12.2013982Z"\n }\n ],\n "sms": {\n "sender": "iP1",\n "body": "Survey time {firstName}\\n\\n{url}",\n "batchId": "600ade99e66b6b1fc8aada38",\n "pendingParticipants": [],\n "deliveredParticipants": [\n "5f806d30591746f32872e96e",\n "5f903a70490f3c2d48fea8d3"\n ],\n "failedParticipants": [],\n "status": "Delivered"\n },\n "email": {\n "sender": "iP1",\n "subject": "Survey time",\n "message": "Here's the survey",\n "emailIds": [\n "2c2d2930b0254b8fb8a834670e7f31ef",\n "ec0814ff12074597b6fb73d85f5261c6"\n ],\n "pendingParticipants": [],\n "deliveredParticipants": [\n "5f806d30591746f32872e96e",\n "5f903a70490f3c2d48fea8d3"\n ],\n "failedParticipants": [],\n "status": "Delivered"\n }\n}\n\n<\/pre><\/div>\n\n\nid<\/h3>\n\n\n\n
surveyId<\/h3>\n\n\n\n
status<\/h3>\n\n\n\n
Status<\/th> Description<\/th><\/tr><\/thead> New<\/td> The sending has just been created and no processing has started.<\/td><\/tr> Pending<\/td> The sending has started the first stage of processing, generating participants<\/td><\/tr> Ready<\/td> The broadcast or channel is ready to be sent.<\/td><\/tr> Failed<\/td> The broadcast or channel could not be delivered.<\/td><\/tr> Sent<\/td> The broadcast or channel has been sent but delivery is still unconfirmed<\/td><\/tr> Delivered<\/td> The broadcast or channel has been delivered in full or externally scheduled<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n batchId<\/h3>\n\n\n\n
emailIds<\/h3>\n\n\n\n
pendingParticipants<\/h3>\n\n\n\n
deliveredParticipants<\/h3>\n\n\n\n
failedParticipants<\/h3>\n\n\n\n