v30

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

Objects

Preferences

Get object preference set

Returns the preference set for the specified object and preference set id.

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

Path parameters

object_idstring required

Unique identifier for the object.

collectionstring required

The collection this object belongs to.

idstring required

Example:default

Unique identifier for the preference set.

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
}