/textMessages

post

https://api.followupboss.com/v1/textMessages

Create a record of an externally sent text message.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

❗️
Restricted - Registered Systems Only
External systems requesting to hit this endpoint must be registered with Follow Up Boss. To learn more, see the section on Identification.

Text messages created through the API are recorded as logs only. No actual text messages are sent.

Body Params

personId

int32

required

The id of the person associated with the text message.

message

string

required

The body of the text message.

toNumber

string

required

The phone number the text message was sent to (e.g., 888-555-1234).

fromNumber

string

required

The phone number the text messages was sent from (e.g., 888-555-9876).

isIncoming

boolean

Defaults to false

Set whether the text was outgoing to a person or incoming from a person.

externalLabel

string

An optional descriptive text that appears in the byline of the text message record on the person's timeline.

externalUrl

string

An optional link that will appear in the byline of the text message record in the timeline.

Headers

X-System

string

required

The name of the registered system sending the API request.

X-System-Key

string

required

The secret key of the registered system sending the API request.

Responses

❗️Restricted - Registered Systems Only

200200

400400

❗️
Restricted - Registered Systems Only