Saasco logoSaasco logo
Saasco logoSaasco logo

Introduction

OverviewGetting startedWhat is Saasco?

SDK

Quick startTrackingIdentifyConfigurationWidgetsProperties

MCP

Quick startHow it worksAuthorizationTool reference

REST API

Quick start
Set up CRMLoad an audience
getList TypespostCreate TypeputUpdate TypedelDelete TypegetList PreferencesgetSubscribe Status
CRMNotifications

Subscribe Status

Reports whether a contact is subscribed at the project level: the master switch that overrides every per-type preference. Public and unauthenticated so an unsubscribe page can show current state before the contact acts.

GET
/projects/{projectId}/crm/contact-notification-preferences/subscribe-status

Authorization

Authorization
AuthorizationBearer <token>

In: header

Path Parameters

projectIdrequiredstring

ID of the project that owns the contact.

Query Parameters

contactDistinctIdrequiredstring

Distinct ID of the contact. Pass the encrypted form and set encrypted when calling from an emailed link.

encryptedboolean

Set when contactDistinctId is the encrypted value from an emailed link, so the server decrypts it before the lookup.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.saasco.com/api/v2/projects/string/crm/contact-notification-preferences/subscribe-status?contactDistinctId=string"
{
  "subscribed": true
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

List Preferences

Lists one contact's per-type subscription preferences, for rendering a preference centre. Only types the contact has an explicit preference for are returned. Pair this with List Types to show categories they have never chosen. Public and unauthenticated; use `encrypted` when the contact ID comes from an emailed link. Returns 404 if the contact does not exist.

List Custom Links

Lists the project's custom contact links: the templates, not the resolved URLs for any particular contact.