Skip to main content
POST
Create Email Message

Authorizations

Authorization
string
header
required

Consumer JWT minted by the tenant's backend

X-Rollout-Credential-Id
string
header
required

The Rollout Credential ID to use for queries/mutations

Query Parameters

fields
string

Comma-separated top-level fields to return; the parameter can also be repeated, once per field. id is always returned. Omit it, or pass allFields, to get every field, including original. Unknown names return 400.

Body

subject
string
required
body
string
required
sender
object
required
recipients
object[]
required
personId
string
userId
string
threadId
string

Response

The created email message.

The created email message.

id
string
required
personId
string | null

Present unless the request's fields leaves it out.

userId
string | null

Present unless the request's fields leaves it out.

threadId
string | null

Present unless the request's fields leaves it out.

subject
string

Present unless the request's fields leaves it out.

body
string

Present unless the request's fields leaves it out.

sender
object

Present unless the request's fields leaves it out.

recipients
object[]

Present unless the request's fields leaves it out.

isRead
boolean | null

Present unless the request's fields leaves it out.

isStarred
boolean | null

Present unless the request's fields leaves it out.

isIncoming
boolean | null

Present unless the request's fields leaves it out.

sent
string | null

Present unless the request's fields leaves it out.

received
string | null

Present unless the request's fields leaves it out.

created
string | null

Present unless the request's fields leaves it out.

updated
string | null

Present unless the request's fields leaves it out.

rolloutUpdated
string

Present unless the request's fields leaves it out.

originalIds
object

Present unless the request's fields leaves it out.

original
object

Present unless the request's fields leaves it out.