POST sms/save

Save a single SMS record.

* required

Parameters

Name

Type

Description

smsID

integer

Unique ID of an SMS

title

string

Used for display purposes only

messagingServiceID

string

Unique ID of messaging service used to send the SMS

message

string

Content of SMS

includeOptOutInstructions

boolean

Appends generic opt out instructions to the message

userID

integer

ID of system user the record belongs to

deliveryType

string

How SMS is sent

Allowed Values: MANUAL, AUTOMATED

recipients

object

contactIDs	array[integer]	Individual contacts assigned to receive the SMS. For larger sends, consider adding the contacts to a group and sending to the group. Contacts must have a mobile number to be assigned as a recipient of the SMS.
excludeGroupIDs	array[integer]	Exclude contacts in these groups from receiving the SMS
groupIDs	array[integer]	Groups assigned to receive the SMS

contactFrequency

string

Defines how often a contact can receive the SMS. Applies only to Automated SMS. If set to "once", contacts can be queued to receive the SMS only once. If set to "no limit", contacts can be queued to receive the SMS multiple times without a minimum delay in-between. If set to a user-defined value in the format of {value}{datepart}, contacts can be queued to receive the SMS multiple times, but with a minimum delay in-between. {datepart} values are defined as: d=day, ww=week, m=month, yyyy=year. Example values: "1d" = 1 day, "2ww" = 2 weeks, "3m" = 3 months, "1yyyy" = 1 year. Maximum allowed timeframe is 2 years.

dateScheduled

datetime

Date/time of scheduled delivery. Applies only to Manual SMS.

Response Data

Returns an SMS object

Name

Type

Description

contactFrequency

string

dateAdded

datetime

Date record was added

dateModified

datetime

Date record was modified

dateScheduled

datetime

Date/time of scheduled delivery. Applies only to Manual SMS.

dateSent

datetime

Date SMS was sent. Applies only to Manual SMS.

deliveryStatus

string

Status of delivery

deliveryType

string

How SMS is sent

includeOptOutInstructions

boolean

Appends generic opt out instructions to the message

message

string

Content of SMS

messagingServiceID

string

Unique ID of messaging service used to send the SMS

recipients

object

Applies only to Manual SMS.

contactIDs	array[integer]	Individual contacts assigned to receive the SMS
excludeGroupIDs	array[integer]	Groups excluded from receiving the SMS
groupIDs	array[integer]	Groups assigned to receive the SMS

smsID

integer

Unique ID of an SMS

title

string

Used for display purposes only

userID

integer

ID of system user the record belongs to

Permissions

Method requires the SMS Admin permission

Example Calls

Create manual SMS

POST

/sms/save

cURL

Copy

curl https://api.emailer.emfluence.com/v1/sms/save \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"title": "Example SMS Title",
		"deliveryType": "MANUAL"
	}'

Response Data

{"success":1,"data":{"message":"","userID":123,"dateModified":"2023-07-20 19:56:59","deliveryType":"MANUAL","recipients":{"groupIDs":[],"contactIDs":[],"excludeGroupIDs":[]},"dateScheduled":"","messagingServiceID":"","dateAdded":"2023-07-20 19:56:59","deliveryStatus":"Not Sent","includeOptOutInstructions":false,"smsID":123,"title":"Example SMS Title","dateSent":""},"code":0,"requestID":"AFE44244-939B-495E-BF9AFC6D50DAF145"}

Create automated SMS

POST

/sms/save

cURL

Copy

curl https://api.emailer.emfluence.com/v1/sms/save \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"title": "Example SMS Title",
		"deliveryType": "AUTOMATED"
	}'

Response Data

{"success":1,"data":{"message":"","userID":123,"dateModified":"2023-07-20 19:59:11","deliveryType":"AUTOMATED","messagingServiceID":"","contactFrequency":"once","dateAdded":"2023-07-20 19:59:11","deliveryStatus":"Inactive","includeOptOutInstructions":false,"smsID":123,"title":"Example SMS Title"},"code":0,"requestID":"CD1E32BB-F3BA-4712-A0CD8A4CBB8CF359"}

Update an SMS property

POST

/sms/save

cURL

Copy

curl https://api.emailer.emfluence.com/v1/sms/save \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"smsID": 123,
		"title": "New SMS Title"
	}'

Response Data

{"success":1,"data":{"message":"","userID":123,"dateModified":"2023-07-20 19:56:59","deliveryType":"MANUAL","recipients":{"groupIDs":[],"contactIDs":[],"excludeGroupIDs":[]},"dateScheduled":"","messagingServiceID":"","dateAdded":"2023-07-20 19:56:59","deliveryStatus":"Not Sent","includeOptOutInstructions":false,"smsID":123,"title":"New SMS Title","dateSent":""},"code":0,"requestID":"762033EC-755C-4965-ADCD80AEEAE986BC"}

Schedule SMS

POST

/sms/save

cURL

Copy

curl https://api.emailer.emfluence.com/v1/sms/save \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"smsID": 123,
		"dateScheduled": "2024-01-01 12:00:00"
	}'

Response Data

{"success":1,"data":{"message":"","userID":123,"dateModified":"2023-07-20 20:16:05","deliveryType":"MANUAL","recipients":{"groupIDs":[],"contactIDs":[],"excludeGroupIDs":[]},"dateScheduled":"2024-01-01 12:00:00","messagingServiceID":"","dateAdded":"2023-07-20 20:11:45","deliveryStatus":"Not Sent","includeOptOutInstructions":false,"smsID":123,"title":"Example SMS Title","dateSent":""},"code":0,"requestID":"90A0170E-CA2F-4517-9A87F28D1D2E4AA7"}

Assign Recipients

POST

/sms/save

cURL

Copy

curl https://api.emailer.emfluence.com/v1/sms/save \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"smsID": 123,
		"recipients": {
			"groupIDs": [456],
			"contactIDs": [789],
			"excludeGroupIDs": []
		}
	}'

Response Data

{"success":1,"data":{"message":"","userID":123,"dateModified":"2023-07-20 20:16:05","deliveryType":"MANUAL","recipients":{"groupIDs":[456],"contactIDs":[789],"excludeGroupIDs":[]},"dateScheduled":"2024-01-01 12:00:00","messagingServiceID":"","dateAdded":"2023-07-20 20:11:45","deliveryStatus":"Not Sent","includeOptOutInstructions":false,"smsID":123,"title":"Example SMS Title","dateSent":""},"code":0,"requestID":"36E03951-FBAB-406B-99AB28BCDA83C6EB"}

API Console

The console uses production data, so BE CAREFUL!

POST

sms/save

Request Body

{"message":"","userID":0,"deliveryType":"","dateScheduled":"","recipients":{},"messagingServiceID":"","contactFrequency":"","includeOptOutInstructions":0,"smsID":0,"title":""}

Access token: *