How to update a participant's notification preferences

How to update a participant's notification preferences

Use this guide when you need to enable or disable specific platform notifications for a participant — such as appointment confirmations, cancellations, and new message alerts.


Prerequisites

  • Your API key

  • The participant's internal id, external_id, or email


Request — disable all appointment notifications

Bash
curl -X POST "https://your-event-domain.com/api/v2/account/set" \
  -H "Authorization: Bearer your_api_key_here" \
  -F "event_id=7" \
  -F "id=12345" \
  -F "receiveAppointmentConfirm=false" \
  -F "receiveAppointmentCancel=false" \
  -F "receiveAppointmentIncoming=false" \
  -F "receiveAppointmentRescheduled=false"

Request — disable message notifications only

Bash
curl -X POST "https://your-event-domain.com/api/v2/account/set" \
  -H "Authorization: Bearer your_api_key_here" \
  -F "event_id=7" \
  -F "id=12345" \
  -F "receiveMessageNotification=false"

Request — re-enable all notifications

Bash
curl -X POST "https://your-event-domain.com/api/v2/account/set" \
  -H "Authorization: Bearer your_api_key_here" \
  -F "event_id=7" \
  -F "id=12345" \
  -F "receiveAppointmentConfirm=true" \
  -F "receiveAppointmentCancel=true" \
  -F "receiveAppointmentIncoming=true" \
  -F "receiveAppointmentRescheduled=true" \
  -F "receiveMessageNotification=true"

Response

JSON
{
  "code": 200,
  "errors": null,
  "data": {
    "id": 12345,
    "email": "john.doe@example.com",
    "status": "updated",
    "external_id": null,
    "info": ["Account match: id"],
    "errors": []
  },
  "response_id": "1700000000.12345"
}

Available notification fields

Parameter

Description

Default on create

receiveAppointmentConfirm

Notified when a meeting request is confirmed

true

receiveAppointmentCancel

Notified when a meeting is cancelled

true

receiveAppointmentIncoming

Notified when a new meeting request is received

true

receiveAppointmentRescheduled

Notified when a meeting is rescheduled

true

receiveMessageNotification

Notified when a new message is received

true


Notes

  • Include only the notification fields you want to change — others will remain at their current setting

  • All fields accept true or false