Skip to content

SMS object

The sms object allows you to modify or create SMS messages via our messaging endpoints.

1
2
3
4
5
6
7
8
9
{
    "subscription_group_id": (required, string) the ID of your subscription group,
    "message_variation_id": (optional, string) used when providing a campaign_id to specify which message variation this message should be tracked under,
    "body": (required, string),
    "app_id": (required, string) see App Identifier,
    "media_items" :(optional, array) use this field to pass an image URL in an MMS to send an image with your message,
    "link_shortening_enabled": (optional, boolean) use this field to turn on link shortening and campaign-level click tracking,
    "user_click_tracking_enabled": (optional, boolean) if link_shortening_enabled is true, use this field to turn on link shortening, and campaign-level and user-level click tracking.     
}
  • App identifier
    • Any valid app_id from an app configured in your workspace will work for all users in your workspace, regardless of whether the user has the specific app on their profile or not.
HOW HELPFUL WAS THIS PAGE?
New Stuff!