Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated some copy. Added information on "DynamicFields" parameter.

...

Expand
titleClick here to learn more about request parameters...

All fields are mandatory

 

Parameter

Description

Type

Account ID

MailUp account ID.

Integer

List ID

List identifier for the selected list within that account.

Integer

List GUID

Hash code that identifies the same list. This parameter is unique to a list within the entire MailUp system, unlike the List ID, which is unique only within a given MailUp account.

String

ListSecret

The parameter described above and used to enable or disable the use of this API (it’s an auto-generated GUID).

String

CampaignCode

Used to aggregate statistics. If the value specified does not exist, a new record is created in the “SMS” table, otherwise the existing one is reused.

String

Content

The text of the message. No parsing nor length check is required.

SIZE LIMIT: messages longer than 459 characters are truncated by sending engine.

String

Recipient

The recipient’s number. Include the international prefix (either with 00 or +), or the default list prefix will be applied.

(Ask for MailUp standard regex for phone numbers).

Only a single phone number is allowed

Always check subscription status on specified list (SMS_Optin table)

  • New = subscribe and send

  • Subscribed = send

  • Pending or Unsubscribed = do not send

String

DynamicFields

An array of value pairs that allows you to use merge tags in your transactional text messages.String

IsUnicode

Boolean value indicating whether to use Western alphabets only (0 means "false"), or Eastern alphabets as well, such as Arabic, Russian, Chinese, and so on (1 means "true").

It is up to you to decide if the message contains Unicode characters.

Boolean

...