v1

latestOpenAPI 3.0.02026-08-067074272.5 KB

Group Messages

Retrieves the group message with the specified id.

Gets the group message reception statistics and paginates the individual group message items

get/dashboards/{dashboard_id}/groupmessages/{group_message_id}

Path parameters

dashboard_idinteger required

Example:121

Id of dashboard

group_message_idstring required

Example:95c63493-acc5-41b5-82b6-5f7de97cf9d9

Id of group message

Query parameters

pageinteger

The page number for the group message items. The first item returned will be page multiplied by page_size

page_sizeinteger

The number of items returned for the group message items. The first item returned will be page multiplied by page_size

Property to sort payments by.

sort_direction'desc' | 'asc'

Direction to sort group messages in. Either greatest to smallest, or smallest to greatest.

Response

The custom field name.

idstring

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

status'scheduled' | 'sending' | 'completed' | 'cancelled'

Group Message's current delivery state.

bodystring

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.

date_createdstring date-time

Timestamp of when the review was left.

totalinteger

The number of review requests sent for this platform.

sentinteger

The number of review requests sent for this platform.

successfully_sentinteger

The number of review requests sent for this platform.

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.

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.

occurrence_numberinteger

The number instance this is for a recurring message. If this message is not a recurring message, this parameter will be omitted.

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	—

excluded_by_missing_merge_fieldsinteger

The number of messages excluded from being sent due to a merge field being required that was not available in the contact.

excluded_by_statusinteger

The number of messages excluded from being sent due to contact being opted out, archived, or suppressed.

processedinteger

The number of messages processed and considered valid to send.

erroredinteger

The number of messages that ran into an error while sending.

responses_receivedinteger

The number of messages that received a reply.

opt_outsinteger

The number of messages that received a "STOP" message after sending the group message, causing the contact to opt out of all future messages.

links_clickedinteger

The number of times a message had its shortened link clicked by the end user, if the group message has a link shortened by TextRequest's built-in shortening tool. You can use this in the API by using the tag [shorten:https://www.google.com] in your message body.

completed_date_utcstring date-time

Timestamp of when the last message was completed. This will be null if the message is a recurring message with more messages to send.

Example response

{
  "id": "95c63493-acc5-41b5-82b6-5f7de97cf9d9",
  "status": "sending",
  "body": "Don't forget the Family and Friends sale at our Toledo location on 6-15-2021 at 8:00PM!",
  "date_created": "2022-01-12T19:19:11.8032151Z",
  "total": 40,
  "sent": 31,
  "successfully_sent": 24,
  "schedule_date_utc": "2023-01-12T19:19:11.8032151Z",
  "mms_media": [
    "https://textrequeststorage.com/182739/3fd60fc2-1759-4dee-ac6f-4a97b994b84f.jpeg",
    "https://textrequeststorage.com/182739/c89c8c6a-8883-44cd-b833-f8b4dc8fbba4.png"
  ],
  "occurrence_number": 1,
  "repeat_settings": {
    "repeat_by": "week",
    "step": 1,
    "times": 5,
    "end_date": "2026-12-31T23:59:59Z",
    "days": [
      "Monday",
      "Wednesday"
    ]
  },
  "excluded_by_missing_merge_fields": 2,
  "excluded_by_status": 4,
  "processed": 34,
  "errored": 5,
  "responses_received": 21,
  "opt_outs": 5,
  "links_clicked": 17,
  "completed_date_utc": "2024-01-12T19:19:11.8032151Z",
  "sent_messages": {
    "meta": {
      "total_items": 172
    },
    "items": [
      {
        "phone_number": "13216547890",
        "display_name": "John Smith",
        "is_sent": true,
        "sent_date": "2022-01-12T19:19:11.8032151Z",
        "delivery_status": "error",
        "delivery_error_code": "2005"
      }
    ]
  }
}

v1

Retrieves the group message with the specified id.

Path parameters

Query parameters

Response

Required fields

Understanding step

Optional stop conditions (pick one or neither)

Repeat mode reference

Not allowed

Example response