Skip to main content
POST
Notify Conversation Alert

Authorizations

Authorization
string
header
required

API key from Settings > Developer > REST API

Headers

Moda-Version
enum<string>
default:2026-05-01

Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.

Available options:
2026-04-12,
2026-05-01
Example:

"2026-05-01"

Body

application/json
kind
enum<string>
required
Available options:
needs_you,
ready,
failed
Example:

"needs_you"

conversation_url
string
required
Required string length: 1 - 2048
idempotency_key
string
required
Required string length: 1 - 128
Pattern: ^[\x20-\x7e]+$
channel
string
required
Allowed value: "email"
title
string | null
Maximum string length: 200

Response

Successful Response

sent
boolean
default:true
channel
string
default:email
Allowed value: "email"