AI Inbox

Compose Inbox Sms

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).

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

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

from_numberstring required

A number this organisation owns, E.164.

to_numberstring required

The recipient's number, E.164. A real phone.

bodystring required

Message text.

save_as_draftboolean

FALSE SENDS THE MESSAGE. True stores a draft.

draft_idstring nullable
thread_idstring nullable

Existing SMS thread to continue.

Response

Successful Response

dataInboxPayload 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.