v2

latestOpenAPI 3.1.12026-07-2613060964.2 KB

Edit Object Profile

API to edit (add/remove) properties and communication-channels for an object.

patch/v1/object/{object_type}/{id}/

Path parameters

object_typestring required

Used to group similar objects together. Give plural namespace like teams, organizations, and roles.

idstring required

Unique identifier of the object in your system

Request body

Response

200 - OK

idstring

unique identifier of the object

object_typestring

Used to group similar objects together. Give plural namespace like teams, organizations, and roles.

subscriptions_countinteger

number of users/child objects subscribed to the object

propertiesobject

all user properties in key-value pair. SuprSend reserved properties start with $

created_atstring date-time

Timestamp when the object was created.

updated_atstring date-time

Timestamp when the object was last updated.

Example response

{
  "id": "engineering",
  "object_type": "departments",
  "created_at": "2025-04-04T09:55:12.397856+00:00",
  "updated_at": "2025-04-04T09:55:12.422388+00:00",
  "$<channel>": [
    {
      "status": "active"
    }
  ]
}