Topics

Get a contact's topic preferences

Everything this contact has said they want, as the send path reads it.

subscribed on each topic is the EFFECTIVE answer: a contact who has never answered has no row at all, and the topic's default_opt_in decides what that silence means. It is folded in here so no caller has to reimplement the rule.

The top-level subscribed is the global marketing opt-out, and it OUTRANKS every topic. A caller reading only the topic list would conclude somebody is reachable when they are not.

Requires the topics:read scope — View the topics you mail about and who is subscribed to each.

get/api/v1/contacts/{id}/topics

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/contacts/{id}/topics
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: topics:read)

Path parameters

idstring uuid required

Resource id.

Response

The contact's preferences

contact_idstring required
subscribedboolean required

The global marketing opt-out, which OUTRANKS every topic. False means no marketing reaches this contact whatever the topics below say.

Changes

No recorded changes to this operation across all 1 revision of this API.