POST
/
v1
/
messages

Authorizations

Authorization
string
headerrequired

Body

application/json
content
string
required

The text content of the message to be sent.

phoneNumberId
string
deprecated

DEPRECATED, use "from" instead. OpenPhone phone number ID to send a message from

from
required

The sender's phone number. Can be either your OpenPhone phone number ID or the full phone number in E.164 format.

to
string[]
required

Array of recipient phone numbers in E.164 format. Currently only supports one recipient.

userId
string

The unique identifier of the OpenPhone user sending the message. If not provided, defaults to the phone number owner.

setInboxStatus
enum<string>

Used to set the status of the related OpenPhone inbox conversation. The default behavior without setting this parameter will be for the message sent to show up as an open conversation in the user's inbox. Setting the parameter to 'done' would move the conversation to the Done inbox view.

Available options:
done

Response

202 - application/json
data
object
required