POST messaging/messagethread/compose

Request Information

URI Parameters

None.

Body Parameters

ComposeApiDto
NameDescriptionTypeAdditional information
Files

Collection of Base64FileDto

None.

ToEmail

string

Required

Subject

string

Required

Content

string

Required

SecureMessageSelfDestructDays

integer

None.

Verify

TwoStepVerificationInviteDto

None.

Request Formats

application/json, text/json

Sample:
{
  "Files": [
    {
      "Name": "sample string 1",
      "Data": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Data": "sample string 2"
    }
  ],
  "ToEmail": "sample string 1",
  "Subject": "sample string 2",
  "Content": "sample string 3",
  "SecureMessageSelfDestructDays": 1,
  "Verify": {
    "Email": "sample string 1",
    "ConfirmEmail": "sample string 2",
    "InviteeRoleId": "603c05dc-6467-4589-8485-9976706265bf",
    "InviterAccountId": "ba8b8205-8ab4-4a9d-97c8-9c466fac03c7",
    "AddToInvitersAccount": true
  }
}

text/html

Sample:
{"Files":[{"Name":"sample string 1","Data":"sample string 2"},{"Name":"sample string 1","Data":"sample string 2"}],"ToEmail":"sample string 1","Subject":"sample string 2","Content":"sample string 3","SecureMessageSelfDestructDays":1,"Verify":{"Email":"sample string 1","ConfirmEmail":"sample string 2","InviteeRoleId":"603c05dc-6467-4589-8485-9976706265bf","InviterAccountId":"ba8b8205-8ab4-4a9d-97c8-9c466fac03c7","AddToInvitersAccount":true}}

application/xml, text/xml

Sample:
<ComposeApiDto>
  <Files>
    <Name>sample string 1</Name>
    <Data>sample string 2</Data>
  </Files>
  <Files>
    <Name>sample string 1</Name>
    <Data>sample string 2</Data>
  </Files>
  <ToEmail>sample string 1</ToEmail>
  <Subject>sample string 2</Subject>
  <Content>sample string 3</Content>
  <SecureMessageSelfDestructDays>1</SecureMessageSelfDestructDays>
  <Verify>
    <Email>sample string 1</Email>
    <ConfirmEmail>sample string 2</ConfirmEmail>
    <InviteeRoleId>603c05dc-6467-4589-8485-9976706265bf</InviteeRoleId>
    <InviterAccountId>ba8b8205-8ab4-4a9d-97c8-9c466fac03c7</InviterAccountId>
    <AddToInvitersAccount>true</AddToInvitersAccount>
  </Verify>
</ComposeApiDto>

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.