curl --request POST \
--url https://api.noux.app/api/v1/quick-send/trigger \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '
{
"setId": "<string>",
"optionId": "<string>",
"invitees": [
{
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {
authorization: '<authorization>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
setId: '<string>',
optionId: '<string>',
invitees: [{email: 'jsmith@example.com', firstName: '<string>', lastName: '<string>'}]
})
};
fetch('https://api.noux.app/api/v1/quick-send/trigger', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noux.app/api/v1/quick-send/trigger"
payload = {
"setId": "<string>",
"optionId": "<string>",
"invitees": [
{
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>"
}
]
}
headers = {
"authorization": "<authorization>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"triggerId": "<string>",
"scheduledSendAt": "<string>"
}{
"error": true,
"code": "PARSE_ERROR",
"message": "<string>"
}{
"error": true,
"code": "PARSE_ERROR",
"message": "<string>"
}{
"error": true,
"code": "PARSE_ERROR",
"message": "<string>"
}Trigger a quick send
Create a room from a configured quick send option and schedule its invitations. The room is created asynchronously, so the response returns 202 Accepted with a trigger id; poll GET /api/v1/quick-send/trigger/ to get the room id once it exists. The room owner configured on the option becomes the room creator and owner, and is notified by email. Authenticate using Bearer token with your Noux API key.
curl --request POST \
--url https://api.noux.app/api/v1/quick-send/trigger \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '
{
"setId": "<string>",
"optionId": "<string>",
"invitees": [
{
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {
authorization: '<authorization>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
setId: '<string>',
optionId: '<string>',
invitees: [{email: 'jsmith@example.com', firstName: '<string>', lastName: '<string>'}]
})
};
fetch('https://api.noux.app/api/v1/quick-send/trigger', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noux.app/api/v1/quick-send/trigger"
payload = {
"setId": "<string>",
"optionId": "<string>",
"invitees": [
{
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>"
}
]
}
headers = {
"authorization": "<authorization>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"triggerId": "<string>",
"scheduledSendAt": "<string>"
}{
"error": true,
"code": "PARSE_ERROR",
"message": "<string>"
}{
"error": true,
"code": "PARSE_ERROR",
"message": "<string>"
}{
"error": true,
"code": "PARSE_ERROR",
"message": "<string>"
}Authorizations
Noux API key from your integration settings
Headers
Bearer token with Noux API key
Body
Quick send set id from GET /api/v1/quick-send/sets
Quick send option id belonging to the set
People to invite. Each invitee gets a personalized link.
1 - 20 elementsShow child attributes
Show child attributes
Customer name used in the room name and merge tags. Derived from the invitee domain when omitted.
1 - 200Send time chosen by the caller. Wall-clock times resolve in timeZone and can be at most six months ahead.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
IANA timezone used to resolve wall-clock send times, for example "Europe/Helsinki". Defaults to UTC.
100