Check preference
Resolve a single (target, medium) for a recipient: whether a send would actually deliver.
state.enabled is the resolved decision, computed by the same cascade the delivery path uses — the recipient’s exact rule → the recipient’s topic: any rule → the project’s exact rule → the project’s topic: any rule → the medium’s default (in_app delivers, every other medium does not). A topic: none target never takes an any rule.
The target does not need to be in your catalog; any (channel, topic, event) resolves. state.cataloged reports whether a project-level rule exists for this exact (target, medium) — context, not a gate.
state.enabled is resolved — it is what a send to this (target, medium) would actually do, computed by the same cascade the delivery path uses. The target does not need to be cataloged, or stored at all; any (channel, topic, event) resolves.
inherited: falsemeans the recipient has explicitly overridden this(target, medium);truemeans the value came from elsewhere in the cascade.cataloged: falsemeans your project has no rule declared for that exact(target, medium)— context for rendering, not a predictor of delivery.
in_app resolves to enabled: true and email resolves to enabled: false.Authorizations
Bearer authentication header of the form Bearer bv_xxxxxxxxx, where bv_xxxxxxxxx is your API Key with Full access or Recipient acess scope.
Path Parameters
The unique identifier of the recipient.
Query Parameters
Channel to check.
Topic to check.
Event to check.
Which medium to check the subscription state for. Defaults to in_app.
in_app, email Response
Subscription state for the target