v1

latestOpenAPI 3.0.02026-08-067074272.5 KB

Group Messages

Create a new group message.

Create a regular, scheduled, or recurring group message.

Mode	Fields to include
Immediate	Omit schedule_date_utc and repeat_settings
One-time scheduled	schedule_date_utc only (future UTC)
Recurring	schedule_date_utc + repeat_settings

See the repeat_settings schema for repeat mode rules and allowed values.

post/dashboards/{dashboard_id}/groupmessages

Path parameters

dashboard_idinteger required

Example:121

Id of dashboard

Request body

bodystring required

The message body. This should be 1600 characters in length or less. If the body exceeds 1600 characters, a 400 bad request will be returned. This field is required.

phone_numbersstring[]

The phone numbers this group message is sending to. You can use this in conjunction with group_ids. You must include either this or group_ids for the request to be valid. This cannot be more than 5,000 contacts.

group_idsinteger[]

The group ids of the groups this group message is sending to. You can use this in conjunction with phone_numbers. You must include either this or phone_numbers for the request to be valid. If you wish to send a group message to more than 5,000 contacts, you must use this and not phone_numbers.

excluded_phone_numbersstring[]

The phone numbers this group message should not send to. This is useful if you want to send to a group, but you want to exclude a few contacts.

mms_mediastring[]

An array of Text Request MMS media urls to access the mms media to be attached and sent with this message (see /mms). This argument is optional and can be omitted, set to null, or set to an empty array.

schedule_date_utcstring date-time

Timestamp of the next scheduled send for this message. If this timestamp is in the past, the message has been sent and is completed.

Field	Rule
repeat_by	Required. Must be day, week, month, or year (plural forms days, weeks, months, years are also accepted).
step	Required. Must be an integer ≥ 1. See Understanding step below.
schedule_date_utc	Required on the parent request whenever repeat_settings is present. Must be a future UTC timestamp for the first send.

step	repeat_by	Meaning
1	day	Every day
2	day	Every 2 days
3	day	Every 3 days
14	day	Every 14 days
1	week	Every week
2	week	Every 2 weeks (biweekly)
4	week	Every 4 weeks
1	month	Every month (same day of month as schedule_date_utc)
2	month	Every 2 months
3	month	Every 3 months (quarterly)
1	year	Every year (same month/day as schedule_date_utc)
2	year	Every 2 years

Field	Rule
times	Stop after this many total sends (including the first).
end_date	Stop after this UTC date. Must be in the future.
(neither)	The series repeats until you cancel it.

repeat_by	Meaning (N = step)	Extra fields
day	Repeats every N day(s)	—
week	Repeats every N week(s)	Optional days array for specific weekdays
month	Repeats every N month(s) on the same day of month as schedule_date_utc	—
year	Repeats every N year(s) on the same month/day as schedule_date_utc	—

Example request

{
  "body": "Don't forget the Family and Friends sale at our Toledo location on 6-15-2021 at 8:00PM!",
  "phone_numbers": [
    "14235839662",
    "14235613296",
    "14235563620",
    "14235619443",
    "14235374835"
  ],
  "group_ids": [
    12,
    26
  ],
  "excluded_phone_numbers": [
    "14237742421",
    "14232246412"
  ],
  "mms_media": [
    "https://textrequeststorage.com/182739/3fd60fc2-1759-4dee-ac6f-4a97b994b84f.jpeg",
    "https://textrequeststorage.com/182739/c89c8c6a-8883-44cd-b833-f8b4dc8fbba4.png"
  ],
  "schedule_date_utc": "2023-01-12T19:19:11.8032151Z",
  "repeat_settings": {
    "repeat_by": "week",
    "step": 1,
    "times": 5,
    "end_date": "2026-12-31T23:59:59Z",
    "days": [
      "Monday",
      "Wednesday"
    ]
  }
}

Response

The new custom field object.

idstring

This will be a Guid that you can use to make API calls on the group message.

Example response

{
  "id": "95c63493-acc5-41b5-82b6-5f7de97cf9d9"
}

v1

Create a new group message.

Path parameters

Request body

Required fields

Understanding step

Optional stop conditions (pick one or neither)

Repeat mode reference

Not allowed

Example request

Response

Example response