Add subscriptions for an object. If a subscription already exists, it will be updated. This endpoint also handles [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients) for the `recipient`.

Add subscriptions

Add subscriptions for an object. If a subscription already exists, it will be updated. This endpoint also handles inline identifications for the recipient.

Endpoint

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

Rate limit

Tier 3

Path parameters

object_id

string

Unique identifier for the object.

collection

string

The collection this object belongs to.

Request body

properties

object(any)

The custom properties associated with the subscription relationship.

recipients

RecipientRequest[]

Required

The recipients of the subscription. You can subscribe up to 100 recipients to an object at a time.

Returns

SubscriptionsResponse

A response containing a list of subscriptions.