unsubscribeContactFromCategory( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Unsubscribes a contact from a specific forum category.

By default a contact isn't subscribed to any forum categories.

By unsubscribing a contact from a category, the contact won’t receive notifications for that category.

If contactId is not provided, it is implicitly resolved from the caller's context.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Forums
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
categoryIdstringRequired

Category ID.


optionsUnsubscribeContactFromCategoryOptions

Options for unsubscribing the contact.

Was this helpful?
Yes
No