Documentation | Objects › Get A Preference Set

Objects

objects

Methods

Add Subscriptions -> Array<

Subscription

post/v1/objects/{collection}/{object_id}/subscriptions

Add subscriptions for an object. If a subscription already exists, it will be updated.

Delete An Object -> string

delete/v1/objects/{collection}/{object_id}

Delete an object

Delete Subscriptions -> Array<

Subscription

delete/v1/objects/{collection}/{object_id}/subscriptions

Delete subscriptions

Get An Object ->

Object

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

Get an object

Parameters

collection: string

object_id: string

Response fields

Object

Request example

curl https://api.knock.app/v1/objects/$COLLECTION/$OBJECT_ID \
    -H "Authorization: Bearer $KNOCK_API_KEY"

200Example

{
  "id": "project_1",
  "__typename": "Object",
  "collection": "projects",
  "updated_at": "2024-05-22T12:00:00Z",
  "created_at": null
}

Get Channel Data ->

ChannelData

get/v1/objects/{collection}/{object_id}/channel_data/{channel_id}

Get channel data

Get A Preference Set ->

PreferenceSet

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

Get a preference set

Parameters

collection: string

object_id: string

preference_set_id: string

tenant: string

Optional

Tenant ID

Response fields

PreferenceSet

Request example

curl https://api.knock.app/v1/objects/$COLLECTION/$OBJECT_ID/preferences/$PREFERENCE_SET_ID \
    -H "Authorization: Bearer $KNOCK_API_KEY"

200Example

{
  "id": "default",
  "__typename": "PreferenceSet",
  "categories": {
    "marketing": false,
    "transactional": {
      "channel_types": {
        "chat": true,
        "email": false,
        "http": true,
        "in_app_feed": true,
        "push": true,
        "sms": true
      },
      "conditions": [
        {
          "argument": "some_property",
          "operator": "equal_to",
          "variable": "recipient.property"
        }
      ]
    }
  },
  "channel_types": {
    "chat": true,
    "email": true,
    "http": true,
    "in_app_feed": true,
    "push": false,
    "sms": {
      "conditions": [
        {
          "argument": "US",
          "operator": "equal_to",
          "variable": "recipient.country_code"
        }
      ]
    }
  },
  "workflows": {
    "foo": {
      "channel_types": {
        "chat": true,
        "email": false,
        "http": true,
        "in_app_feed": true,
        "push": true,
        "sms": true
      },
      "conditions": [
        {
          "argument": "some_property",
          "operator": "equal_to",
          "variable": "recipient.property"
        }
      ]
    }
  }
}

List Objects In A Collection -> EntriesCursor<

Object

get/v1/objects/{collection}

List objects in a collection

List Messages -> EntriesCursor<

Message

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

List messages

List Schedules -> EntriesCursor<

Schedule

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

List schedules

List Subscriptions -> EntriesCursor<

Subscription

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

List subscriptions for an object. Either list all subscriptions that belong to the object, or all subscriptions that this object has. Determined by the mode query parameter.

Set Identify An Object ->

Object

put/v1/objects/{collection}/{object_id}

Set (identify) an object

Set Channel Data ->

ChannelData

put/v1/objects/{collection}/{object_id}/channel_data/{channel_id}

Set channel data

Update A Preference Set ->

PreferenceSet

put/v1/objects/{collection}/{object_id}/preferences/{preference_set_id}

Update a preference set