Skip to main content
POST
Send a message to a partner

Authorizations

Authorization
string
header
required

Default authentication mechanism

Body

application/json
text
string
required

The text of the message.

Required string length: 1 - 2000
partnerId
string | null

The ID of the partner to message. Takes precedence over tenantId if both are provided.

tenantId
string | null

The ID of the partner in your system. If both partnerId and tenantId are not provided, an error will be thrown.

Response

The sent message.

id
string
required
text
string
required
readInApp
string | null
required
readInEmail
string | null
required
createdAt
string
required
updatedAt
string
required
attachments
object[]
required
sourceType
enum<string>
required

Whether your program or the partner sent the message.

Available options:
program,
partner
partner
object
required

The partner in the conversation. email is null for partners from the network who haven't joined your program.