Guides
API reference
MCP server
Changelogcurl --request PATCH \
--url https://api-prod.heliyos.ai/v1/platform/notification-settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"eventTypes": [
{
"type": "deal.approval",
"frequency": "immediate"
},
{
"type": "task.created",
"frequency": "daily"
},
{
"type": "organization.daily_summary",
"frequency": "daily"
}
]
}
'{
"meta": {
"message": "Notification settings saved successfully."
},
"data": {
"id": "6721a9e0c4b5d6e7f8a9b0c1",
"organizationId": "66a0f1e2d3c4b5a697887766",
"notifyEmails": [
"ana.lopez@example.com",
"revops@example.com"
],
"eventTypes": [
{
"type": "deal.approval",
"frequency": "immediate"
},
{
"type": "task.created",
"frequency": "daily"
},
{
"type": "organization.daily_summary",
"frequency": "daily"
}
],
"isActive": true,
"metadata": {
"created": {
"at": "2026-10-02T08:15:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
},
"updated": {
"at": "2026-11-05T11:02:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
}
}
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}Notification settings
Update notification settings
Changes the workspace’s notification settings, creating them the first time. Send at least one field. Each field you send replaces that setting completely; fields you leave out are kept.
eventTypesis the full list of notifying events. To add one event, read the current list, add to it and send the whole list back.notifyEmailsis the full recipient list. Changing who receives notifications needs an owner or admin (an API key counts as an admin). Sending the stored list back unchanged is allowed for anyone who can edit the settings. A list can grow to at most 10 addresses.- The first save of a workspace that had no settings starts from notifications on, no recipients and no events, then applies what you sent.
PATCH
/
v1
/
platform
/
notification-settings
curl --request PATCH \
--url https://api-prod.heliyos.ai/v1/platform/notification-settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"eventTypes": [
{
"type": "deal.approval",
"frequency": "immediate"
},
{
"type": "task.created",
"frequency": "daily"
},
{
"type": "organization.daily_summary",
"frequency": "daily"
}
]
}
'{
"meta": {
"message": "Notification settings saved successfully."
},
"data": {
"id": "6721a9e0c4b5d6e7f8a9b0c1",
"organizationId": "66a0f1e2d3c4b5a697887766",
"notifyEmails": [
"ana.lopez@example.com",
"revops@example.com"
],
"eventTypes": [
{
"type": "deal.approval",
"frequency": "immediate"
},
{
"type": "task.created",
"frequency": "daily"
},
{
"type": "organization.daily_summary",
"frequency": "daily"
}
],
"isActive": true,
"metadata": {
"created": {
"at": "2026-10-02T08:15:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
},
"updated": {
"at": "2026-11-05T11:02:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
}
}
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}Notification emails can contain record names and summaries. Only add addresses that should see
that information.
In the Heliyos MCP server:
heliyos_notification_settings_update.Authorizations
A workspace API key, sent as Authorization: Bearer heliyos_.... Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.
Body
application/json
The complete new recipient list. Replaces the current one. Each item must be a valid email address (surrounding spaces are trimmed). At most 10 addresses when you add any. Send [] to remove every recipient, which stops notifications.
Example:
[
"ana.lopez@example.com",
"revops@example.com"
]
The complete new list of notifying events, each { type, frequency }. Replaces the current list. Send [] to turn off every event.
Show child attributes
Show child attributes
Turns every notification email on (true) or off (false).
Example:
true
Was this page helpful?