Skip to main content
POST
Create an email import intake
Required scopes: metrics:write.

Authorizations

x-chatobserver-key
string
header
required

A workspace API key. Data endpoints require a service-account key with the specified scopes.

Headers

Idempotency-Key
string
required

Unique key for one logical command. Reuse it only when retrying the same request and payload.

Required string length: 16 - 160
Pattern: ^[A-Za-z0-9:_-]+$

Body

application/json
name
string
required
Required string length: 1 - 150
allowedSenderDomains
string[]
required
Maximum array length: 100
Required string length: 3 - 253
allowedSenderHashes
string[]
required
Maximum array length: 500
Pattern: ^[a-f0-9]{64}$
attachmentFormats
enum<string>[]
required
Required array length: 1 - 5 elements
Available options:
csv,
parquet,
tsv,
xlsx,
jsonl
maximumAttachmentBytes
integer
required
Required range: x <= 10737418240
status
enum<string>
default:active
Available options:
active,
paused
description
null | string
Maximum string length: 4000
publish
default:true
subjectPrefix
null | string
Required string length: 1 - 160

Response

Successful response.

data
object
required
replayed
required