Skip to main content
POST
Trigger a quick send

Authorizations

Authorization
string
header
required

Noux API key from your integration settings

Headers

authorization
string
required

Bearer token with Noux API key

Body

application/json
setId
string
required

Quick send set id from GET /api/v1/quick-send/sets

optionId
string
required

Quick send option id belonging to the set

invitees
object[]
required

People to invite. Each invitee gets a personalized link.

Required array length: 1 - 20 elements
customerName
string

Customer name used in the room name and merge tags. Derived from the invitee domain when omitted.

Required string length: 1 - 200
schedule
object

Send time chosen by the caller. Wall-clock times resolve in timeZone and can be at most six months ahead.

timeZone
string

IANA timezone used to resolve wall-clock send times, for example "Europe/Helsinki". Defaults to UTC.

Maximum string length: 100

Response

Quick send accepted and queued

triggerId
string
required

Poll GET /api/v1/quick-send/trigger/{id} for the created room id

scheduledSendAt
string
required

ISO timestamp when the invitations will be sent