POST
/
v1
/
object
/
{object_type}
/
{id}
curl --request POST \
  --url https://hub.suprsend.com/v1/object/{object_type}/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "$email": [
    "jsmith@example.com"
  ],
  "$timezone": "America/New_York",
  "$preferred_language": "en"
}'
{
  "object_type": "departments",
  "id": "engineering",
  "subscriptions_count": 0,
  "properties": {
    "$preferred_language": "en"
  },
  "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

​
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[]

List of email addresses. You can add other channels in the same format by replacing $email with respective channel keys. Available channel keys - $email, $sms, $inbox, $webpush, $androidpush, $iospush, $slack, $ms_teams.

​
$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"

​
{key}
string

add any additional property in key-value pair

Example:

"val"

Response

201 - application/json
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
Example:

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

​
updated_at
string
Example:

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

​
$<channel>
object[]

Was this page helpful?