YOWO7 API
Messaging Inbox

POST

/api/v1/workspaces/{workspaceId}/messaging/inbox/compose

Scope inbox:write

Compose and send a new outbound inbox message.

Pfad

workspaceIdPflicht
string
Workspace that owns the resource.

Request

application/json · MessagingInboxComposeRequestDto

senderIdentityId
string (uuid)
Identifier of the sender identity.
subject
string
Subject.
toEmails
string[]
To emails.
ccEmails
string[]
Cc emails.
bodyText
string
Body text.
bodyHtml
string
HTML for the body.
attachments
MessagingInboxReplyAttachmentRequestDto[]
Attachments.

Antworten

200MessagingInboundMessageDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.

Messaging inbound message.

id
string (uuid)
Identifier.
threadId
string (uuid)
Identifier of the thread.
fromEmail
string
Email address of the from.
fromDisplayName
string
Name of the from display.
toEmails
string[]
To emails.
ccEmails
string[]
Cc emails.
subject
string
Subject.
textBody
string
Text body.
htmlBody
string
Html body.
receivedAt
string (date-time)
When the received was recorded.
isRead
boolean
Whether this is read.
isOutbound
boolean
Whether this is outbound.
outboundSentAt
string (date-time)
When the outbound message was sent.
outboundDeliveredAt
string (date-time)
When the receiving mail server accepted the outbound message.
outboundBouncedAt
string (date-time)
When the outbound message bounced.
outboundFailedAt
string (date-time)
When the outbound message failed to send.
outboundFailureReason
string
Outbound failure reason.
attachments
MessagingInboundAttachmentDto[]
Attachments.
400ApiProblemThe request is invalid.
401ApiProblemThe private app token is missing or invalid.
403ApiProblemThe token is missing the required scope, or this action is not allowed.
404ApiProblemThe workspace or resource was not found.
defaultApiProblemError response.
Compose a message · YOWO7 API