---
title: "Send a message"
method: POST
path: "/endpoints/messages"
tags: ["Messages"]
---

# Send a message

`POST /endpoints/messages`

## Request

- Base URL: `https://app.hullo.me/api`
- URL: `https://app.hullo.me/api/endpoints/messages`
- Auth: API key in header `X-API-KEY`

Allows messages to be sent to members. Members must be fully opted-in in order to be sent a message, otherwise
this operation will reject the call. If a message is longer than 160 characters - using the GSM character set
(https://en.wikipedia.org/wiki/GSM_03.38) - then the message will be split into multiple 140 character parts.

If any characters fall outside of the supported GSM character set then the message will be converted to UTF-16
(https://en.wikipedia.org/wiki/UTF-16) and split into multiple 70 character parts. The parts will be
reconstructed and displayed to the member as a single message on their handset.

## Request body

- Message: A record containing information about a message
  - `id` string: The unique ID for the message once submitted
  - `issueDate` string, date-time: The date the message was will be / was issued. When sending a message this date should be at least 2 minutes in the future
  - `phoneNumber` string, phone-number, required: The phone number the message was sent to / received from
  - `messageText` string, required: The message text to send / was sent to the member
  - `fullName` string: The full name of the member the message was sent to (read only)
  - `inbound` boolean: If the message was received from a members phone then this will be marked as true (read only)
  - `deliveryStatus` 'FAILED' | 'ACCEPTED' | 'DELIVERED' | 'ISSUED' | 'REJECTED' | 'UNKNOWN' | 'PENDING' | 'STAGING' | 'N/A': The status of the message (read only).

## Response `200`

OK

- Message: A record containing information about a message
  - `id` string: The unique ID for the message once submitted
  - `issueDate` string, date-time: The date the message was will be / was issued. When sending a message this date should be at least 2 minutes in the future
  - `phoneNumber` string, phone-number, required: The phone number the message was sent to / received from
  - `messageText` string, required: The message text to send / was sent to the member
  - `fullName` string: The full name of the member the message was sent to (read only)
  - `inbound` boolean: If the message was received from a members phone then this will be marked as true (read only)
  - `deliveryStatus` 'FAILED' | 'ACCEPTED' | 'DELIVERED' | 'ISSUED' | 'REJECTED' | 'UNKNOWN' | 'PENDING' | 'STAGING' | 'N/A': The status of the message (read only).

## Other responses

- `400`: BAD_REQUEST
- `401`: UNAUTHORIZED
- `404`: NOT_FOUND

---

[API](https://skmtc.dev/hullo/apis/always-on-mobile-hullo-api.md) · [All operations](https://skmtc.dev/hullo/apis/always-on-mobile-hullo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hullo/apis/always-on-mobile-hullo-api/revisions/62982404791d?raw)