---
title: "Compose Inbox Sms"
method: POST
path: "/inbox/sms/compose"
tags: ["AI Inbox"]
---

# Compose Inbox Sms

`POST /inbox/sms/compose`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/inbox/sms/compose`
- Auth: HTTP bearer

COMPOSE AN SMS. WITH `save_as_draft` FALSE THIS REACHES A REAL PHONE.

Sends through the organisation's own number and files the message into the
SMS thread, so the conversation stays in one place. `save_as_draft`
defaults to FALSE, which means send.

Classified `external` (`inbox:run`). `from_number` must be a number this
organisation owns - checked before anything is saved or sent, a 400
otherwise (see the module docstring for why the check lives here).

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- SmsComposeRequest: Compose an SMS: save it as a draft, or SEND IT TO A REAL PHONE. `save_as_draft` defaults to FALSE, which means SEND.
  - `from_number` string, required: A number this organisation owns, E.164.
  - `to_number` string, required: The recipient's number, E.164. A real phone.
  - `body` string, required: Message text.
  - `save_as_draft` boolean: FALSE SENDS THE MESSAGE. True stores a draft.
  - `draft_id` string, nullable
  - `thread_id` string, nullable: Existing SMS thread to continue.

## Response `200`

Successful Response

- ApiResponseInboxPayload
  - `data` InboxPayload, required: An open envelope for a comment, an assignment or a workspace. Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)