Skip to content

Get SMS Newsletter

Tool name: get-sms-newsletter

Reads one SMS newsletter: state, send date, text, sender, provider and link tracking of its SMS, audience, what still blocks scheduling, and app links.

Input schema

newsletterIdinteger, >= 1required

ID of the SMS newsletter, from search-sms-newsletters

accountIdnull or integer, >= 1

User ID of the account; omit for the account of the access token

Default:null
Input example
{ "newsletterId": 1, "accountId": null }

Output schema

accountIdintegerrequired
newsletterIdintegerrequired
namestringrequired
notesstringrequired
labelsArray of stringsrequired
statusstringrequired
Enum:"draft""scheduled""outgoing""sent"
isSplitTestbooleanrequired
smsobject or nullrequired
audienceobjectrequired
sendAtstring or nullrequired
missingForDispatchArray of stringsrequired
editUrlstringrequired
scheduleUrlstringrequired
statisticsUrlstringrequired
Output example
{ "accountId": 0, "newsletterId": 0, "name": "string", "notes": "string", "labels": [ "string" ], "status": "draft", "isSplitTest": true, "sms": { "smsId": 0, "text": "string", "senderName": "string", "provider": "string", "linkTracking": true, "contentUrl": "string" }, "audience": { "mode": "all_contacts" }, "sendAt": "string", "missingForDispatch": [ "string" ], "editUrl": "string", "scheduleUrl": "string", "statisticsUrl": "string" }