---
title: "Send  to Segment"
method: POST
path: "/communications/send_sms/segment"
tags: ["SMS"]
---

# Send  to Segment

`POST /communications/send_sms/segment`

Send a message to a Segment via SMS.

## Headers

- `x-api-key` string, required

## Request body

- RequestSMSSegment — Contains the needed attributes to send an SMS to a Segment
  - `send_from_group_phone_number_id` integer, required — group number id, use the GET group_phone_numbers endpoint to get the list
  - `send_to_segment_id` integer, required — segment id
  - `body` string — message body

## Response `200`

send sms to segment response

- SMSResponseMulti — list of conversations and send_sms metadata
  - `send_from` SendFromSMS — send_sms send_from info
    - `send_from_group_phone_number_id` string — phone number id
    - `send_from_group_phone_number` string — phone number
    - `send_from_group_phone_number_name` string — name of customer
  - `send_to` RecipientSMSResponse, required — additional name field to request recipient structure
    - `send_to_client_id` string — client id
    - `send_to_lead_id` string
    - `send_to_dropin_id` string — dropin id
    - `send_to_segment_id` string — segment id
    - `send_to_name` string — name
  - `body` string, required — message body
  - `conversations` SMSConversation[] — conversations
    - `conversation_id` string — twilio conversation sid
    - `message_id` string — twilio message sid
    - `message_status` string — twilio delivery_receipt message status: sent, delivered, failed, undelivered
    - `sent_datetime` string, date-time — Datetime message was sent
    - `error` string — if there was an error

---

[API](https://skmtc.net/wodify/apis/leads.md) · [All operations](https://skmtc.net/wodify/apis/leads/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wodify/leads/revisions/974500ca0714/schema)