Skip to main content
POST
/
v1
/
object
/
{object_type}
/
{id}
/
Create / Update Objects
curl --request POST \
  --url https://hub.suprsend.com/v1/object/{object_type}/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "department": "Engineering",
  "$email": [
    "devs@example.com"
  ],
  "$slack": [
    {
      "channel": "CXXXXXXXX",
      "access_token": "xoxb-XXXXXX"
    }
  ]
}'
{
  "object_type": "departments",
  "id": "engineering",
  "subscriptions_count": 0,
  "properties": {
    "$preferred_language": "en",
    "department": "Engineering"
  },
  "created_at": "2025-04-06T10:00:37.893892+00:00",
  "updated_at": "2025-04-06T10:00:37.893892+00:00",
  "$email": [
    {
      "value": "devs@example.com",
      "status": "active",
      "perma_status": "active"
    }
  ],
  "$slack": [
    {
      "value": {
        "email_id": "user@example.com",
        "access_token": "xoxb-..."
      },
      "status": "active",
      "perma_status": "active"
    }
  ],
  "$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

id
string
required

Unique identifier of the object in your system

object_type
string
required

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

Body

application/json
$email
string<email>[]

List of email addresses.

$sms
string[]

List of phone numbers for SMS

$whatsapp
string[]

List of phone numbers for WhatsApp

$inbox
string[]

List of inbox identifiers

$androidpush
string[]

List of Android Push tokens

$iospush
string[]

List of iOS Push tokens

$slack
(Slack using email · object | Slack using member ID · object | Slack using channel · object | Slack using incoming webhook · object)[]

Slack channel configuration

  • Slack using email
  • Slack using member ID
  • Slack using channel
  • Slack using incoming webhook
$ms_teams
(MS Teams using conversation ID · object | MS Teams using user ID · object | MS Teams using incoming webhook · object)[]

Microsoft Teams channel configuration

  • MS Teams using conversation ID
  • MS Teams using user ID
  • MS Teams using incoming webhook
$timezone
string

User's timezone in IANA format

Example:

"America/New_York"

$preferred_language
string

Preferred language in ISO 639-1 Alpha-2 format

Example:

"en"

Response

201 - Created

id
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[]
I