Bulk Update Message Status

PATCH

bulk

message

curl --request PATCH \
  --url https://hub.suprsend.com/v1/bulk/message/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "message_id": "01HVXXXXXXXXXXXXXXXXXXXX01",
      "action": "seen"
    },
    {
      "message_id": "01HVXXXXXXXXXXXXXXXXXXXX02",
      "action": "seen"
    }
  ]
}
'

{
  "records": [
    {
      "message_id": "01HVXXXXXXXXXXXXXXXXXXXX01",
      "status_code": 202,
      "error": null
    },
    {
      "message_id": "01HVXXXXXXXXXXXXXXXXXXXX02",
      "status_code": 404,
      "error": {
        "type": "not_found",
        "message": "not found"
      }
    }
  ]
}

Channel applicability for action

seen, clicked - all channels
dismissed - mobile push only (androidpush, iospush)
read, unread, archived, unarchived - inbox only

Authorizations

Authorization

string

header

required

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

Body

application/json

messages

object[]

required

List of messages to update. No duplicate message_ids allowed.

Required array length: 1 - 1000 elements

Show child attributes

Response

202 - application/json

Bulk update accepted. Inspect each record's status_code and error for individual outcomes - a null error means success.

records

object[]

Per-message results, in the same order as the request.

Show child attributes

Create / Update ObjectsAPI to upsert (create if not exists, update if exists) object by providing a unique object ID and type.

⌘I

curl --request PATCH \
  --url https://hub.suprsend.com/v1/bulk/message/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "message_id": "01HVXXXXXXXXXXXXXXXXXXXX01",
      "action": "seen"
    },
    {
      "message_id": "01HVXXXXXXXXXXXXXXXXXXXX02",
      "action": "seen"
    }
  ]
}
'

{
  "records": [
    {
      "message_id": "01HVXXXXXXXXXXXXXXXXXXXX01",
      "status_code": 202,
      "error": null
    },
    {
      "message_id": "01HVXXXXXXXXXXXXXXXXXXXX02",
      "status_code": 404,
      "error": {
        "type": "not_found",
        "message": "not found"
      }
    }
  ]
}

API Reference

USERS

TRIGGER WORKFLOWS

EVENTS

MESSAGES

OBJECTS

TEMPLATES

TENANTS

PREFERENCE

LISTS

BROADCAST

Authorizations

Body

Response