Creates a new object or updates an existing one in the specified collection. This operation is used to identify objects with their properties, as well as optional preferences and channel data.

Set an object

Creates a new object or updates an existing one in the specified collection. This operation is used to identify objects with their properties, as well as optional preferences and channel data.

Endpoint

PUT/v1/objects/{collection}/{id}

Rate limit

Tier 3

Path parameters

collection

string

The collection this object belongs to.

string

Unique identifier for the object.

Request body

channel_data

InlineChannelDataRequest

A request to set channel data for a type of channel inline.

locale

string

The locale of the object. Used for message localization.

name

string

An optional name for the object.

preferences

InlinePreferenceSetRequest

Inline set preferences for a recipient, where the key is the preference set id. Preferences that are set inline will be merged into any existing preferences rather than replacing them.

timezone

string

The timezone of the object. Must be a valid tz database time zone string. Used for recurring schedules.

object(any)

Any additional custom properties.

Returns

Object

A custom Object entity which belongs to a collection.

__typename

string

The typename of the schema.

collection

string

The collection this object belongs to.

created_at

string(date-time)

Timestamp when the resource was created.

string

Unique identifier for the object.

properties

object(any)

The custom properties associated with the object.

updated_at

string(date-time)

The timestamp when the resource was last updated.