Skip to main content
POST
Append an email record to a case

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Headers

X-Idempotency-Key
string
required

Stable caller-chosen key (max 200 chars) making the mutation safely retryable.

Maximum string length: 200

Path Parameters

caseId
string
required

Case id

Body

application/json
from
string<email>
required
Required string length: 3 - 320
to
string<email>[]
required
Required array length: 1 - 100 elements
Required string length: 3 - 320
subject
string
required
Required string length: 1 - 998
sentAt
string
required
cc
string<email>[]
Maximum array length: 100
Required string length: 3 - 320
bodyText
string
Maximum string length: 1000000
bodyHtml
string
Maximum string length: 2000000
attachments
string[]
Maximum array length: 50
Required string length: 1 - 200

Response

{ success: true, email }

success
boolean
required
{key}
any