Documentation

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

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

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

Unset Channel Data -> string
delete/v1/objects/{collection}/{object_id}/channel_data/{channel_id}

Unset channel data

Parameters
collection: string
object_id: string
channel_id: string
(format: uuid)
Request example
200Example

Domain types

InlineObjectRequest = { id, collection, channel_data, 2 more... }

Inline identifies a custom object belonging to a collection

Object = { id, __typename, collection, 2 more... }

A custom-object entity which belongs to a collection.

Objects

Bulk

objects.bulk

Methods

Bulk Add Subscriptions ->
BulkOperation
post/v1/objects/{collection}/bulk/subscriptions/add

Add subscriptions for a set of objects in a single collection. If a subscription already exists, it will be updated.

Bulk Delete Objects ->
BulkOperation
post/v1/objects/{collection}/bulk/delete

Bulk delete objects

Bulk Set Objects ->
BulkOperation
post/v1/objects/{collection}/bulk/set

Bulk set objects