Skip to content

Notifications ​

Reference for the 4 CryptoComply MCP tools in the Notifications family.

Tools in this group ​

notification_default_list ​

Read-only: yes.

The organization's notification defaults: for each event, whether members get it in the app and by email until they choose for themselves, and whether it is mandatory (nobody can turn it off). customized means the organization changed the platform's default. Change one with notification_default_update.

Parameters

  • organization_id (OrganizationId, required) — (no description)
  • limit (Limit, optional) — (no description)
  • offset (Offset, optional) — (no description)

notification_default_update ​

Read-only: no.

Change the organization's default for one notification: in the app, by email, and whether it is mandatory. It reaches members who never chose for themselves; apply_to_all_members also replaces every member's own choice. Previews first.

Parameters

  • organization_id (OrganizationId, required) — (no description)
  • event_type (Annotated[NotificationEventLiteral, Field(description=NOTIFICATION_EVENT)], required) — (no description)
  • in_app (Annotated[bool | None, Field(description="In the app's inbox by default; omit to keep it.")], optional) — (no description)
  • email (Annotated[bool | None, Field(description='By email by default; omit to keep it.')], optional) — (no description)
  • mandatory (Annotated[bool | None, Field(description="Whether members can't turn it off; omit to keep it.")], optional) — (no description)
  • apply_to_all_members (Annotated[bool, Field(description='Also bring every member who chose for themselves back to this default.')], optional) — (no description)
  • confirm_token (ConfirmToken, optional) — (no description)

notification_preference_list ​

Read-only: yes.

Your own notification settings in this organization: for each event, whether you get it in the app and by email. A mandatory event is required by your organization and can't be turned off. Change one with notification_preference_update.

Parameters

  • organization_id (OrganizationId, required) — (no description)
  • limit (Limit, optional) — (no description)
  • offset (Offset, optional) — (no description)

notification_preference_update ​

Read-only: no.

Turn one of your own notifications on or off in the app, by email, or both. It changes only what you receive. A mandatory event is refused. Returns the event as you now receive it.

Parameters

  • organization_id (OrganizationId, required) — (no description)
  • event_type (Annotated[NotificationEventLiteral, Field(description=NOTIFICATION_EVENT)], required) — (no description)
  • in_app (Annotated[bool | None, Field(description="In the app's inbox; omit to keep it.")], optional) — (no description)
  • email (Annotated[bool | None, Field(description='By email; omit to keep it.')], optional) — (no description)