v30

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-22116135580.0 KB

Objects

Preferences

List preference sets

Returns a paginated list of preference sets for the specified object.

get/v1/objects/{collection}/{object_id}/preferences

Path parameters

object_idstring required

Unique identifier for the object.

collectionstring required

The collection this object belongs to.

Response

commercial_subscribedboolean nullable

Whether the recipient is subscribed to commercial communications. When false, the recipient will not receive commercial workflow notifications.

idstring required

Unique identifier for the preference set.

Example response

[
  {
    "categories": {
      "marketing": false,
      "transactional": {
        "channel_types": {
          "email": false
        }
      }
    },
    "channel_types": {
      "email": true,
      "push": false,
      "sms": {
        "conditions": [
          {
            "argument": "US",
            "operator": "equal_to",
            "variable": "recipient.country_code"
          }
        ]
      }
    },
    "commercial_subscribed": true,
    "id": "default",
    "workflows": null
  }
]