Notification Preferences

Get Current User Notification Preferences

GET /v1/current-user/notification-preferences

Get the current notification preferences for the logged-in user.

Response (200 OK):

{
    "phoneNumber": "+1-555-123-4567",
    "optedOutPhoneNumbers": ["+1-555-999-8888"],
    "toggles": {
        "user_invitation": {
            "email": true,
            "sms": false,
            "in_app_message": true
        },
        "project_updates": {
            "email": true,
            "sms": true,
            "in_app_message": true
        },
        "system_alerts": {
            "email": true,
            "sms": false,
            "in_app_message": true
        },
        "workflow_notifications": {
            "email": false,
            "sms": false,
            "in_app_message": true
        }
    }
}

Update Current User Notification Preferences

PATCH /v1/current-user/notification-preferences

Update the notification preferences of the current user.

Request Body:

{
    "phoneNumber": "+1-555-123-4567",
    "optedOutPhoneNumbers": ["+1-555-999-8888", "+1-555-111-2222"],
    "toggles": {
        "user_invitation": {
            "email": true,
            "sms": true,
            "in_app_message": true
        },
        "project_updates": {
            "email": true,
            "sms": false,
            "in_app_message": true
        },
        "system_alerts": {
            "email": true,
            "sms": false,
            "in_app_message": true
        },
        "workflow_notifications": {
            "email": false,
            "sms": false,
            "in_app_message": true
        }
    }
}

Response (200 OK):

{
    "phoneNumber": "+1-555-123-4567",
    "optedOutPhoneNumbers": ["+1-555-999-8888", "+1-555-111-2222"],
    "toggles": {
        "user_invitation": {
            "email": true,
            "sms": true,
            "in_app_message": true
        },
        "project_updates": {
            "email": true,
            "sms": false,
            "in_app_message": true
        },
        "system_alerts": {
            "email": true,
            "sms": false,
            "in_app_message": true
        },
        "workflow_notifications": {
            "email": false,
            "sms": false,
            "in_app_message": true
        }
    }
}