Edit Object Profile

PATCH

object

{object_type}

{id}

cURL

curl -X PATCH "https://hub.suprsend.com/v1/object/{object_type}/{id}/" \
  --header 'Authorization: Bearer __YOUR_API_KEY__' \
  --header 'Content-Type: application/json' \
  --data '{
    "operations": [
      {
        "$set": {
          "name": "Engineering Department",
          "$locale": "en_GB",
          "$timezone": "America/New_York"
        }
      },
      {
        "$append": {
          "$email": ["[email protected]"]
        }
      }
    ]
  }'

{
  "object_type": "departments",
  "id": "engineering",
  "subscriptions_count": 0,
  "properties": {
    "$locale": "en_GB"
  },
  "created_at": "2025-04-06T10:00:37.893892+00:00",
  "updated_at": "2025-04-06T10:00:37.893892+00:00",
  "$inbox": [
    {
      "value": "pO7w6x_HFZxCs30N4SHab05e3QIdB1e0xT2r4vQWjvM",
      "id_provider": "suprsend",
      "status": "active",
      "perma_status": "active"
    }
  ]
}

Authorizations

Authorization

string

header

required

Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.

Path Parameters

object_type

string

required

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

string

required

Unique identifier of the object in your system

Body

application/json

operations

object[]

You can use the following operations to edit user profile.

$set to add/update a property
$unset to delete property/channel
$append to insert values in property/channel array
$remove to remove values from property/channel array
$set_once to remove immutable properties
$increment to increase/decrease integer values on further update

Show child attributes

operations.$set

object

Use this to set user properties like name, location, locale, etc. Example: {"team":"Engineering","$locale":"en_GB","$timezone":"America/New_York"}

Show child attributes

operations.$set.{key}

string

operations.$unset

string[]

Use this to delete channels or properties from user profile. Channels: $email, $sms, $whatsapp, $androidpush, $iospush, $slack, $webpush, $ms_teams Example: ["$sms", "$whatsapp", "name"]

operations.$append

object

Use this to add communication channels or update array properties in user profile. Available channel keys: $email, $sms, $whatsapp, $androidpush, $iospush, $slack, $webpush, $ms_teams Example: {"$email":"[email protected]"}

Show child attributes

operations.$append.{key}

string

operations.$remove

object

Use this to remove communication channels or remove values from an array in user profile. Available channel keys: $email, $sms, $whatsapp, $androidpush, $iospush, $slack, $webpush, $ms_teams Example: {"$email":"[email protected]"}

Show child attributes

operations.$remove.{key}

string

operations.$set_once

object

Use this to set properties which are not set once and not changed on further updates. Example: {"first_login_at":"2025-01-01T14:00:00Z"}

Show child attributes

operations.$set_once.{key}

string

operations.$increment

object

Use this to increase / decrease integer values on further updates Example: {"login_count":1}

Show child attributes

operations.$increment.{key}

string

Response

200 - OK

string

unique identifier of the object

Example:

"engineering"

object_type

string

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

Example:

"departments"

subscriptions_count

integer

number of users/child objects subscribed to the object

Example:

"departments"

properties

object

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

created_at

string<date-time>

Example:

"2025-04-04T09:55:12.397Z"

updated_at

string<date-time>

Example:

"2025-04-04T09:55:12.422Z"

$<channel>

object[]

Show child attributes

$<channel>.value

string

channel value

$<channel>.status

string

Example:

"active"

$<channel>.perma_status

string

active/disabled. Perma_status is marked disabled in case of hard bounce on the channel.

Add SubscriptionAPI to add subscribers (users/child objects) to a given object, to notify subscribers when workflow is triggered on the parent object.

⌘I

cURL

curl -X PATCH "https://hub.suprsend.com/v1/object/{object_type}/{id}/" \
  --header 'Authorization: Bearer __YOUR_API_KEY__' \
  --header 'Content-Type: application/json' \
  --data '{
    "operations": [
      {
        "$set": {
          "name": "Engineering Department",
          "$locale": "en_GB",
          "$timezone": "America/New_York"
        }
      },
      {
        "$append": {
          "$email": ["[email protected]"]
        }
      }
    ]
  }'

{
  "object_type": "departments",
  "id": "engineering",
  "subscriptions_count": 0,
  "properties": {
    "$locale": "en_GB"
  },
  "created_at": "2025-04-06T10:00:37.893892+00:00",
  "updated_at": "2025-04-06T10:00:37.893892+00:00",
  "$inbox": [
    {
      "value": "pO7w6x_HFZxCs30N4SHab05e3QIdB1e0xT2r4vQWjvM",
      "id_provider": "suprsend",
      "status": "active",
      "perma_status": "active"
    }
  ]
}

API Reference

USERS

TRIGGER WORKFLOWS

EVENTS

OBJECTS

TEMPLATES

TENANTS

PREFERENCE

LISTS

BROADCAST

Authorizations

Path Parameters

Body

Response