Skip to content
Vespy API

Send a message to a participant

POST
/api/conversations/participants/{participantType}/{participantId}/messages
curl --request POST \
  --url https://api.getvespy.com/api/conversations/participants/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "body": "example", "channel": "in_app", "emailSenderSource": "system", "fromAccountId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "subject": "example", "toAddresses": [ "example" ] }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
participantType
required
string
Allowed values: tenant vendor
participantId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
body
required
string
>= 1 characters <= 5000 characters
channel
string
Allowed values: in_app sms email
emailSenderSource
string
Allowed values: system integration
fromAccountId
string format: uuid
subject
string
nullable >= 1 characters <= 200 characters
toAddresses
Array<string>

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
conversation
required
object
channels
required
Array<string>
Allowed values: in_app sms email
createdAt
required
string format: date-time
id
required
string format: uuid
lastMessageAt
required
string format: date-time
nullable
latestMessagePreview
required
string
nullable
organizationId
required
string format: uuid
participantEmail
required
string format: email
nullable
participantId
required
string format: uuid
participantName
required
string
>= 1 characters <= 160 characters
participantPhone
required
string
nullable
participantType
required
string
Allowed values: tenant vendor
status
required
string
Allowed values: open closed archived
subject
required
string
nullable
unreadCount
required
integer
updatedAt
required
string format: date-time
conversationCreated
required
boolean
message
required
object
body
required
string
>= 1 characters <= 5000 characters
channel
required
string
Allowed values: in_app sms email
conversationId
required
string format: uuid
createdAt
required
string format: date-time
emailMessageId
required
string
nullable
externalId
required
string
nullable
fromAddress
required
string
nullable
id
required
string format: uuid
metadata
required
object
key
additional properties
any
organizationId
required
string format: uuid
senderId
required
string format: uuid
nullable
senderName
required
string
nullable
senderType
required
string
Allowed values: staff tenant vendor system
smsSid
required
string
nullable
toAddresses
required
Array<string>
nullable
Example
{
  "conversation": {
    "channels": [
      "in_app"
    ],
    "participantType": "tenant",
    "status": "open"
  },
  "message": {
    "channel": "in_app",
    "senderType": "staff"
  }
}

400

Section titled “400”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

404

Section titled “404”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

409

Section titled “409”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

502

Section titled “502”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}